Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Document how to run Synapse #15022

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/15022.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document how to start Synapse in the contributing guide.
13 changes: 13 additions & 0 deletions docs/development/contributing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down