faf83b00dd
This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style.
21 lines
418 B
Markdown
21 lines
418 B
Markdown
# 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
|
|
~~~
|