Revise description of debug endpoint

Signed-off-by: Stephen J Day <stephen.day@docker.com>
This commit is contained in:
Stephen J Day 2015-05-20 15:24:25 -07:00
parent 36d4e365aa
commit dfa8504408

View file

@ -943,10 +943,11 @@ and proxy connections to the registry server.
### debug ### debug
The `debug` option is **optional** . Use it to configure a debug server that can The `debug` option is **optional** . Use it to configure a debug server that
be helpful in diagnosing problems. Contributors to the distribution repository can be helpful in diagnosing problems. The debug endpoint can be used for
should find the debug server useful. Docker recommends disabling it in monitoring registry metrics and health, as well as profiling. Sensitive
production environments. 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 The `debug` section takes a single, required `addr` parameter. This parameter
specifies the `HOST:PORT` on which the debug server should accept connections. specifies the `HOST:PORT` on which the debug server should accept connections.