document supported env vars for docker 'generate' option

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.