From cdc8f0c4bc2ea76a19c9c7d3e78047b08ab33dbc Mon Sep 17 00:00:00 2001 From: Romain Primet Date: Mon, 9 Apr 2018 21:18:36 +0200 Subject: [PATCH] document --e, --env command line flag --- docs/source/faq.md | 6 ++++++ docs/source/usage.rst | 8 ++++++++ 2 files changed, 14 insertions(+) diff --git a/docs/source/faq.md b/docs/source/faq.md index f2ad67e9..6f5cdb56 100644 --- a/docs/source/faq.md +++ b/docs/source/faq.md @@ -24,3 +24,9 @@ or similar traditional docker command. Check out the [binder-examples](http://github.com/binder-examples/) github organization for example Dockerfiles you can copy & modify for your own use! + +## How do I set environment variables? + +Use the `-e` or `--env` flag for each variable that you want to define. + +For example `jupyter-repo2docker -e VAR1=val1 -e VAR2=val2 ...` diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 7ca3f7d2..a03d65b2 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -131,6 +131,14 @@ be used by docker directly. jupyter-repo2docker --no-build --debug https://github.com/jakevdp/PythonDataScienceHandbook +Setting environment variables +----------------------------- + +If you want to define environment variables, you can pass the ``--env`` or ``-e`` parameter to the commandline: + + .. code-block:: bash + + jupyter-repo2docker -e VAR1=val1 -e VAR2=val2 ... Accessing help from the command line ------------------------------------