[Pkg-privacy-commits] [onionbalance] 115/117: Document the logging config options

[Donncha O'Cearbahill]

This is an automated email from the git hooks/post-receive script.

donncha-guest pushed a commit to branch debian/sid
in repository onionbalance.

commit fd17394ecce705e8bed937ea1752a74555b93e27
Author: Donncha O'Cearbhaill <donncha at donncha.is>
Date:   Wed Dec 16 19:29:15 2015 +0100

    Document the logging config options
---
 docs/running-onionbalance.rst | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/docs/running-onionbalance.rst b/docs/running-onionbalance.rst
index fa898f8..5522395 100644
--- a/docs/running-onionbalance.rst
+++ b/docs/running-onionbalance.rst
@@ -78,12 +78,20 @@ you can simply use the generated config file from ``master/config.yaml``.
 .. note::
 
     By default onionbalance will search for a ``config.yaml`` file in
-    ``/etc/onionbalance/`` followed by the current working directory.
+    the current working directory.
 
 
 Configuration Options
 ~~~~~~~~~~~~~~~~~~~~~
 
+LOG_LOCATION
+  The path where OnionBalance should write its log file.
+
+LOG_LEVEL
+  Specify the minimum verbosity of log messages to output. All log messages
+  equal or higher the the specified log level are output. The available
+  log levels are the same as the --verbosity command line option.
+
 REFRESH_INTERVAL
   How often to check for updated backend hidden service descriptors. This
   value can be increased if your backend instance are under heavy loaded
@@ -114,6 +122,24 @@ DESCRIPTOR_UPLOAD_PERIOD
   How often to publish a descriptor, even when the introduction points
   don't change (default: 3600 seconds)
 
+
+Environment Variables
+~~~~~~~~~~~~~~~~~~~~~
+
+ONIONBALANCE_CONFIG
+  Override the location for the OnionBalance configuration file.
+
+The loaded configuration file takes precedence over environment variables.
+Configuration file options will override environment variable which have the
+same name.
+
+ONIONBALANCE_LOG_LOCATION
+  See the config file option.
+
+ONIONBALANCE_LOG_LEVEL
+  See the config file option
+
+
 Files
 -----
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onionbalance.git