ansible-collection-famedly-.../roles/synapse
2020-10-26 16:28:54 +01:00
..
defaults update(synapse): bump unstable version to 1.22.0rc2 2020-10-26 16:28:54 +01:00
files chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
handlers chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
meta chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
tasks chore(synapse): remove v from container version label 2020-09-19 14:03:56 +02:00
templates chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
tests chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
vars chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
.gitignore chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
CODEOWNERS chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00
README.md update(synapse): bump version to 1.21.2 2020-10-16 12:33:32 +02:00
TODO.md chore(git): merge roles/modules into collection 2020-08-01 19:29:25 +02:00

matrix-synapse

Install a matrix synapse server.

Requirements

The following should be present on the target system

  • pip
  • systemd
  • rsyslogd
  • logrotate

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 string 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.21.2"
matrix_synapse_unstable false when true, release candidate versions are deployed too
matrix_synapse_log_days_keep 14
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