diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-06-27 11:17:44 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-27 11:17:44 +0100 |
| commit | b1b8a24b63c6c8b2076a3070c26e5ee2e8d6edb7 (patch) | |
| tree | e89fe41b728fa578c8a0bb94bcd0ea1b9accd9c2 /docker/README.md | |
| parent | Merge pull request #5562 from matrix-org/rav/docker/no-generate-keys (diff) | |
| parent | changelog (diff) | |
| download | synapse-b1b8a24b63c6c8b2076a3070c26e5ee2e8d6edb7.tar.xz | |
Merge pull request #5563 from matrix-org/rav/docker/data_dir
Docker image: add support for SYNAPSE_DATA_DIR parameter
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`. |