coredns/middleware/health/README.md
Miek Gieben faf83b00dd docs: rewrite using manpage style (#327)
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.
2016-10-10 20:13:22 +01:00

418 B

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