summary refs log tree commit diff
path: root/develop/workers.html
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2023-02-16 18:20:49 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2023-02-16 18:20:49 +0000
commitfb3664da1cacfff3401471db38892bc29a701bbb (patch)
treeb1f16671d1ce9ac81138ddd01c0671f45afd279e /develop/workers.html
parentdeploy: d1efc479252f71f196e5a339af999d2c632bc294 (diff)
downloadsynapse-fb3664da1cacfff3401471db38892bc29a701bbb.tar.xz
deploy: ad1f3fa8e10d99ca49acd7a351a8e695e1412d64
Diffstat (limited to '')
-rw-r--r--develop/workers.html8
1 files changed, 8 insertions, 0 deletions
diff --git a/develop/workers.html b/develop/workers.html
index 7671306a38..2622cdb4c9 100644
--- a/develop/workers.html
+++ b/develop/workers.html
@@ -284,6 +284,14 @@ recommend the use of <code>systemd</code> where available: for information on se
 <code>systemd</code> to start synapse workers, see
 <a href="systemd-with-workers/">Systemd with Workers</a>. To use <code>synctl</code>, see
 <a href="synctl_workers.html">Using synctl with Workers</a>.</p>
+<h2 id="start-synapse-with-poetry"><a class="header" href="#start-synapse-with-poetry">Start Synapse with Poetry</a></h2>
+<p>The following applies to Synapse installations that have been installed from source using <code>poetry</code>.</p>
+<p>You can start the main Synapse process with Poetry by running the following command:</p>
+<pre><code class="language-console">poetry run synapse_homeserver -c [your homeserver.yaml]
+</code></pre>
+<p>For worker setups, you can run the following command</p>
+<pre><code class="language-console">poetry run synapse_worker -c [your worker.yaml]
+</code></pre>
 <h2 id="available-worker-applications"><a class="header" href="#available-worker-applications">Available worker applications</a></h2>
 <h3 id="synapseappgeneric_worker"><a class="header" href="#synapseappgeneric_worker"><code>synapse.app.generic_worker</code></a></h3>
 <p>This worker can handle API requests matching the following regular expressions.