Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Better clarify how to run a worker instance (pass both configs) #15921

Merged
merged 2 commits into from
Jul 11, 2023
Merged

Better clarify how to run a worker instance (pass both configs) #15921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d55076f
Better clarify how to run a worker instance
MadLittleMods Jul 11, 2023
277f801
Add changelog
MadLittleMods Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/15921.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Better clarify how to run a worker instance (pass both configs).
4 changes: 2 additions & 2 deletions docs/workers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using the long-hand version so people can plainly understand what the option is.

```
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

Expand Down