aboutsummaryrefslogtreecommitdiff
path: root/middleware/health/README.md
blob: aee23ceae814bd1dec4baf0db8985be93e570b4e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# health

This module enables a simple health check endpoint.
By default it will listen on port 8080.

## Syntax

~~~
health [ADDRESS]
~~~

Optionally takes an address; the default is `:8080`. The health path is fixed to `/health`. It
will just return "OK" when CoreDNS is healthy, which currently mean: it is up and running.

This middleware only needs to be enabled once.

## Examples

~~~
health localhost:8091
~~~