diff options
| author | ZAID BIN TARIQ <57444558+thezaidbintariq@users.noreply.github.com> | 2023-02-16 23:20:02 +0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-16 18:20:02 +0000 |
| commit | ad1f3fa8e10d99ca49acd7a351a8e695e1412d64 (patch) | |
| tree | eead1d4162c691c3f5c9667d8295b4623a70128d | |
| parent | Use mypy 1.0 (#15052) (diff) | |
| download | synapse-ad1f3fa8e10d99ca49acd7a351a8e695e1412d64.tar.xz | |
Document how to start Synapse with Poetry (#14892)
* Add Start Synapse with Poetry * Create 14892.doc * Apply suggestions from code review Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> * Update docs/workers.md --------- Co-authored-by: David Robertson <david.m.robertson1@gmail.com> Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
| -rw-r--r-- | changelog.d/14892.doc | 1 | ||||
| -rw-r--r-- | docs/workers.md | 11 |
2 files changed, 12 insertions, 0 deletions
diff --git a/changelog.d/14892.doc b/changelog.d/14892.doc new file mode 100644 index 0000000000..2bc3ad06c6 --- /dev/null +++ b/changelog.d/14892.doc @@ -0,0 +1 @@ +Document how to start Synapse with Poetry. Contributed by @thezaidbintariq. diff --git a/docs/workers.md b/docs/workers.md index bc66f0e1bc..2eb970ffa6 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -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` |