diff --git a/config-example.yaml b/config-example.yaml index 887e2ea9..d109f64b 100644 --- a/config-example.yaml +++ b/config-example.yaml @@ -20,6 +20,7 @@ listen_addr: 127.0.0.1:8080 # Address to listen to /metrics and /debug, you may want # to keep this endpoint private to your internal network +# Use an emty value to disable the metrics listener. metrics_listen_addr: 127.0.0.1:9090 # Address to listen for gRPC. diff --git a/docs/ref/debug.md b/docs/ref/debug.md index 2c6ef5b2..f2899d69 100644 --- a/docs/ref/debug.md +++ b/docs/ref/debug.md @@ -64,6 +64,9 @@ Headscale provides a metrics and debug endpoint. It allows to introspect differe Keep the metrics and debug endpoint private to your internal network and don't expose it to the Internet. + The metrics and debug interface can be disabled completely by setting `metrics_listen_addr: null` in the + [configuration file](./configuration.md). + Query metrics via and get an overview of available debug information via . Metrics may be queried from outside localhost but the debug interface is subject to additional protection despite listening on all interfaces.