docker/cli
1
0
Fork 0
mirror of https://github.com/docker/cli.git synced 2026-01-13 18:22:35 +03:00
Code Activity

env-file: update functionality and docs

Browse Source 
Multiple flags allowed. Order prescribed. Examples provided. Multiline
accounted for.

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
This commit is contained in:
Vincent Batts
2014-03-06 17:49:47 -05:00
committed by Tibor Vass
parent 46d697f30b
commit 552c1d2899
1 changed files with 41 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/sources/reference/commandline/cli.rst
View File

@@ -1289,12 +1289,47 @@ explains in detail how to manipulate ports in Docker.
$ sudo docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash
This sets environmental variables to the container. For illustration all three
flags are shown here. Where -e and --env can be repeated, take an environment
variable and value, or if no "=" is provided, then that variable's current
value is passed through (i.e. $MYVAR1 from the host is set to $MYVAR1 in the
container). The --env-file flag takes a filename as an argument and expects each
line to be a VAR=VAL format.
This sets environmental variables in the container. For illustration all three
flags are shown here. Where ``-e``, ``--env`` take an environment variable and
value, or if no "=" is provided, then that variable's current value is passed
through (i.e. $MYVAR1 from the host is set to $MYVAR1 in the container). All
three flags, ``-e``, ``--env`` and ``--env-file`` can be repeated.
Regardless of the order of these three flags, the ``--env-file`` are processed
first, and then ``-e``/``--env`` flags. So that they can override VAR as needed.
.. code-block:: bash
$ cat ./env.list
TEST_FOO=BAR
$ sudo docker run --env TEST_FOO="This is a test" --env-file ./env.list busybox env | grep TEST_FOO
TEST_FOO=This is a test
The ``--env-file`` flag takes a filename as an argument and expects each line
to be in the VAR=VAL format. The VAL is Unquoted, so if you need a multi-line
value, then use `\n` escape characters inside of a double quoted VAL. Single
quotes are literal. An example of a file passed with ``--env-file``
.. code-block:: bash
$ cat ./env.list
TEST_FOO=BAR
TEST_APP_DEST_HOST=10.10.0.127
TEST_APP_DEST_PORT=8888
TEST_SOME_MULTILINE_VAR="this is first line\nthis is second line"
TEST_SOME_LITERAL_VAR='this\nwill\nall\nbe\none\nline'
$ sudo docker run --env-file ./env.list busybox env
HOME=/
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
HOSTNAME=215d54a814bc
TEST_FOO=BAR
TEST_APP_DEST_HOST=10.10.0.127
TEST_APP_DEST_PORT=8888
TEST_SOME_MULTILINE_VAR=this is first line
this is second line
TEST_SOME_LITERAL_VAR='this\nwill\nall\nbe\none\nline'
container=lxc
.. code-block:: bash