From dfa850440811ef95656b154240543bf5b961b670 Mon Sep 17 00:00:00 2001 From: Stephen J Day Date: Wed, 20 May 2015 15:24:25 -0700 Subject: [PATCH] Revise description of debug endpoint Signed-off-by: Stephen J Day --- docs/configuration.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index bdb6f8df..85f7948e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -943,10 +943,11 @@ and proxy connections to the registry server. ### debug -The `debug` option is **optional** . Use it to configure a debug server that can -be helpful in diagnosing problems. Contributors to the distribution repository -should find the debug server useful. Docker recommends disabling it in -production environments. +The `debug` option is **optional** . Use it to configure a debug server that +can be helpful in diagnosing problems. The debug endpoint can be used for +monitoring registry metrics and health, as well as profiling. Sensitive +information may be available via the debug endpoint. Please be certain that +access to the debug endpoint is locked down in a production environment. The `debug` section takes a single, required `addr` parameter. This parameter specifies the `HOST:PORT` on which the debug server should accept connections.