summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordrebs <drebs@riseup.net>2017-09-05 11:32:03 -0300
committerdrebs <drebs@riseup.net>2017-09-05 11:39:33 -0300
commite158b913adf7ed72c61aad1e4370b7f3f2ad8349 (patch)
tree23537e1a6e74d299983862136de31f60ea2911db /docs
parente0a650d9ade2d028b9aaa4f0fb9fb07a371fbdfe (diff)
[doc] document environment variables
Diffstat (limited to 'docs')
-rw-r--r--docs/environment_variables.rst18
1 files changed, 16 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.