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 <[email protected]> * Update docs/workers.md --------- Co-authored-by: David Robertson <[email protected]> Co-authored-by: Sean Quah <[email protected]>
matrix-org · Feb 16, 2023 · ad1f3fa · ad1f3fa
1 parent ffc2ee5
commit ad1f3fa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/changelog.d/14892.doc 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
@@ -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`