summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2023-07-11 17:13:54 -0500
committerGitHub <noreply@github.com>2023-07-11 17:13:54 -0500
commit0371a354cf812593c724402c0dcfdab7257613ae (patch)
tree77aa1e60dcd037bbc3e2556920d02f9231eba04d /docs
parentBetter warning in logs when we fail to fetch an alias (#15922) (diff)
downloadsynapse-0371a354cf812593c724402c0dcfdab7257613ae.tar.xz
Better clarify how to run a worker instance (pass both configs) (#15921)
Previously, if you just followed the instructions per the docs, you just ran into an error:

```sh
$ poetry run synapse_worker --config-path homeserver_generic_worker1.yaml

Missing mandatory `server_name` config option.
```
Diffstat (limited to '')
-rw-r--r--docs/workers.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/workers.md b/docs/workers.md
index 735cd3f18d..cf9c0add82 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -177,11 +177,11 @@ The following applies to Synapse installations that have been installed from sou
 
 You can start the main Synapse process with Poetry by running the following command:
 ```console
-poetry run synapse_homeserver -c [your homeserver.yaml]
+poetry run synapse_homeserver --config-file [your homeserver.yaml]
 ```
 For worker setups, you can run the following command
 ```console
-poetry run synapse_worker -c [your worker.yaml]
+poetry run synapse_worker --config-file [your homeserver.yaml] --config-file [your worker.yaml]
 ```
 ## Available worker applications