diff options
| author | Michael Kaye <1917473+michaelkaye@users.noreply.github.com> | 2019-09-19 22:29:47 +0100 |
|---|---|---|
| committer | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-09-19 22:29:47 +0100 |
| commit | 2def5ea0da4b8134384adcd48e1e312f2f7e65c9 (patch) | |
| tree | f3c0e1f6e893a60fc63e4a51a6765a001a16f1b5 /docker/README.md | |
| parent | Use unstable prefix for 3PID unbind API (#6062) (diff) | |
| download | synapse-2def5ea0da4b8134384adcd48e1e312f2f7e65c9.tar.xz | |
Docker: support SYNAPSE_WORKER envvar (#6058)
* Allow passing SYNAPSE_WORKER envvar * changelog.d * Document SYNAPSE_WORKER. Attempting to imply that you don't need to change this default unless you're in worker mode. Also aware that there's a bigger problem of attempting to document a complete working configuration of workers using docker, as we currently only document to use `synctl` for worker mode, and synctl doesn't work that way in docker.
Diffstat (limited to 'docker/README.md')
| -rw-r--r-- | docker/README.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docker/README.md b/docker/README.md index d5879c2f2c..4b712f3f5c 100644 --- a/docker/README.md +++ b/docker/README.md @@ -89,6 +89,8 @@ The following environment variables are supported in run mode: `/data`. * `SYNAPSE_CONFIG_PATH`: path to the config file. Defaults to `<SYNAPSE_CONFIG_DIR>/homeserver.yaml`. +* `SYNAPSE_WORKER`: module to execute, used when running synapse with workers. + Defaults to `synapse.app.homeserver`, which is suitable for non-worker mode. * `UID`, `GID`: the user and group id to run Synapse as. Defaults to `991`, `991`. * `TZ`: the [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) the container will run with. Defaults to `UTC`. |