diff options
| author | Samuel Philipp <codes@samuel-philipp.de> | 2020-10-11 21:51:11 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-11 20:51:11 +0100 |
| commit | 6905f5751a7e4966b1b63240ce31f80d02d30104 (patch) | |
| tree | 3bfa7825495431f522a17e486c63cadb37c03f80 /docker/README.md | |
| parent | Clean-up some broken/unused code in the test framework (#8514) (diff) | |
| download | synapse-6905f5751a7e4966b1b63240ce31f80d02d30104.tar.xz | |
Docker: support passing additional commandline args to synapse (#8390)
Diffstat (limited to 'docker/README.md')
| -rw-r--r-- | docker/README.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docker/README.md b/docker/README.md index d0da34778e..c8f27b8566 100644 --- a/docker/README.md +++ b/docker/README.md @@ -83,7 +83,7 @@ docker logs synapse If all is well, you should now be able to connect to http://localhost:8008 and see a confirmation message. -The following environment variables are supported in run mode: +The following environment variables are supported in `run` mode: * `SYNAPSE_CONFIG_DIR`: where additional config files are stored. Defaults to `/data`. @@ -94,6 +94,20 @@ The following environment variables are supported in run 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`. +For more complex setups (e.g. for workers) you can also pass your args directly to synapse using `run` mode. For example like this: + +``` +docker run -d --name synapse \ + --mount type=volume,src=synapse-data,dst=/data \ + -p 8008:8008 \ + matrixdotorg/synapse:latest run \ + -m synapse.app.generic_worker \ + --config-path=/data/homeserver.yaml \ + --config-path=/data/generic_worker.yaml +``` + +If you do not provide `-m`, the value of the `SYNAPSE_WORKER` environment variable is used. If you do not provide at least one `--config-path` or `-c`, the value of the `SYNAPSE_CONFIG_PATH` environment variable is used instead. + ## Generating an (admin) user After synapse is running, you may wish to create a user via `register_new_matrix_user`. |