History

transcaffeine dc7ca807a1 update(synapse): bump version to 1.120.2		2024-12-06 16:00:51 +01:00
..
defaults/main	update(synapse): bump version to 1.120.2	2024-12-06 16:00:51 +01:00
docs	feat(synapse): add ansible role	2024-09-22 18:24:44 +02:00
handlers	feat(synapse): add deployment method virtualenv	2024-09-28 22:13:33 +02:00
meta	meta: add role metadata to all roles	2024-10-04 14:53:48 +02:00
tasks	chore(synapse): drop unsupported parameter 'purge_networks' on 'docker_container' module	2024-12-01 09:56:57 +01:00
templates	feat(synapse): add deployment method virtualenv	2024-09-28 22:13:33 +02:00
vars	feat(synapse): add deployment method virtualenv	2024-09-28 22:13:33 +02:00
README.md	feat(synapse): add deployment method virtualenv	2024-09-28 22:13:33 +02:00

README.md

`finallycoffee.matrix.synapse` ansible role

Configuration

Required

The following variables need to be populated:

synapse_domain - the domain this homeserver should be authoritative for.
synapse_signing_key - the signing key synapse should use. Set either this or synapse_role_generate_signing_key: true.

Other

Deployment methods

docker
podman
virtualenv - Python virtual env supervised with systemd

Set synapse_deployment_method to one of the supported deployment methods. The current default is docker.

`virtualenv` deployment method

This deployment method installs a systemd service called synapse.service to control the homeserver process. The service depends on the network.target by default (see synapse_systemd_unit_after), and uses the default.target as it's WantedBy (see synapse_systemd_install_wanted_by).

To only start synapse after, for example, services for redis and postgresql are up, set synapse_systemd_unit_wants: [ "postgresql.service", "redis.service" ].

Note

Requires systemd >= 245 on the target machine