diff options
| author | reivilibre <oliverw@matrix.org> | 2022-04-05 12:44:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-05 12:44:48 +0100 |
| commit | 708d88b1a22d422c294c4d06f2896a24f2a0251d (patch) | |
| tree | b000fd7958d2da40bb7de58d3575d5cf271d1d3e /docs | |
| parent | Merge tag 'v1.56.0rc1' into develop (diff) | |
| download | synapse-708d88b1a22d422c294c4d06f2896a24f2a0251d.tar.xz | |
Allow specifying the Postgres database's port when running unit tests with Postgres. (#12376)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/contributing_guide.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 9db9352c9e..0d9cf60196 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -206,9 +206,10 @@ To do so, [configure Postgres](../postgres.md) and run `trial` with the following environment variables matching your configuration: - `SYNAPSE_POSTGRES` to anything nonempty -- `SYNAPSE_POSTGRES_HOST` -- `SYNAPSE_POSTGRES_USER` -- `SYNAPSE_POSTGRES_PASSWORD` +- `SYNAPSE_POSTGRES_HOST` (optional if it's the default: UNIX socket) +- `SYNAPSE_POSTGRES_PORT` (optional if it's the default: 5432) +- `SYNAPSE_POSTGRES_USER` (optional if using a UNIX socket) +- `SYNAPSE_POSTGRES_PASSWORD` (optional if using a UNIX socket) For example: @@ -220,6 +221,13 @@ export SYNAPSE_POSTGRES_PASSWORD=mydevenvpassword trial ``` +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 `psql` command +works without further arguments). + +Your Postgres account needs to be able to create databases. + + ## Run the integration tests ([Sytest](https://github.com/matrix-org/sytest)). The integration tests are a more comprehensive suite of tests. They |