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

Commit 2fc15ac

Browse files
reivilibreclokep
andauthored
Flesh out documentation for running SyTest against Synapse, including use of Postgres and worker mode. (#12271)
Co-authored-by: Patrick Cloke <[email protected]>
1 parent a7fb66e commit 2fc15ac

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

changelog.d/12271.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify documentation for running SyTest against Synapse, including use of Postgres and worker mode.

docs/development/contributing_guide.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,14 @@ configuration:
254254
```sh
255255
$ 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
256256
```
257+
(Note that the paths must be full paths! You could also write `$(realpath relative/path)` if needed.)
257258

258-
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).
259+
This configuration should generally cover your needs.
260+
261+
- To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags.
262+
- To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags).
263+
264+
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).
259265

260266

261267
## Run the integration tests ([Complement](https://github.com/matrix-org/complement)).

0 commit comments

Comments
 (0)