mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-14 21:13:54 +01:00
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:
parent
dccae64083
commit
a4126e2861
2 changed files with 14 additions and 0 deletions
1
changelog.d/15022.doc
Normal file
1
changelog.d/15022.doc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Document how to start Synapse in the contributing guide.
|
|
@ -78,6 +78,19 @@ poetry install --extras all
|
||||||
|
|
||||||
This will install the runtime and developer dependencies for the project.
|
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.
|
# 5. Get in touch.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue