ansible-collection-famedly-.../README.md
2019-02-15 00:24:21 +01:00

2.1 KiB

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_skip_tls not set)
matrix_synapse_tls_key string server's TLS key (when matrix_synapse_skip_tls not set)
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
matrix_synapse_macaroon_secret_key string matrix's macaroon key (make sure not to change it!)

Optional Variables

Name Value Description
matrix_synapse_extra_config None configuration parameters as given in the synapse configuration file
matrix_synapse_tls_cert_path "/opt/synapse/tls/{{ matrix_server_name }}.crt"
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 }}"
matrix_synapse_media_store_path "/opt/synapse/media_store"
matrix_synapse_uploads_path "/opt/synapse/uploads"
matrix_synapse_registration_secret "{{ matrix_registration_secret }}"
matrix_synapse_signing_key_path "/opt/synapse/ssl/{{ matrix_server_name }}.signing.key"
matrix_synapse_version "v0.99.1.1"
matrix_synapse_log_days_keep 30
matrix_synapse_skip_tls false
matrix_synapse_registration_secret randomly generated

Dependencies

None.

Example Playbook

#TODO: Add example

License

Apache 2.0

Author Information

  • Michael Kaye
  • Jan Christian Grünhage
  • Emmanouil Kampitakis