diff options
Diffstat (limited to 'docker/README.md')
| -rw-r--r-- | docker/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md index 5a596eecb9..5c85c538a8 100644 --- a/docker/README.md +++ b/docker/README.md @@ -179,3 +179,14 @@ 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. +* `SYNAPSE_DATA_DIR`: where the generated config will put persistent data + such as the datatase and media store. Defaults to `/data`. +* `UID`, `GID`: the user id and group id to use for creating the data + directories. Defaults to `991`, `991`. |