From e158b913adf7ed72c61aad1e4370b7f3f2ad8349 Mon Sep 17 00:00:00 2001 From: drebs Date: Tue, 5 Sep 2017 11:32:03 -0300 Subject: [doc] document environment variables --- docs/environment_variables.rst | 18 ++++++++++++++++-- src/leap/soledad/server/_config.py | 1 + 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/environment_variables.rst b/docs/environment_variables.rst index bebc11d6..8b976826 100644 --- a/docs/environment_variables.rst +++ b/docs/environment_variables.rst @@ -1,6 +1,20 @@ Environment Variables ===================== -Some environment variables affect the behaviour of Soledad Client: +Some environment variables affect the behaviour of Soledad: + +============================== ============= ================================= +variable affects description +============================== ============= ================================= +``SOLEDAD_HTTP_PERSIST`` client persist HTTP connections. +``SOLEDAD_SERVER_CONFIG_FILE`` server use this configuration file + instead of the default one. +``LOCAL_SERVICES_PORT`` server which port to use for local + TCP services. +``HTTPS_PORT`` server which port to use for public + HTTPS services. +``SOLEDAD_USE_PYTHON_LOGGING`` client/server use python logging instead of + twisted's logger. +``SOLEDAD_LOG_TO_STDOUT`` client/server log to standard output. +============================== ============= ================================= -* ``SOLEDAD_HTTP_PERSIST``: persist HTTP connections. diff --git a/src/leap/soledad/server/_config.py b/src/leap/soledad/server/_config.py index 12c286f5..3745d628 100644 --- a/src/leap/soledad/server/_config.py +++ b/src/leap/soledad/server/_config.py @@ -22,6 +22,7 @@ import os __all__ = ['get_config'] +# make sure to update documentation if this default is changed. DEFAULT_CONFIG_FILE = '/etc/soledad/soledad-server.conf' CONFIG_DEFAULTS = { 'soledad-server': { -- cgit v1.2.3