Merge pull request #541 from stevvooe/fix-debug-endpoint-description

Revise description of debug endpoint
pull/521/head
Olivier Gambier 2015-05-20 15:29:34 -07:00
commit b41f93ae95
1 changed files with 5 additions and 4 deletions

View File

@ -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.