History

Jason Little 003a25ae5c Additional functionality for declaring worker types in Complement (#14921 ) Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>		2023-03-14 16:29:33 +00:00
..
conf	Additional functionality for declaring worker types in Complement (#14921 )	2023-03-14 16:29:33 +00:00
Dockerfile	Add `--editable` flag to `complement.sh` which uses an editable install of Synapse for faster turn-around times whilst developing iteratively. (#14548 )	2022-12-07 15:45:31 +00:00
README.md	Complement: use SQLite by default (#13075 )	2022-06-16 12:12:26 +01: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.