summary refs log tree commit diff
path: root/docker/README.md
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2019-06-25 15:09:22 +0100
committerRichard van der Hoff <richard@matrix.org>2019-06-26 15:38:08 +0100
commitc58a6e6108d2891d10ce7f29e4b0169a3e026787 (patch)
treec00938cfb71cf2894ed7be6f26a6ab26e8ab88fe /docker/README.md
parentchangelog (diff)
downloadsynapse-c58a6e6108d2891d10ce7f29e4b0169a3e026787.tar.xz
document supported env vars for docker 'generate' option
Diffstat (limited to 'docker/README.md')
-rw-r--r--docker/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md
index 5a596eecb9..10af88844b 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -179,3 +179,10 @@ docker run -d --name synapse \
     -e SYNAPSE_CONFIG_PATH=/data/homeserver.yaml \
     matrixdotorg/synapse:latest
 ```
+
+The following environment variables are supported in this mode:
+
+* `SYNAPSE_SERVER_NAME` (mandatory): the server public hostname.
+* `SYNAPSE_REPORT_STATS` (mandatory, `yes` or `no`): whether to enable
+  anonymous statistics reporting.
+* `SYNAPSE_CONFIG_PATH` (mandatory): path to the file to be generated.