summary refs log tree commit diff
path: root/develop/development
diff options
context:
space:
mode:
authorreivilibre <reivilibre@users.noreply.github.com>2022-06-08 09:57:38 +0000
committerreivilibre <reivilibre@users.noreply.github.com>2022-06-08 09:57:38 +0000
commit3967b32899ff2484512061c9ccc929119c10f9d5 (patch)
tree2d2703d96eb3c36a288675628eb19b9b69adca3f /develop/development
parentdeploy: 8a499d7a608838619ce690c37c741a595486bd27 (diff)
downloadsynapse-3967b32899ff2484512061c9ccc929119c10f9d5.tar.xz
deploy: 67f51c84f828c2043f37b987b42323e8d740bad0
Diffstat (limited to 'develop/development')
-rw-r--r--develop/development/contributing_guide.html5
1 files changed, 5 insertions, 0 deletions
diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html
index 431123734e..1d4b261bb6 100644
--- a/develop/development/contributing_guide.html
+++ b/develop/development/contributing_guide.html
@@ -342,6 +342,11 @@ Here is how to run your local Synapse checkout against your local Complement che
 <p>To run a specific test, you can specify the whole name structure:</p>
 <pre><code class="language-sh">COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestImportHistoricalMessages/parallel/Historical_events_resolve_in_the_correct_order
 </code></pre>
+<p>The above will run a monolithic (single-process) Synapse with SQLite as the database. For other configurations, try:</p>
+<ul>
+<li>Passing <code>POSTGRES=1</code> as an environment variable to use the Postgres database instead.</li>
+<li>Passing <code>WORKERS=1</code> as an environment variable to use a workerised setup instead. This option implies the use of Postgres.</li>
+</ul>
 <h3 id="access-database-for-homeserver-after-complement-test-runs"><a class="header" href="#access-database-for-homeserver-after-complement-test-runs">Access database for homeserver after Complement test runs.</a></h3>
 <p>If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse:</p>
 <ol>