2.1 KiB
2.1 KiB
matrix-synapse
Install a matrix synapse server.
Requirements
The following should be present on the target system
pipsystemdrsyslogdlogrotate
Role Variables
Mandatory Variables
| Name | Type | Description |
|---|---|---|
| matrix_server_name | string | |
| matrix_synapse_tls_cert | string | server's TLS certificate chain (when matrix_synapse_extra_config.no_tls is set to true) |
| matrix_synapse_tls_key | string | server's TLS key (when matrix_synapse_extra_config.no_tls is set to true) |
| matrix_synapse_report_stats | bool | Report the stats to matrix.org |
| matrix_synapse_pg_host | sting | postgresql server |
| matrix_synapse_pg_user | string | postgresql user |
| matrix_synapse_pg_pass | string | postgresql user's password |
| matrix_synapse_pg_db | string | postgresql database |
Optional Variables
| Name | Value | Description |
|---|---|---|
| matrix_synapse_base_path | "/opt/synapse" | |
| matrix_synapse_secrets_path | "{{ matrix_synapse_base_path }}/secrets" | |
| matrix_synapse_extra_config | None | configuration parameters as given in the synapse configuration file |
| matrix_synapse_dh_path | "{{ matrix_synapse_base_path }}/tls/{{ matrix_server_name }}.dh" | |
| matrix_synapse_baseurl | "https://{{ matrix_server_name }}" | |
| matrix_synapse_signing_key_path | "{{ matrix_synapse_base_path }}/ssl/{{ matrix_server_name }}.signing.key" | |
| matrix_synapse_version | "v1.0.0" | |
| matrix_synapse_log_days_keep | 30 | |
| matrix_synapse_deployment_method | pip | Either pip or docker ¹ |
| matrix_synapse_supervision_method | systemd | Either systemd, runit or docker ¹ |
| matrix_synapse_python_version | 3 | Default python version (2, 3) to be used |
¹: Docker must be used for both or neither deployment and supervision
Dependencies
None.
Example Playbook
#TODO: Add example
License
Apache 2.0
Author Information
- Michael Kaye
- Jan Christian Grünhage
- Emmanouil Kampitakis