2024-09-20 12:15:55 +00:00
|
|
|
# `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
|
|
|
|
|
|
|
|
|
|
- [Configure your database](docs/database.md)
|
|
|
|
|
- [Configure your listeners](docs/listeners.md)
|
|
|
|
|
- [Configure logging](docs/logging.md)
|
|
|
|
|
|
|
|
|
|
## Deployment methods
|
|
|
|
|
|
2024-09-22 15:52:01 +00:00
|
|
|
- `docker`
|
|
|
|
|
- `podman`
|
2024-09-26 21:13:41 +00:00
|
|
|
- `virtualenv` - Python virtual env supervised with `systemd`
|
2024-09-20 12:15:55 +00:00
|
|
|
|
2024-09-22 15:52:01 +00:00
|
|
|
Set `synapse_deployment_method` to one of the supported deployment methods.
|
|
|
|
|
The current default is `docker`.
|
2024-09-20 12:15:55 +00:00
|
|
|
|
2024-09-26 21:13:41 +00:00
|
|
|
### `virtualenv` deployment method
|
2024-09-20 12:15:55 +00:00
|
|
|
|
2024-09-26 21:13:41 +00:00
|
|
|
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`](synapse/main/systemd.yml)), and
|
|
|
|
|
uses the `default.target` as it's `WantedBy`
|
|
|
|
|
(see [`synapse_systemd_install_wanted_by`](synapse/main/systemd.yml)).
|
|
|
|
|
|
|
|
|
|
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
|
