summary refs log tree commit diff
path: root/docs/development
diff options
context:
space:
mode:
authorAndy Balaam <andy.balaam@matrix.org>2023-02-08 12:58:36 +0000
committerGitHub <noreply@github.com>2023-02-08 12:58:36 +0000
commita4126e2861ee9c76d14138c12bd75c83d3e278ee (patch)
tree31a3c5f663e29f952a79d238811b3e6b1316cc4e /docs/development
parentMerge branch 'release-v1.77' into develop (diff)
downloadsynapse-a4126e2861ee9c76d14138c12bd75c83d3e278ee.tar.xz
Document how to run Synapse (#15022)
* Document how to run Synapse

* Changelog for 15022

* Update docs/development/contributing_guide.md
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/contributing_guide.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md
index 36bc884684..925dcd8933 100644
--- a/docs/development/contributing_guide.md
+++ b/docs/development/contributing_guide.md
@@ -78,6 +78,19 @@ poetry install --extras all
 
 This will install the runtime and developer dependencies for the project.
 
+## Running Synapse via poetry
+
+To start a local instance of Synapse in the locked poetry environment, create a config file:
+
+```sh
+cp docs/sample_config.yaml homeserver.yaml
+```
+
+Now edit homeserver.yaml, and run Synapse with:
+
+```sh
+poetry run python -m synapse.app.homeserver -c homeserver.yaml
+```
 
 # 5. Get in touch.