diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index 662ddacd9c..986bcdedac 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -175,6 +175,7 @@ expect an integer, and they can only be specified once. -l, --log-level="info" Set the logging level --label=[] Set key=value labels to the daemon --log-driver="json-file" Default driver for container logs + --log-opt=[] Log driver specific options --mtu=0 Set the containers network MTU -p, --pidfile="/var/run/docker.pid" Path to use for daemon PID file --registry-mirror=[] Preferred Docker registry mirror @@ -998,6 +999,7 @@ Creates a new container. --label-file=[] Read in a line delimited file of labels --link=[] Add link to another container --log-driver="" Logging driver for container + --log-opt=[] Log driver specific options --lxc-conf=[] Add custom lxc options -m, --memory="" Memory limit --mac-address="" Container MAC address (e.g. 92:d0:c6:0a:29:33) @@ -1963,6 +1965,7 @@ To remove an image using its digest: --ipc="" IPC namespace to use --link=[] Add link to another container --log-driver="" Logging driver for container + --log-opt=[] Log driver specific options --lxc-conf=[] Add custom lxc options -m, --memory="" Memory limit -l, --label=[] Set metadata on the container (e.g., --label=com.example.key=value) diff --git a/docs/sources/reference/run.md b/docs/sources/reference/run.md index 7c5113f6de..f1c4a44d7c 100644 --- a/docs/sources/reference/run.md +++ b/docs/sources/reference/run.md @@ -873,18 +873,31 @@ this driver. Default logging driver for Docker. Writes JSON messages to file. `docker logs` command is available only for this logging driver +The following logging options are supported for this logging driver: [none] + #### Logging driver: syslog Syslog logging driver for Docker. Writes log messages to syslog. `docker logs` command is not available for this logging driver +The following logging options are supported for this logging driver: + + --log-opt address=[tcp|udp]://host:port + --log-opt address=unix://path + +`address` specifies the remote syslog server address where the driver connects to. +If not specified it defaults to the local unix socket of the running system. +If transport is either `tcp` or `udp` and `port` is not specified it defaults to `514` +The following example shows how to have the `syslog` driver connect to a `syslog` +remote server at `192.168.0.42` on port `123` + + $ docker run --log-driver=syslog --log-opt address=tcp://192.168.0.42:123 + #### Logging driver: journald Journald logging driver for Docker. Writes log messages to journald; the container id will be stored in the journal's `CONTAINER_ID` field. `docker logs` command is not available for this logging driver. For detailed information on working with this logging driver, see [the journald logging driver](reference/logging/journald) reference documentation. -#### Log Opts : - -Logging options for configuring a log driver. The following log options are supported: [none] +The following logging options are supported for this logging driver: [none] ## Overriding Dockerfile image defaults