2019-02-12 02:14:30 +00:00
# matrix-synapse
2018-07-30 14:56:33 +00:00
Install a matrix synapse server.
2019-02-12 02:14:30 +00:00
## Requirements
2018-07-30 14:56:33 +00:00
2018-12-02 22:58:30 +00:00
The following should be present on the target system
* `pip`
* `systemd`
* `rsyslogd`
* `logrotate`
2018-07-30 14:56:33 +00:00
2019-02-12 02:14:30 +00:00
## Role Variables
2018-07-30 14:56:33 +00:00
2019-02-12 02:14:30 +00:00
### Mandatory Variables
| Name | Type | Description |
| :--- | :--- | :--- |
| **matrix_server_name** | __string__ | |
2019-02-14 23:24:21 +00:00
| **matrix_synapse_tls_cert** | __string__ | server's TLS certificate chain (_when matrix_synapse_skip_tls not set_)|
| **matrix_synapse_tls_key** | __string__ | server's TLS key (_when matrix_synapse_skip_tls not set_)|
2019-02-12 02:14:30 +00:00
| **matrix_synapse_report_stats** | __bool__ | Report the stats to matrix.org |
2019-02-14 23:24:21 +00:00
| **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 |
2019-02-12 02:14:30 +00:00
### Optional Variables
2019-02-11 21:37:32 +00:00
2019-02-14 23:24:21 +00:00
| Name | Value | Description |
| :--- | :--- | :--- |
2019-02-21 00:31:03 +00:00
| matrix_synapse_base_path | "/opt/synapse" | _This is not yet consistently used. **DO NOT RELY ON IT**. Lookout for future releases_
| matrix_synapse_secrets_path | "{{ matrix_synapse_base_path }}/secrets"
2019-02-14 23:24:21 +00:00
| matrix_synapse_extra_config | _None_ | configuration parameters as given in the [synapse configuration file ](https://github.com/matrix-org/synapse/tree/master/docs ) |
2019-02-12 02:14:30 +00:00
| matrix_synapse_dh_path | "/opt/synapse/tls/{{ matrix_server_name }}.dh" |
| matrix_synapse_baseurl | "https://{{ matrix_server_name }}" |
| matrix_synapse_signing_key_path | "/opt/synapse/ssl/{{ matrix_server_name }}.signing.key" |
2019-02-14 23:24:21 +00:00
| matrix_synapse_version | "v0.99.1.1" |
2019-02-11 21:37:32 +00:00
| matrix_synapse_log_days_keep | 30 |
2019-02-16 10:25:57 +00:00
| matrix_synapse_deployment_method | pip | Either pip or docker [¹ ](#footnote_1 ) |
| matrix_synapse_supervision_method | systemd | Either systemd, runit or docker [¹ ](#footnote_1 ) |
< a name = "footnote_1" > ¹< / a > : Docker must be used for both or neither deployment and supervision
2018-07-30 14:56:33 +00:00
2019-02-12 02:14:30 +00:00
## Dependencies
2018-07-30 14:56:33 +00:00
2018-12-02 22:58:30 +00:00
__None__.
2018-07-30 14:56:33 +00:00
2019-02-12 02:14:30 +00:00
## Example Playbook
2018-07-30 14:56:33 +00:00
2018-12-02 22:58:30 +00:00
```yaml
#TODO: Add example
```
2018-07-30 14:56:33 +00:00
2019-02-12 02:14:30 +00:00
## License
2018-07-30 14:56:33 +00:00
Apache 2.0
2019-02-12 02:14:30 +00:00
# Author Information
2018-07-30 14:56:33 +00:00
2018-12-02 22:58:30 +00:00
* Michael Kaye
* Jan Christian Grünhage
* Emmanouil Kampitakis
