Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document how to run Synapse (#15022) 

* Document how to run Synapse

* Changelog for 15022

* Update docs/development/contributing_guide.md
This commit is contained in:
Andy Balaam 2023-02-08 12:58:36 +00:00 committed by GitHub
parent dccae64083
commit a4126e2861
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/15022.doc Normal file
View File

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

13
docs/development/contributing_guide.md
View File

@ -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.