diff options
| author | reivilibre <reivilibre@users.noreply.github.com> | 2022-04-05 11:45:19 +0000 |
|---|---|---|
| committer | reivilibre <reivilibre@users.noreply.github.com> | 2022-04-05 11:45:19 +0000 |
| commit | e666a1923168224fb8813c291d3a88d54252b491 (patch) | |
| tree | 5a1d11f08b4e6a21a44e44d0e9712a64ab3c5b19 /develop/development | |
| parent | deploy: f608e6c8cf48d8d5327c5ac04746f4f7f3992e31 (diff) | |
| download | synapse-e666a1923168224fb8813c291d3a88d54252b491.tar.xz | |
deploy: 708d88b1a22d422c294c4d06f2896a24f2a0251d
Diffstat (limited to 'develop/development')
| -rw-r--r-- | develop/development/contributing_guide.html | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 033473174e..d950a49759 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -319,9 +319,10 @@ useful to reproduce this locally.</p> following environment variables matching your configuration:</p> <ul> <li><code>SYNAPSE_POSTGRES</code> to anything nonempty</li> -<li><code>SYNAPSE_POSTGRES_HOST</code></li> -<li><code>SYNAPSE_POSTGRES_USER</code></li> -<li><code>SYNAPSE_POSTGRES_PASSWORD</code></li> +<li><code>SYNAPSE_POSTGRES_HOST</code> (optional if it's the default: UNIX socket)</li> +<li><code>SYNAPSE_POSTGRES_PORT</code> (optional if it's the default: 5432)</li> +<li><code>SYNAPSE_POSTGRES_USER</code> (optional if using a UNIX socket)</li> +<li><code>SYNAPSE_POSTGRES_PASSWORD</code> (optional if using a UNIX socket)</li> </ul> <p>For example:</p> <pre><code class="language-shell">export SYNAPSE_POSTGRES=1 @@ -330,6 +331,10 @@ export SYNAPSE_POSTGRES_USER=postgres export SYNAPSE_POSTGRES_PASSWORD=mydevenvpassword trial </code></pre> +<p>You don't need to specify the host, user, port or password if your Postgres +server is set to authenticate you over the UNIX socket (i.e. if the <code>psql</code> command +works without further arguments).</p> +<p>Your Postgres account needs to be able to create databases.</p> <h2 id="run-the-integration-tests-a-hrefhttpsgithubcommatrix-orgsytestsytesta"><a class="header" href="#run-the-integration-tests-a-hrefhttpsgithubcommatrix-orgsytestsytesta">Run the integration tests (<a href="https://github.com/matrix-org/sytest">Sytest</a>).</a></h2> <p>The integration tests are a more comprehensive suite of tests. They run a full version of Synapse, including your changes, to check if |