Browse Source

Document how to run Synapse (#15022)

* Document how to run Synapse

* Changelog for 15022

* Update docs/development/contributing_guide.md
Andy Balaam 1 year ago
parent
commit
a4126e2861
2 changed files with 14 additions and 0 deletions
  1. 1 0
      changelog.d/15022.doc
  2. 13 0
      docs/development/contributing_guide.md

+ 1 - 0
changelog.d/15022.doc

@@ -0,0 +1 @@
+Document how to start Synapse in the contributing guide.

+ 13 - 0
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.