You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/07/23 01:56:49 UTC

[09/11] git commit: TS-2041: document environment overrides

TS-2041: document environment overrides


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/870fb304
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/870fb304
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/870fb304

Branch: refs/heads/master
Commit: 870fb30493c3f237ff9b79242dcf9cb9075de7d6
Parents: 7065a3a
Author: James Peach <jp...@apache.org>
Authored: Fri Jul 19 15:27:57 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Mon Jul 22 16:52:03 2013 -0700

----------------------------------------------------------------------
 .../configuration-files/records.config.en.rst   | 21 ++++++++++++++++++++
 1 file changed, 21 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/870fb304/doc/admin/configuration-files/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/records.config.en.rst b/doc/admin/configuration-files/records.config.en.rst
index b25f918..bcffc94 100644
--- a/doc/admin/configuration-files/records.config.en.rst
+++ b/doc/admin/configuration-files/records.config.en.rst
@@ -66,6 +66,27 @@ to 10 seconds.
 
     CONFIG proxy.config.cluster.startup_timeout INT 10
 
+Environment Overrides
+=====================
+
+Every :file:`records.config` configuration variable can be overridden
+by a corresponding environment variable. This can be useful in
+situations where you need a static :file:`records.config` but still
+want to tweak one or two settings. The override variable is formed
+by converting the :file:`records.config` variable name to upper
+case, and replacing any dot separators with an underscore.
+
+Overriding a variable from the environment is permanent and will
+not be affected by future configuration changes made in
+:file:`records.config` or applied with :program:`traffic_line`.
+
+For example, we could override the ``proxy.config.product_company`` variable
+like this::
+
+    $ PROXY_CONFIG_PRODUCT_COMPANY=example traffic_cop &
+    $ traffic_line -r proxy.config.product_company
+    example
+
 Configuration Variables
 =======================