From ec487933225eea93db55e35af3735b546184b442 Mon Sep 17 00:00:00 2001
From: DMRobertson <DMRobertson@users.noreply.github.com>
Date: Wed, 8 Feb 2023 12:59:35 +0000
Subject: deploy: a4126e2861ee9c76d14138c12bd75c83d3e278ee

---
 develop/development/contributing_guide.html | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'develop/development')

diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html
index 0129e77777..038bb27c49 100644
--- a/develop/development/contributing_guide.html
+++ b/develop/development/contributing_guide.html
@@ -196,6 +196,13 @@ for other installation methods.</p>
 poetry install --extras all
 </code></pre>
 <p>This will install the runtime and developer dependencies for the project.</p>
+<h2 id="running-synapse-via-poetry"><a class="header" href="#running-synapse-via-poetry">Running Synapse via poetry</a></h2>
+<p>To start a local instance of Synapse in the locked poetry environment, create a config file:</p>
+<pre><code class="language-sh">cp docs/sample_config.yaml homeserver.yaml
+</code></pre>
+<p>Now edit homeserver.yaml, and run Synapse with:</p>
+<pre><code class="language-sh">poetry run python -m synapse.app.homeserver -c homeserver.yaml
+</code></pre>
 <h1 id="5-get-in-touch"><a class="header" href="#5-get-in-touch">5. Get in touch.</a></h1>
 <p>Join our developer community on Matrix: <a href="https://matrix.to/#/#synapse-dev:matrix.org">#synapse-dev:matrix.org</a>!</p>
 <h1 id="6-pick-an-issue"><a class="header" href="#6-pick-an-issue">6. Pick an issue.</a></h1>
-- 
cgit 1.5.1