diff options
| author | reivilibre <reivilibre@users.noreply.github.com> | 2022-03-30 12:55:44 +0000 |
|---|---|---|
| committer | reivilibre <reivilibre@users.noreply.github.com> | 2022-03-30 12:55:44 +0000 |
| commit | 13da10fdc29e7af7302bb74bf450191c7e53da39 (patch) | |
| tree | 9b93ea4e20516892024d6dba4e0fbebdcb22c0f4 /develop/development | |
| parent | deploy: 437a8ed9efdf8f1aefa092d0761076da3ae78100 (diff) | |
| download | synapse-13da10fdc29e7af7302bb74bf450191c7e53da39.tar.xz | |
deploy: 2fc15ac718b4f48e42762deb8398af6978dc506f
Diffstat (limited to 'develop/development')
| -rw-r--r-- | develop/development/contributing_guide.html | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 8476d01bab..e580dfe324 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -352,7 +352,13 @@ typically catch more errors.</p> configuration:</p> <pre><code class="language-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 </code></pre> -<p>This configuration should generally cover your needs. For more details about other configurations, see <a href="https://github.com/matrix-org/sytest/blob/develop/docker/README.md">documentation in the SyTest repo</a>.</p> +<p>(Note that the paths must be full paths! You could also write <code>$(realpath relative/path)</code> if needed.)</p> +<p>This configuration should generally cover your needs.</p> +<ul> +<li>To run with Postgres, supply the <code>-e POSTGRES=1 -e MULTI_POSTGRES=1</code> environment flags.</li> +<li>To run with Synapse in worker mode, supply the <code>-e WORKERS=1 -e REDIS=1</code> environment flags (in addition to the Postgres flags).</li> +</ul> +<p>For more details about other configurations, see the <a href="https://github.com/matrix-org/sytest/blob/develop/docker/README.md">Docker-specific documentation in the SyTest repo</a>.</p> <h2 id="run-the-integration-tests-a-hrefhttpsgithubcommatrix-orgcomplementcomplementa"><a class="header" href="#run-the-integration-tests-a-hrefhttpsgithubcommatrix-orgcomplementcomplementa">Run the integration tests (<a href="https://github.com/matrix-org/complement">Complement</a>).</a></h2> <p><a href="https://github.com/matrix-org/complement">Complement</a> is a suite of black box tests that can be run on any homeserver implementation. It can also be thought of as end-to-end (e2e) tests.</p> <p>It's often nice to develop on Synapse and write Complement tests at the same time. |