[doc] Document configuration override by environment variables
authorDenis Laxalde <denis.laxalde@logilab.fr>
Mon, 26 Sep 2016 10:42:19 +0200
changeset 11690 15715274a631
parent 11689 213f60272d49
child 11691 4e3ae4bd3fd5
[doc] Document configuration override by environment variables Related to #13889793.
doc/book/admin/instance-config.rst
--- a/doc/book/admin/instance-config.rst	Mon Sep 26 10:32:44 2016 +0200
+++ b/doc/book/admin/instance-config.rst	Mon Sep 26 10:42:19 2016 +0200
@@ -17,6 +17,11 @@
 each option name is prefixed with its own section and followed by its
 default value if necessary, e.g. "`<section>.<option>` [value]."
 
+.. note:: At runtime, configuration options can be overriden by environments
+    variables which name follows the option name with ``-`` replaced by ``_``
+    and a ``CW_`` prefix. For instance ``CW_BASE_URL=https://www.example.com``
+    would override the ``base-url`` configuration option.
+
 .. _`WebServerConfig`:
 
 Configuring the Web server