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

Document how to start Synapse with Poetry #14892

Merged
merged 4 commits into from
Feb 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/14892.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document how to start Synapse with Poetry. Contributed by @thezaidbintariq.
11 changes: 11 additions & 0 deletions docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,18 @@ recommend the use of `systemd` where available: for information on setting up
[Systemd with Workers](systemd-with-workers/). To use `synctl`, see
[Using synctl with Workers](synctl_workers.md).

## Start Synapse with Poetry

The following applies to Synapse installations that have been installed from source using `poetry`.

You can start the main Synapse process with Poetry by running the following command:
```console
poetry run synapse_homeserver -c [your homeserver.yaml]
```
For worker setups, you can run the following command
```console
poetry run synapse_worker -c [your worker.yaml]
```
## Available worker applications

### `synapse.app.generic_worker`
Expand Down