diff options
| author | reivilibre <oliverw@matrix.org> | 2022-03-30 13:55:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-30 12:55:05 +0000 |
| commit | 2fc15ac718b4f48e42762deb8398af6978dc506f (patch) | |
| tree | 3f0f5ea35d8c1ae776752057b5a326fb51aaa42c | |
| parent | Update dead links in check-newsfragment.sh (#12331) (diff) | |
| download | synapse-2fc15ac718b4f48e42762deb8398af6978dc506f.tar.xz | |
Flesh out documentation for running SyTest against Synapse, including use of Postgres and worker mode. (#12271)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
| -rw-r--r-- | changelog.d/12271.doc | 1 | ||||
| -rw-r--r-- | docs/development/contributing_guide.md | 8 |
2 files changed, 8 insertions, 1 deletions
diff --git a/changelog.d/12271.doc b/changelog.d/12271.doc new file mode 100644 index 0000000000..d9696fc5d5 --- /dev/null +++ b/changelog.d/12271.doc @@ -0,0 +1 @@ +Clarify documentation for running SyTest against Synapse, including use of Postgres and worker mode. \ No newline at end of file diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 071202e196..afa8766f8d 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -254,8 +254,14 @@ configuration: ```sh $ docker run --rm -it -v /path/where/you/have/cloned/the/repository\:/src:ro -v /path/to/where/you/want/logs\:/logs matrixdotorg/sytest-synapse:buster ``` +(Note that the paths must be full paths! You could also write `$(realpath relative/path)` if needed.) -This configuration should generally cover your needs. For more details about other configurations, see [documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). +This configuration should generally cover your needs. + +- To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags. +- To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags). + +For more details about other configurations, see the [Docker-specific documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). ## Run the integration tests ([Complement](https://github.com/matrix-org/complement)). |