mirror of https://github.com/element-hq/synapse.git synced 2024-11-21 17:15:38 +03:00

History

Richard van der Hoff 2c36a679ae Some checks are pending Build docker images / build (push) Waiting to run Deploy the documentation / Calculate variables for GitHub Pages deployment (push) Waiting to run Deploy the documentation / GitHub Pages (push) Blocked by required conditions Build release artifacts / Calculate list of debian distros (push) Waiting to run Build release artifacts / Build .deb packages (push) Blocked by required conditions Build release artifacts / Build wheels on ${{ matrix.os }} for ${{ matrix.arch }} (aarch64, ${{ startsWith(github.ref, 'refs/pull/') }}, ubuntu-20.04) (push) Waiting to run Build release artifacts / Build wheels on ${{ matrix.os }} for ${{ matrix.arch }} (x86_64, ${{ startsWith(github.ref, 'refs/pull/') }}, macos-11) (push) Waiting to run Build release artifacts / Build wheels on ${{ matrix.os }} for ${{ matrix.arch }} (x86_64, ${{ startsWith(github.ref, 'refs/pull/') }}, ubuntu-20.04) (push) Waiting to run Build release artifacts / Build sdist (push) Waiting to run Build release artifacts / Attach assets to release (push) Blocked by required conditions Tests / linting-done (push) Blocked by required conditions Tests / calculate-test-jobs (push) Blocked by required conditions Tests / Typechecking (push) Blocked by required conditions Tests / lint-crlf (push) Waiting to run Tests / lint-newsfile (push) Waiting to run Tests / lint-pydantic (push) Blocked by required conditions Tests / lint-clippy (push) Blocked by required conditions Tests / lint-clippy-nightly (push) Blocked by required conditions Tests / lint-rustfmt (push) Blocked by required conditions Tests / check-sampleconfig (push) Blocked by required conditions Tests / check-schema-delta (push) Blocked by required conditions Tests / check-lockfile (push) Waiting to run Tests / lint (push) Blocked by required conditions Tests / changes (push) Waiting to run Tests / trial (push) Blocked by required conditions Tests / trial-olddeps (push) Blocked by required conditions Tests / trial-pypy (all, pypy-3.8) (push) Blocked by required conditions Tests / sytest (push) Blocked by required conditions Tests / export-data (push) Blocked by required conditions Tests / portdb (11, 3.8) (push) Blocked by required conditions Tests / portdb (15, 3.11) (push) Blocked by required conditions Tests / complement (monolith, Postgres) (push) Blocked by required conditions Tests / complement (monolith, SQLite) (push) Blocked by required conditions Tests / complement (workers, Postgres) (push) Blocked by required conditions Tests / cargo-test (push) Blocked by required conditions Tests / cargo-bench (push) Blocked by required conditions Tests / tests-done (push) Blocked by required conditions Include user membership on events (#17282 ) MSC4115 has now completed FCP, so we can enable it by default and switch to the stable identifier.		2024-06-13 21:45:54 +00:00
..
conf	Include user membership on events (#17282 )	2024-06-13 21:45:54 +00:00
Dockerfile	Fix typo	2023-12-13 16:37:10 +00:00
README.md	Better complement docs (#16946 )	2024-02-20 17:14:50 +00:00

README.md

Unified Complement image for Synapse

This is an image for testing Synapse with the Complement integration test suite. It contains some insecure defaults that are only suitable for testing purposes, so please don't use this image for a production server.

This multi-purpose image is built on top of Dockerfile-workers in the parent directory and can be switched using environment variables between the following configurations:

Monolithic Synapse with SQLite (default, or SYNAPSE_COMPLEMENT_DATABASE=sqlite)
Monolithic Synapse with Postgres (SYNAPSE_COMPLEMENT_DATABASE=postgres)
Workerised Synapse with Postgres (SYNAPSE_COMPLEMENT_DATABASE=postgres and SYNAPSE_COMPLEMENT_USE_WORKERS=true)

The image is self-contained; it contains an integrated Postgres, Redis and Nginx.

How to get Complement to pass the environment variables through

To pass these environment variables, use Complement's COMPLEMENT_SHARE_ENV_PREFIX variable to configure an environment prefix to pass through, then prefix the above options with that prefix.

Example:

COMPLEMENT_SHARE_ENV_PREFIX=PASS_ PASS_SYNAPSE_COMPLEMENT_DATABASE=postgres

Consult scripts-dev/complement.sh in the repository root for a real example.

How to modify homeserver.yaml for Complement tests

It's common for MSCs to be gated behind a feature flag like this:

experimental_features:
  faster_joins: true

To modify this for the Complement image, modify ./conf/workers-shared-extra.yaml.j2. Despite the name, this will affect non-worker mode as well. Remember to rebuild the image (so don't use -e if using complement.sh).