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 |
| **matrix_synapse_macaroon_secret_key** | __string__ | matrix's macaroon key (make sure not to change it!) |
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 |
| :--- | :--- | :--- |
| matrix_synapse_extra_config | _None_ | configuration parameters as given in the [synapse configuration file ](https://github.com/matrix-org/synapse/tree/master/docs ) |
| matrix_synapse_tls_cert_path | "/opt/synapse/tls/{{ matrix_server_name }}.crt" |
2019-02-12 02:14:30 +00:00
| matrix_synapse_tls_key_path | "/opt/synapse/tls/{{ matrix_server_name }}.key" |
| matrix_synapse_dh_path | "/opt/synapse/tls/{{ matrix_server_name }}.dh" |
| matrix_synapse_baseurl | "https://{{ matrix_server_name }}" |
2019-02-11 21:37:32 +00:00
| matrix_synapse_media_store_path | "/opt/synapse/media_store" |
| matrix_synapse_uploads_path | "/opt/synapse/uploads" |
| matrix_synapse_registration_secret | "{{ matrix_registration_secret }}" |
2019-02-12 02:14:30 +00:00
| 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-14 23:24:21 +00:00
| matrix_synapse_skip_tls | false |
| matrix_synapse_registration_secret | _randomly generated_ |
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
