2019-03-03 18:22:52 +01:00
---
# This variables file wires together the various components (roles) used by the playbook.
#
# Roles used by playbook are pretty minimal and kept independent of one another as much as possible.
# To deliver a turnkey fully-featured Matrix server, this playbook needs
# to connect them all together. It does so by overriding role variables.
#
# You can also override ANY variable (seen here or in any given role),
# by re-defining it in your own configuration file (`inventory/host_vars/matrix.<your-domain>`).
2019-05-16 02:07:40 +02:00
2019-03-03 18:22:52 +01:00
######################################################################
#
2019-05-16 02:07:40 +02:00
# matrix-base
#
######################################################################
2020-08-17 16:02:40 +02:00
matrix_identity_server_url: "{{ ('https://' + matrix_server_fqn_matrix) if matrix_ma1sd_enabled else None }}"
2019-05-16 02:07:40 +02:00
2021-01-25 12:55:08 +01:00
# If Synapse workers are enabled and matrix-nginx-proxy is disabled, certain APIs may not work over 'http://matrix-synapse:8008'.
# This is because we explicitly disable them for the main Synapse process.
matrix_homeserver_container_url: "{{ 'http://matrix-nginx-proxy:12080' if matrix_nginx_proxy_enabled else 'http://matrix-synapse:8008' }}"
2019-05-16 02:07:40 +02:00
######################################################################
#
# /matrix-base
2019-03-03 18:22:52 +01:00
#
######################################################################
######################################################################
#
2019-05-16 02:07:40 +02:00
# matrix-bridge-appservice-discord
2019-03-03 18:22:52 +01:00
#
######################################################################
2019-05-16 02:07:40 +02:00
# We don't enable bridges by default.
matrix_appservice_discord_enabled: false
2019-03-03 18:22:52 +01:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-discord over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
2019-05-25 00:41:04 +02:00
# matrix-appservice-discord's client-server port to the local host.
matrix_appservice_discord_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9005' }}"
2019-03-03 18:22:52 +01:00
2019-06-26 09:30:51 +02:00
# If the homeserver disables presence, it's likely better (less wasteful) to also disable presence on the bridge side.
matrix_appservice_discord_bridge_disablePresence: "{{ matrix_synapse_use_presence }}"
2019-05-21 04:13:52 +02:00
matrix_appservice_discord_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2019-05-21 04:13:52 +02:00
}}
2019-03-03 18:22:52 +01:00
2019-06-26 09:30:51 +02:00
matrix_appservice_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.as.token') | to_uuid }}"
matrix_appservice_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'discord.hs.token') | to_uuid }}"
2020-12-13 23:52:25 +01:00
# We only make this use Postgres if our own Postgres server is enabled.
# It's only then (for now) that we can automatically create the necessary database and user for this service.
matrix_appservice_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-14 12:02:47 +01:00
matrix_appservice_discord_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.discord.db') | to_uuid }}"
2020-12-13 23:52:25 +01:00
2019-03-03 18:22:52 +01:00
######################################################################
#
2019-05-16 02:07:40 +02:00
# /matrix-bridge-appservice-discord
2019-03-03 18:22:52 +01:00
#
######################################################################
2020-01-09 17:00:03 +01:00
######################################################################
#
# matrix-appservice-webhooks
#
######################################################################
# We don't enable bridges by default.
matrix_appservice_webhooks_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-webhooks over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# matrix-appservice-webhooks' client-server port to the local host.
2020-05-10 08:52:52 +02:00
matrix_appservice_webhooks_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_webhooks_matrix_port) }}"
2020-01-09 17:00:03 +01:00
2020-01-24 11:06:36 +01:00
matrix_appservice_webhooks_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.as.token') | to_uuid }}"
2020-01-09 17:00:03 +01:00
2020-01-24 11:06:36 +01:00
matrix_appservice_webhooks_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.hs.token') | to_uuid }}"
2020-01-09 17:00:03 +01:00
2020-01-24 11:06:36 +01:00
matrix_appservice_webhooks_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'webhook.id.token') | to_uuid }}"
2020-01-09 17:00:03 +01:00
matrix_appservice_webhooks_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
}}
######################################################################
#
# /matrix-appservice-webhooks
#
######################################################################
2019-06-10 16:52:48 +02:00
######################################################################
#
# matrix-appservice-slack
#
######################################################################
# We don't enable bridges by default.
matrix_appservice_slack_enabled: false
2021-01-14 01:29:11 +01:00
matrix_appservice_slack_container_self_build: "{{ matrix_architecture != 'amd64' }}"
2019-07-27 20:22:34 +02:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-slack over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# matrix-appservice-slack's client-server port to the local host.
2020-03-03 16:48:51 +01:00
matrix_appservice_slack_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_appservice_slack_slack_port) }}"
2019-07-27 20:22:34 +02:00
2020-02-10 02:47:26 +01:00
matrix_appservice_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.as.token') | to_uuid }}"
2019-06-10 16:52:48 +02:00
2020-02-10 02:47:26 +01:00
matrix_appservice_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.hs.token') | to_uuid }}"
2019-06-10 16:52:48 +02:00
2020-02-06 01:25:26 +01:00
matrix_appservice_slack_id_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'slack.id.token') | to_uuid }}"
2019-06-10 16:52:48 +02:00
matrix_appservice_slack_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
}}
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
2021-01-06 22:00:49 +01:00
matrix_appservice_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
2020-12-14 12:02:47 +01:00
matrix_appservice_slack_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.slack.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2019-06-10 16:52:48 +02:00
######################################################################
#
# /matrix-bridge-appservice-slack
#
######################################################################
2019-05-16 02:07:40 +02:00
######################################################################
#
# matrix-bridge-appservice-irc
#
######################################################################
# We don't enable bridges by default.
matrix_appservice_irc_enabled: false
2021-01-22 21:28:53 +01:00
matrix_appservice_irc_container_self_build: "{{ matrix_architecture != 'amd64' }}"
2019-05-16 02:07:40 +02:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
2019-05-25 00:41:04 +02:00
# matrix-appservice-irc's client-server port to the local host.
matrix_appservice_irc_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9999' }}"
2019-05-16 02:07:40 +02:00
2019-06-19 08:30:59 +02:00
# The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable
# IRC bridge presence, for performance reasons.
matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_use_presence }}"
2019-05-21 04:13:52 +02:00
matrix_appservice_irc_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
}}
2019-03-03 18:22:52 +01:00
2019-06-26 08:19:36 +02:00
matrix_appservice_irc_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.as.token') | to_uuid }}"
2019-06-19 11:28:58 +02:00
2019-06-26 08:19:36 +02:00
matrix_appservice_irc_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'irc.hs.token') | to_uuid }}"
2019-06-19 11:28:58 +02:00
2020-12-22 18:32:43 +01:00
matrix_appservice_irc_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'nedb' }}"
2020-12-14 12:02:47 +01:00
matrix_appservice_irc_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'as.irc.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2019-03-03 18:22:52 +01:00
######################################################################
#
2019-05-16 02:07:40 +02:00
# /matrix-bridge-appservice-irc
2019-03-03 18:22:52 +01:00
#
######################################################################
2019-05-15 02:34:31 +02:00
######################################################################
#
# matrix-bridge-mautrix-facebook
#
######################################################################
# We don't enable bridges by default.
matrix_mautrix_facebook_enabled: false
2020-04-19 13:31:36 +02:00
matrix_mautrix_facebook_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
2020-03-15 09:10:41 +01:00
2019-05-21 04:13:52 +02:00
matrix_mautrix_facebook_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2019-05-21 04:13:52 +02:00
}}
2019-05-15 02:34:31 +02:00
2019-06-26 08:19:36 +02:00
matrix_mautrix_facebook_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.as.token') | to_uuid }}"
2019-06-15 08:42:40 +02:00
2019-06-26 08:19:36 +02:00
matrix_mautrix_facebook_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'fb.hs.token') | to_uuid }}"
2019-06-15 08:42:40 +02:00
2020-01-12 19:28:36 +01:00
matrix_mautrix_facebook_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-01 10:55:18 +01:00
matrix_mautrix_facebook_bridge_presence: "{{ matrix_synapse_use_presence if matrix_synapse_enabled else true }}"
2021-01-20 09:12:51 +01:00
# We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
# and point them to a migration path.
2020-12-14 07:54:24 +01:00
matrix_mautrix_facebook_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mautrix_facebook_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.fb.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2019-05-15 02:34:31 +02:00
######################################################################
#
# /matrix-bridge-mautrix-facebook
#
######################################################################
2019-07-28 18:52:30 +02:00
######################################################################
#
# matrix-bridge-mautrix-hangouts
#
######################################################################
# We don't enable bridges by default.
matrix_mautrix_hangouts_enabled: false
2020-04-19 13:31:36 +02:00
matrix_mautrix_hangouts_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
2020-03-15 09:10:41 +01:00
2019-07-28 18:52:30 +02:00
matrix_mautrix_hangouts_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2019-07-28 18:52:30 +02:00
}}
matrix_mautrix_hangouts_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.as.token') | to_uuid }}"
matrix_mautrix_hangouts_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ho.hs.token') | to_uuid }}"
2020-06-28 08:01:48 +02:00
matrix_mautrix_hangouts_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9007' }}"
2020-01-12 19:28:36 +01:00
matrix_mautrix_hangouts_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mautrix_hangouts_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mautrix_hangouts_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.hangouts.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2019-07-28 18:52:30 +02:00
######################################################################
#
2019-08-20 08:07:54 +02:00
# /matrix-bridge-mautrix-hangouts
2019-07-28 18:52:30 +02:00
#
######################################################################
2021-02-19 12:58:54 +01:00
######################################################################
#
# matrix-bridge-mautrix-instagram
#
######################################################################
# We don't enable bridges by default.
matrix_mautrix_instagram_enabled: false
matrix_mautrix_instagram_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}"
matrix_mautrix_instagram_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
matrix_mautrix_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ig.as.token') | to_uuid }}"
matrix_mautrix_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ig.hs.token') | to_uuid }}"
matrix_mautrix_instagram_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
matrix_mautrix_instagram_bridge_presence: "{{ matrix_synapse_use_presence if matrix_synapse_enabled else true }}"
# We'd like to force-set people with external Postgres to SQLite, so the bridge role can complain
# and point them to a migration path.
matrix_mautrix_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
matrix_mautrix_instagram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.ig.db') | to_uuid }}"
######################################################################
#
# /matrix-bridge-mautrix-instagram
#
######################################################################
2020-10-24 12:15:03 +02:00
######################################################################
#
# matrix-bridge-mautrix-signal
#
######################################################################
2021-01-02 00:39:11 +01:00
# We don't enable bridges by default.
2020-10-24 12:15:03 +02:00
matrix_mautrix_signal_enabled: false
matrix_mautrix_signal_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-10-25 20:46:32 +01:00
+
2021-01-02 00:39:11 +01:00
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
+
['matrix-mautrix-signal-daemon.service']
2020-10-24 12:15:03 +02:00
}}
2020-10-25 20:45:24 +01:00
matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}'
2021-01-25 12:55:08 +01:00
matrix_mautrix_signal_homeserver_address: "{{ matrix_homeserver_container_url }}"
2020-10-24 12:15:03 +02:00
matrix_mautrix_signal_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'si.hs.token') | to_uuid }}"
2020-10-25 20:46:57 +01:00
matrix_mautrix_signal_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'si.as.token') | to_uuid }}"
2020-10-24 12:15:03 +02:00
matrix_mautrix_signal_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2019-07-28 18:52:30 +02:00
2021-01-02 00:39:11 +01:00
matrix_mautrix_signal_database_engine: 'postgres'
2021-01-03 06:46:55 +01:00
matrix_mautrix_signal_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.signal.db') | to_uuid }}"
2020-10-25 20:45:24 +01:00
2020-10-24 12:15:03 +02:00
######################################################################
#
# /matrix-bridge-mautrix-signal
#
######################################################################
2019-07-28 18:52:30 +02:00
2019-05-14 16:47:22 +02:00
######################################################################
#
# matrix-bridge-mautrix-telegram
#
######################################################################
# We don't enable bridges by default.
matrix_mautrix_telegram_enabled: false
2021-01-13 21:40:47 +01:00
# Images are multi-arch (amd64 and arm64, but not arm32).
matrix_mautrix_telegram_container_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
2021-01-13 16:51:45 +01:00
2019-05-21 04:13:52 +02:00
matrix_mautrix_telegram_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2019-05-21 04:13:52 +02:00
}}
2019-05-14 16:47:22 +02:00
2019-06-26 08:19:36 +02:00
matrix_mautrix_telegram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.as.token') | to_uuid }}"
2019-06-15 08:43:43 +02:00
2019-06-26 08:19:36 +02:00
matrix_mautrix_telegram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegr.hs.token') | to_uuid }}"
2019-06-15 08:43:43 +02:00
2019-05-14 16:47:22 +02:00
matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
2019-05-26 19:50:52 +02:00
matrix_mautrix_telegram_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9006' }}"
2020-01-12 19:28:36 +01:00
matrix_mautrix_telegram_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mautrix_telegram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mautrix_telegram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mau.telegram.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2019-05-14 16:47:22 +02:00
######################################################################
#
# /matrix-bridge-mautrix-telegram
#
######################################################################
######################################################################
#
# matrix-bridge-mautrix-whatsapp
#
######################################################################
# We don't enable bridges by default.
matrix_mautrix_whatsapp_enabled: false
2019-05-21 04:13:52 +02:00
matrix_mautrix_whatsapp_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2019-05-21 04:13:52 +02:00
}}
2019-05-14 16:47:22 +02:00
2019-06-26 08:19:36 +02:00
matrix_mautrix_whatsapp_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.as.token') | to_uuid }}"
2019-06-24 00:16:04 +02:00
2019-06-26 08:19:36 +02:00
matrix_mautrix_whatsapp_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'whats.hs.token') | to_uuid }}"
2019-06-24 00:16:04 +02:00
2020-01-12 19:28:36 +01:00
matrix_mautrix_whatsapp_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mautrix_whatsapp_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mautrix_whatsapp_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mauwhatsapp.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2019-05-14 16:47:22 +02:00
######################################################################
#
# /matrix-bridge-mautrix-whatsapp
#
######################################################################
2020-05-22 13:50:59 +02:00
######################################################################
#
# matrix-sms-bridge
#
######################################################################
# We don't enable bridges by default.
matrix_sms_bridge_enabled: false
matrix_sms_bridge_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
}}
matrix_sms_bridge_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.as.token') | to_uuid }}"
matrix_sms_bridge_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'sms.hs.token') | to_uuid }}"
######################################################################
#
# /matrix-sms-bridge
#
######################################################################
2019-03-03 18:22:52 +01:00
2020-03-17 01:33:11 +01:00
######################################################################
#
# matrix-bridge-mx-puppet-skype
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_skype_enabled: false
2020-04-18 22:55:19 +02:00
matrix_mx_puppet_skype_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
2020-04-09 17:03:06 +02:00
2020-03-17 01:33:11 +01:00
matrix_mx_puppet_skype_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2020-03-17 01:33:11 +01:00
}}
2020-04-09 15:07:36 +02:00
matrix_mx_puppet_skype_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.as.tok') | to_uuid }}"
2020-03-17 01:33:11 +01:00
2020-04-09 15:07:36 +02:00
matrix_mx_puppet_skype_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'skype.hs.tok') | to_uuid }}"
2020-03-17 01:33:11 +01:00
matrix_mx_puppet_skype_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mx_puppet_skype_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mx_puppet_skype_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.skype.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2020-03-17 01:33:11 +01:00
######################################################################
#
# /matrix-bridge-mx-puppet-skype
#
######################################################################
2020-04-12 16:17:30 +02:00
######################################################################
#
# matrix-bridge-mx-puppet-slack
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_slack_enabled: false
2020-04-23 21:13:47 +02:00
matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
2020-04-12 16:17:30 +02:00
matrix_mx_puppet_slack_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2020-04-12 16:17:30 +02:00
}}
matrix_mx_puppet_slack_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.as.tok') | to_uuid }}"
matrix_mx_puppet_slack_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxslk.hs.tok') | to_uuid }}"
matrix_mx_puppet_slack_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mx_puppet_slack_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.slack.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2020-04-12 16:17:30 +02:00
######################################################################
#
# /matrix-bridge-mx-puppet-slack
#
######################################################################
2020-06-29 14:28:43 +02:00
######################################################################
#
# matrix-bridge-mx-puppet-twitter
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_twitter_enabled: false
matrix_mx_puppet_twitter_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
matrix_mx_puppet_twitter_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2020-06-29 14:28:43 +02:00
}}
matrix_mx_puppet_twitter_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxtwt.as.tok') | to_uuid }}"
matrix_mx_puppet_twitter_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxtwt.hs.tok') | to_uuid }}"
matrix_mx_puppet_twitter_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-06-30 16:39:19 +02:00
matrix_mx_puppet_twitter_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else ('127.0.0.1:' ~ matrix_mx_puppet_twitter_appservice_port) }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mx_puppet_twitter_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mx_puppet_twitter_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.twitter.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2020-06-29 14:28:43 +02:00
######################################################################
#
# /matrix-bridge-mx-puppet-twitter
#
######################################################################
2020-04-12 16:17:30 +02:00
2020-06-27 12:40:27 +02:00
######################################################################
#
# matrix-bridge-mx-puppet-instagram
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_instagram_enabled: false
matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
matrix_mx_puppet_instagram_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2020-06-27 12:40:27 +02:00
}}
2020-06-28 10:40:14 +02:00
matrix_mx_puppet_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
2020-06-27 12:40:27 +02:00
2020-06-28 10:40:14 +02:00
matrix_mx_puppet_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
2020-06-27 12:40:27 +02:00
matrix_mx_puppet_instagram_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mx_puppet_instagram_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mx_puppet_instagram_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.ig.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2020-06-27 12:40:27 +02:00
######################################################################
#
# /matrix-bridge-mx-puppet-instagram
#
######################################################################
2020-06-11 17:54:36 +02:00
######################################################################
#
# matrix-bridge-mx-puppet-discord
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_discord_enabled: false
matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
matrix_mx_puppet_discord_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2020-06-11 17:54:36 +02:00
}}
matrix_mx_puppet_discord_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxdsc.as.tok') | to_uuid }}"
matrix_mx_puppet_discord_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxdsc.hs.tok') | to_uuid }}"
matrix_mx_puppet_discord_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mx_puppet_discord_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.dsc.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2020-06-11 17:54:36 +02:00
######################################################################
#
# /matrix-bridge-mx-puppet-discord
#
######################################################################
2020-07-01 13:46:58 +02:00
######################################################################
#
# matrix-bridge-mx-puppet-steam
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_steam_enabled: false
matrix_mx_puppet_steam_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
matrix_mx_puppet_steam_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
2020-12-14 16:22:31 +01:00
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
2020-07-01 13:46:58 +02:00
}}
matrix_mx_puppet_steam_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxste.as.tok') | to_uuid }}"
matrix_mx_puppet_steam_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxste.hs.tok') | to_uuid }}"
matrix_mx_puppet_steam_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
2020-12-22 15:51:59 +01:00
matrix_mx_puppet_steam_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-23 11:59:48 +01:00
matrix_mx_puppet_steam_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.steam.db') | to_uuid }}"
2020-12-14 07:54:24 +01:00
2020-07-01 13:46:58 +02:00
######################################################################
#
# /matrix-bridge-mx-puppet-steam
#
######################################################################
2020-06-27 12:40:27 +02:00
2021-02-13 05:13:30 +01:00
######################################################################
#
# matrix-bridge-mx-puppet-groupme
#
######################################################################
# We don't enable bridges by default.
matrix_mx_puppet_groupme_enabled: false
matrix_mx_puppet_groupme_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
matrix_mx_puppet_groupme_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-synapse.service'] if matrix_synapse_enabled else [])
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
2021-02-14 19:37:12 +01:00
matrix_mx_puppet_groupme_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxgro.as.tok') | to_uuid }}"
2021-02-13 05:13:30 +01:00
2021-02-14 19:37:12 +01:00
matrix_mx_puppet_groupme_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxgro.hs.tok') | to_uuid }}"
2021-02-13 05:13:30 +01:00
matrix_mx_puppet_groupme_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_mx_puppet_groupme_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
matrix_mx_puppet_groupme_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxpup.groupme.db') | to_uuid }}"
######################################################################
#
# /matrix-bridge-mx-puppet-groupme
#
######################################################################
2020-07-20 13:13:08 +02:00
######################################################################
#
# matrix-bot-matrix-reminder-bot
#
######################################################################
# We don't enable bots by default.
matrix_bot_matrix_reminder_bot_enabled: false
2020-12-14 16:22:31 +01:00
matrix_bot_matrix_reminder_bot_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
2020-12-14 14:02:11 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_bot_matrix_reminder_bot_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
matrix_bot_matrix_reminder_bot_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'reminder.bot.db') | to_uuid }}"
2020-07-20 13:13:08 +02:00
######################################################################
#
# /matrix-bot-matrix-reminder-bot
#
######################################################################
2019-03-03 18:22:52 +01:00
######################################################################
#
# matrix-corporal
#
######################################################################
matrix_corporal_enabled: false
2020-12-04 00:48:08 +01:00
matrix_corporal_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
2019-03-03 18:22:52 +01:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-corporal over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
2019-05-25 00:41:04 +02:00
# matrix-corporal's web-server ports to the local host.
matrix_corporal_container_http_gateway_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41080' }}"
matrix_corporal_container_http_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:41081' }}"
2019-03-03 18:22:52 +01:00
matrix_corporal_systemd_required_services_list: |
{{
(['docker.service'])
+
(['matrix-synapse.service'])
}}
2021-01-25 08:21:17 +01:00
# This goes to Synapse's vhost
2021-01-25 12:55:08 +01:00
matrix_corporal_matrix_homeserver_api_endpoint: "{{ matrix_homeserver_container_url }}"
2019-03-03 18:22:52 +01:00
matrix_corporal_matrix_auth_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret }}"
2021-01-16 22:47:14 +01:00
# This is only useful if there's REST auth provider to make use of it.
matrix_corporal_http_gateway_internal_rest_auth_enabled: "{{ matrix_synapse_ext_password_provider_rest_auth_enabled }}"
2019-03-03 18:22:52 +01:00
matrix_corporal_matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret }}"
######################################################################
#
# /matrix-corporal
#
######################################################################
######################################################################
#
# matrix-coturn
#
######################################################################
matrix_coturn_enabled: true
2019-03-18 16:36:00 +01:00
2020-04-18 22:55:19 +02:00
matrix_coturn_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
2020-03-15 09:10:41 +01:00
2019-03-18 16:04:40 +01:00
matrix_coturn_turn_external_ip_address: "{{ ansible_host }}"
2019-03-03 18:22:52 +01:00
2020-11-26 09:08:52 +01:00
matrix_coturn_tls_enabled: "{{ matrix_ssl_retrieval_method != 'none' }}"
2019-03-19 09:24:39 +01:00
matrix_coturn_tls_cert_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/fullchain.pem"
matrix_coturn_tls_key_path: "{{ matrix_ssl_config_dir_path }}/live/{{ matrix_server_fqn_matrix }}/privkey.pem"
2020-11-26 09:08:52 +01:00
matrix_coturn_container_additional_volumes: |
{{
([] if matrix_ssl_retrieval_method == 'none' else [
{
'src': matrix_ssl_config_dir_path,
'dst': matrix_ssl_config_dir_path,
'options': 'ro',
}
])
}}
2019-03-19 09:24:39 +01:00
2019-03-03 18:22:52 +01:00
######################################################################
#
# /matrix-coturn
#
######################################################################
2019-03-08 14:00:53 +01:00
######################################################################
#
# matrix-dimension
#
######################################################################
matrix_dimension_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
2019-05-25 00:41:04 +02:00
# the Dimension HTTP port to the local host.
matrix_dimension_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8184' }}"
2019-03-08 14:00:53 +01:00
2019-12-10 05:23:56 +01:00
matrix_integration_manager_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else None }}"
matrix_integration_manager_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else None }}"
2020-12-14 16:22:31 +01:00
matrix_dimension_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
2020-12-14 07:54:24 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_dimension_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-14 20:01:47 +01:00
matrix_dimension_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'dimension.db') | to_uuid }}"
2020-04-22 19:01:56 +02:00
2019-03-08 14:00:53 +01:00
######################################################################
#
# /matrix-dimension
#
######################################################################
2021-01-21 00:06:35 +01:00
######################################################################
#
# matrix-etherpad
#
######################################################################
matrix_etherpad_enabled: false
2019-03-08 14:00:53 +01:00
2021-02-15 10:46:23 +01:00
matrix_etherpad_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9001' }}"
2021-01-21 00:06:35 +01:00
matrix_etherpad_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
matrix_etherpad_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'etherpad.db') | to_uuid }}"
######################################################################
#
# /matrix-etherpad
#
######################################################################
2020-11-08 02:34:16 +01:00
######################################################################
#
# matrix-dynamic-dns
#
######################################################################
2020-11-10 22:30:38 +01:00
matrix_dynamic_dns_enabled: false
2020-11-08 02:34:16 +01:00
######################################################################
#
# /matrix-dynamic-dns
#
######################################################################
2019-08-05 12:06:49 +02:00
######################################################################
#
# matrix-email2matrix
#
######################################################################
matrix_email2matrix_enabled: false
######################################################################
#
# /matrix-email2matrix
#
######################################################################
2019-03-08 14:00:53 +01:00
2020-03-23 16:19:15 +01:00
######################################################################
#
# matrix-jitsi
#
######################################################################
matrix_jitsi_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach jitsi/web over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# the Jitsi HTTP port to the local host.
matrix_jitsi_web_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12080' }}"
2020-11-27 16:57:07 +01:00
matrix_jitsi_jvb_container_colibri_ws_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:12090' }}"
2020-03-23 16:19:15 +01:00
matrix_jitsi_jibri_xmpp_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jibri') | to_uuid }}"
matrix_jitsi_jicofo_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jicofo') | to_uuid }}"
matrix_jitsi_jvb_auth_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'jvb') | to_uuid }}"
2020-03-24 08:35:21 +01:00
matrix_jitsi_web_stun_servers: |
{{
[
2020-04-09 18:09:04 +02:00
'stun:' + matrix_server_fqn_matrix + ':5349',
2020-04-09 08:16:10 +02:00
'stun:' + matrix_server_fqn_matrix + ':3478',
2020-03-24 08:35:21 +01:00
]
if matrix_coturn_enabled
2020-04-09 08:16:10 +02:00
else [ 'stun:meet-jit-si-turnrelay.jitsi.net:443']
2020-03-24 08:35:21 +01:00
}}
2020-03-23 16:19:15 +01:00
2021-01-21 00:06:59 +01:00
# If the self-hosted Etherpad instance is available, it will also show up in Jitsi conferences,
# unless explicitly disabled by setting `matrix_jitsi_etherpad_enabled` to false.
# Falls back to the scalar.vector.im etherpad in case someone sets `matrix_jitsi_etherpad_enabled` to true,
# while also setting `matrix_etherpad_enabled` to false.
matrix_jitsi_etherpad_enabled: "{{ matrix_etherpad_enabled }}"
matrix_jitsi_etherpad_base: "{{ matrix_etherpad_base_url if matrix_etherpad_enabled else 'https://scalar.vector.im/etherpad' }}"
2020-03-23 16:19:15 +01:00
######################################################################
#
# /matrix-jitsi
#
######################################################################
2019-03-03 18:22:52 +01:00
######################################################################
#
# matrix-mailer
#
######################################################################
2020-06-08 08:52:34 +02:00
# By default, this playbook sets up an exim mailer server (running in a container).
2019-03-03 18:22:52 +01:00
# This is so that Synapse can send email reminders for unread messages.
2020-01-08 22:31:44 +01:00
# Other services (like ma1sd), also use the mailer.
2019-03-03 18:22:52 +01:00
matrix_mailer_enabled: true
2020-06-08 08:52:34 +02:00
matrix_mailer_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
2019-03-03 18:22:52 +01:00
######################################################################
#
# /matrix-mailer
#
######################################################################
######################################################################
#
2020-01-08 22:31:44 +01:00
# matrix-ma1sd
2019-03-03 18:22:52 +01:00
#
######################################################################
2020-01-08 22:31:44 +01:00
# By default, this playbook installs the ma1sd identity server on the same domain as Synapse (`matrix_server_fqn_matrix`).
2019-03-03 18:22:52 +01:00
# If you wish to use the public identity servers (matrix.org, vector.im) instead of your own you may wish to disable this.
2020-01-08 22:31:44 +01:00
matrix_ma1sd_enabled: true
2019-03-03 18:22:52 +01:00
2020-06-29 13:53:23 +02:00
# There's no prebuilt ma1sd image for the `arm32` architecture.
# We're relying on self-building there.
matrix_ma1sd_architecture: "{{
{
'amd64': 'amd64',
'arm32': 'arm32',
'arm64': 'arm64',
}[matrix_architecture]
}}"
matrix_ma1sd_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
2020-03-15 09:10:41 +01:00
2020-01-08 22:31:44 +01:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach ma1sd over the container network.
2019-03-03 18:22:52 +01:00
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
2020-01-08 22:31:44 +01:00
# ma1sd's web-server port.
matrix_ma1sd_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8090' }}"
2019-03-03 18:22:52 +01:00
# We enable Synapse integration via its Postgres database by default.
# When using another Identity store, you might wish to disable this and define
2020-01-08 22:31:44 +01:00
# your own configuration in `matrix_ma1sd_configuration_extension_yaml`.
matrix_ma1sd_synapsesql_enabled: true
matrix_ma1sd_synapsesql_type: postgresql
matrix_ma1sd_synapsesql_connection: //{{ matrix_synapse_database_host }}/{{ matrix_synapse_database_database }}?user={{ matrix_synapse_database_user | urlencode() }}&password={{ matrix_synapse_database_password | urlencode() }}
2019-03-03 18:22:52 +01:00
2020-01-08 22:31:44 +01:00
matrix_ma1sd_dns_overwrite_enabled: true
matrix_ma1sd_dns_overwrite_homeserver_client_name: "{{ matrix_server_fqn_matrix }}"
2021-01-25 08:21:17 +01:00
matrix_ma1sd_dns_overwrite_homeserver_client_value: "http://{{ matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container }}"
2019-03-03 18:22:52 +01:00
# By default, we send mail through the `matrix-mailer` service.
2020-01-08 22:31:44 +01:00
matrix_ma1sd_threepid_medium_email_identity_from: "{{ matrix_mailer_sender_address }}"
matrix_ma1sd_threepid_medium_email_connectors_smtp_host: "matrix-mailer"
matrix_ma1sd_threepid_medium_email_connectors_smtp_port: 8025
matrix_ma1sd_threepid_medium_email_connectors_smtp_tls: 0
2019-03-03 18:22:52 +01:00
2020-09-01 10:44:44 +02:00
matrix_ma1sd_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
2019-03-22 08:39:17 +01:00
2020-12-14 16:22:31 +01:00
matrix_ma1sd_systemd_required_services_list: |
{{
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
2020-01-08 22:31:44 +01:00
matrix_ma1sd_systemd_wanted_services_list: |
2019-03-03 18:22:52 +01:00
{{
(['matrix-corporal.service'] if matrix_corporal_enabled else ['matrix-synapse.service'])
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
+
(['matrix-mailer.service'] if matrix_mailer_enabled else [])
}}
2020-12-14 16:16:25 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_ma1sd_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
matrix_ma1sd_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'ma1sd.db') | to_uuid }}"
2019-03-03 18:22:52 +01:00
######################################################################
#
2020-01-08 22:31:44 +01:00
# /matrix-ma1sd
2019-03-03 18:22:52 +01:00
#
######################################################################
######################################################################
#
# matrix-nginx-proxy
#
######################################################################
# By default, this playbook sets up a reverse-proxy nginx proxy server on TCP ports 80, 443 and 8448.
# This is fine if you're dedicating the whole server to Matrix.
# If that's not the case, you may wish to disable this and take care of proxying yourself.
matrix_nginx_proxy_enabled: true
2021-01-25 08:21:17 +01:00
matrix_nginx_proxy_proxy_matrix_client_api_addr_with_container: "{{ 'matrix-corporal:41080' if matrix_corporal_enabled else 'matrix-nginx-proxy:12080' }}"
matrix_nginx_proxy_proxy_matrix_client_api_addr_sans_container: "{{ '127.0.0.1:41080' if matrix_corporal_enabled else '127.0.0.1:12080' }}"
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb: "{{ matrix_synapse_max_upload_size_mb }}"
2020-10-27 19:33:37 +01:00
matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled: "{{ matrix_synapse_admin_enabled }}"
2020-10-28 09:39:12 +01:00
matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: "{{ matrix_server_fqn_element if matrix_client_element_enabled else '' }}"
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_proxy_matrix_enabled: true
2020-07-17 10:31:20 +02:00
matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled }}"
2019-03-07 06:22:08 +01:00
matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}"
2020-03-23 16:19:15 +01:00
matrix_nginx_proxy_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}"
2021-01-29 10:30:04 +01:00
matrix_nginx_proxy_proxy_grafana_enabled: "{{ matrix_grafana_enabled }}"
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_proxy_matrix_corporal_api_enabled: "{{ matrix_corporal_enabled and matrix_corporal_http_api_enabled }}"
matrix_nginx_proxy_proxy_matrix_corporal_api_addr_with_container: "matrix-corporal:41081"
matrix_nginx_proxy_proxy_matrix_corporal_api_addr_sans_container: "127.0.0.1:41081"
2020-01-08 22:31:44 +01:00
matrix_nginx_proxy_proxy_matrix_identity_api_enabled: "{{ matrix_ma1sd_enabled }}"
matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container: "matrix-ma1sd:8090"
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container: "127.0.0.1:8090"
# By default, we do TLS termination for the Matrix Federation API (port 8448) at matrix-nginx-proxy.
2020-12-08 15:48:25 +01:00
# Unless this is handled there OR Synapse's federation listener port is disabled, we'll reverse-proxy.
matrix_nginx_proxy_proxy_matrix_federation_api_enabled: "{{ matrix_synapse_federation_port_enabled and not matrix_synapse_tls_federation_listener_enabled }}"
2021-01-25 08:21:17 +01:00
matrix_nginx_proxy_proxy_matrix_federation_api_addr_with_container: "matrix-nginx-proxy:12088"
matrix_nginx_proxy_proxy_matrix_federation_api_addr_sans_container: "127.0.0.1:12088"
# Settings controlling matrix-synapse-proxy.conf
matrix_nginx_proxy_proxy_synapse_enabled: "{{ matrix_synapse_enabled }}"
matrix_nginx_proxy_proxy_synapse_federation_api_enabled: "{{ matrix_nginx_proxy_proxy_matrix_federation_api_enabled }}"
2019-03-03 18:22:52 +01:00
2020-06-09 07:29:03 +02:00
matrix_nginx_proxy_container_federation_host_bind_port: "{{ matrix_federation_public_port }}"
2021-02-12 12:47:53 +01:00
# This used to be hooked to `matrix_synapse_metrics_enabled`, but we don't do it anymore.
# The fact that someone wishes to enable Synapse metrics does not necessarily mean they want to make them public.
# A local Prometheus can consume them over the container network.
matrix_nginx_proxy_proxy_synapse_metrics: false
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_proxy_synapse_metrics_addr_with_container: "matrix-synapse:{{ matrix_synapse_metrics_port }}"
matrix_nginx_proxy_proxy_synapse_metrics_addr_sans_container: "127.0.0.1:{{ matrix_synapse_metrics_port }}"
2020-06-28 21:47:39 +02:00
matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: "{{ matrix_ma1sd_enabled }}"
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container }}"
matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container: "{{ matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container }}"
2020-09-01 10:44:44 +02:00
matrix_nginx_proxy_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
2019-03-22 08:39:17 +01:00
2020-10-28 07:13:19 +01:00
matrix_nginx_proxy_synapse_presence_disabled: "{{ not matrix_synapse_use_presence }}"
matrix_nginx_proxy_synapse_workers_enabled: "{{ matrix_synapse_workers_enabled }}"
matrix_nginx_proxy_synapse_workers_list: "{{ matrix_synapse_workers_enabled_list }}"
2021-01-24 21:18:31 +01:00
matrix_nginx_proxy_synapse_generic_worker_client_server_locations: "{{ matrix_synapse_workers_generic_worker_client_server_endpoints }}"
matrix_nginx_proxy_synapse_generic_worker_federation_locations: "{{ matrix_synapse_workers_generic_worker_federation_endpoints }}"
matrix_nginx_proxy_synapse_media_repository_locations: "{{matrix_synapse_workers_media_repository_endpoints|default([]) }}"
2020-10-28 23:09:21 +01:00
matrix_nginx_proxy_synapse_user_dir_locations: "{{ matrix_synapse_workers_user_dir_endpoints|default([]) }}"
matrix_nginx_proxy_synapse_frontend_proxy_locations: "{{ matrix_synapse_workers_frontend_proxy_endpoints|default([]) }}"
2020-10-28 07:13:19 +01:00
2019-03-03 18:22:52 +01:00
matrix_nginx_proxy_systemd_wanted_services_list: |
{{
(['matrix-synapse.service'])
+
(['matrix-corporal.service'] if matrix_corporal_enabled else [])
+
2020-01-08 22:31:44 +01:00
(['matrix-ma1sd.service'] if matrix_ma1sd_enabled else [])
2019-03-03 18:22:52 +01:00
+
2020-07-17 10:31:20 +02:00
(['matrix-client-element.service'] if matrix_client_element_enabled else [])
2019-03-03 18:22:52 +01:00
}}
matrix_ssl_domains_to_obtain_certificates_for: |
{{
([matrix_server_fqn_matrix])
+
2020-07-17 10:31:20 +02:00
([matrix_server_fqn_element] if matrix_client_element_enabled else [])
+
([matrix_nginx_proxy_proxy_riot_compat_redirect_hostname] if matrix_nginx_proxy_proxy_riot_compat_redirect_enabled else [])
2019-03-07 06:22:08 +01:00
+
([matrix_server_fqn_dimension] if matrix_dimension_enabled else [])
2019-03-12 21:27:18 +01:00
+
2020-03-24 15:21:26 +01:00
([matrix_server_fqn_jitsi] if matrix_jitsi_enabled else [])
2020-03-23 16:19:15 +01:00
+
2021-01-29 10:30:04 +01:00
([matrix_server_fqn_grafana] if matrix_grafana_enabled else [])
+
2019-03-12 21:27:18 +01:00
([matrix_domain] if matrix_nginx_proxy_base_domain_serving_enabled else [])
2021-02-06 08:02:39 +01:00
+
matrix_ssl_additional_domains_to_obtain_certificates_for
2019-03-03 18:22:52 +01:00
}}
2020-06-09 06:54:42 +02:00
matrix_ssl_architecture: "{{
{
'amd64': 'amd64',
'arm32': 'arm32v6',
'arm64': 'arm64v8',
}[matrix_architecture]
}}"
2020-04-18 22:55:19 +02:00
2020-11-10 23:22:09 +01:00
matrix_ssl_pre_obtaining_required_service_name: "{{ 'matrix-dynamic-dns' if matrix_dynamic_dns_enabled else '' }}"
2020-11-10 22:46:33 +01:00
2019-03-03 18:22:52 +01:00
######################################################################
#
# /matrix-nginx-proxy
#
######################################################################
######################################################################
#
# matrix-postgres
#
######################################################################
matrix_postgres_enabled: true
2021-01-22 12:52:55 +01:00
matrix_postgres_architecture: "{{ matrix_architecture }}"
2021-01-22 11:23:00 +01:00
# We unset this if internal Postgres disabled, which will cascade to some other variables
# and tell users they need to set it (either here or in those variables).
matrix_postgres_connection_hostname: "{{ 'matrix-postgres' if matrix_postgres_enabled else '' }}"
2019-03-03 18:22:52 +01:00
2020-12-23 08:08:54 +01:00
matrix_postgres_pgloader_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
2020-11-29 15:20:22 +01:00
matrix_postgres_additional_databases: |
{{
2021-01-22 11:23:00 +01:00
([{
'name': matrix_synapse_database_database,
'username': matrix_synapse_database_user,
'password': matrix_synapse_database_password,
}] if (matrix_synapse_enabled and matrix_synapse_database_database != matrix_postgres_db_name and matrix_synapse_database_host == 'matrix-postgres') else [])
+
2020-12-14 16:16:25 +01:00
([{
2020-12-22 16:10:02 +01:00
'name': matrix_ma1sd_database_name,
2020-12-14 16:16:25 +01:00
'username': matrix_ma1sd_database_username,
'password': matrix_ma1sd_database_password,
}] if (matrix_ma1sd_enabled and matrix_ma1sd_database_engine == 'postgres' and matrix_ma1sd_database_hostname == 'matrix-postgres') else [])
+
2020-12-14 14:02:11 +01:00
([{
2020-12-22 16:10:02 +01:00
'name': matrix_bot_matrix_reminder_bot_database_name,
2020-12-14 14:02:11 +01:00
'username': matrix_bot_matrix_reminder_bot_database_username,
'password': matrix_bot_matrix_reminder_bot_database_password,
}] if (matrix_bot_matrix_reminder_bot_enabled and matrix_bot_matrix_reminder_bot_database_engine == 'postgres' and matrix_bot_matrix_reminder_bot_database_hostname == 'matrix-postgres') else [])
+
2020-12-14 17:58:37 +01:00
([{
2020-12-22 16:10:02 +01:00
'name': matrix_registration_database_name,
2020-12-14 17:58:37 +01:00
'username': matrix_registration_database_username,
'password': matrix_registration_database_password,
}] if (matrix_registration_enabled and matrix_registration_database_engine == 'postgres' and matrix_registration_database_hostname == 'matrix-postgres') else [])
+
2020-11-29 15:20:22 +01:00
([{
2020-12-22 16:10:02 +01:00
'name': matrix_appservice_discord_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_appservice_discord_database_username,
'password': matrix_appservice_discord_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_appservice_discord_enabled and matrix_appservice_discord_database_engine == 'postgres' and matrix_appservice_discord_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_appservice_slack_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_appservice_slack_database_username,
'password': matrix_appservice_slack_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_appservice_irc_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_appservice_irc_database_username,
'password': matrix_appservice_irc_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_appservice_irc_enabled and matrix_appservice_irc_database_engine == 'postgres' and matrix_appservice_irc_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mautrix_facebook_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mautrix_facebook_database_username,
'password': matrix_mautrix_facebook_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mautrix_facebook_enabled and matrix_mautrix_facebook_database_engine == 'postgres' and matrix_mautrix_facebook_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mautrix_hangouts_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mautrix_hangouts_database_username,
'password': matrix_mautrix_hangouts_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mautrix_hangouts_enabled and matrix_mautrix_hangouts_database_engine == 'postgres' and matrix_mautrix_hangouts_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
2021-02-19 12:58:54 +01:00
([{
'name': matrix_mautrix_instagram_database_name,
'username': matrix_mautrix_instagram_database_username,
'password': matrix_mautrix_instagram_database_password,
}] if (matrix_mautrix_instagram_enabled and matrix_mautrix_instagram_database_engine == 'postgres' and matrix_mautrix_instagram_database_hostname == 'matrix-postgres') else [])
+
2021-01-02 00:39:11 +01:00
([{
2021-01-03 06:46:55 +01:00
'name': matrix_mautrix_signal_database_name,
'username': matrix_mautrix_signal_database_username,
'password': matrix_mautrix_signal_database_password,
2021-01-02 00:39:11 +01:00
}] if (matrix_mautrix_signal_enabled and matrix_mautrix_signal_database_engine == 'postgres' and matrix_mautrix_signal_database_hostname == 'matrix-postgres') else [])
+
2020-12-22 16:16:56 +01:00
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mautrix_telegram_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mautrix_telegram_database_username,
'password': matrix_mautrix_telegram_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mautrix_telegram_enabled and matrix_mautrix_telegram_database_engine == 'postgres' and matrix_mautrix_telegram_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mautrix_whatsapp_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mautrix_whatsapp_database_username,
'password': matrix_mautrix_whatsapp_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mautrix_whatsapp_enabled and matrix_mautrix_whatsapp_database_engine == 'postgres' and matrix_mautrix_whatsapp_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mx_puppet_skype_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mx_puppet_skype_database_username,
'password': matrix_mx_puppet_skype_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mx_puppet_skype_enabled and matrix_mx_puppet_skype_database_engine == 'postgres' and matrix_mx_puppet_skype_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mx_puppet_slack_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mx_puppet_slack_database_username,
'password': matrix_mx_puppet_slack_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mx_puppet_slack_enabled and matrix_mx_puppet_slack_database_engine == 'postgres' and matrix_mx_puppet_slack_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mx_puppet_twitter_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mx_puppet_twitter_database_username,
'password': matrix_mx_puppet_twitter_database_password,
2020-12-14 13:42:18 +01:00
}] if (matrix_mx_puppet_twitter_enabled and matrix_mx_puppet_twitter_database_engine == 'postgres' and matrix_mx_puppet_twitter_database_hostname == 'matrix-postgres') else [])
2020-12-22 16:16:56 +01:00
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mx_puppet_instagram_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mx_puppet_instagram_database_username,
'password': matrix_mx_puppet_instagram_database_password,
2020-12-22 16:16:56 +01:00
}] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == 'matrix-postgres') else [])
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mx_puppet_discord_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mx_puppet_discord_database_username,
'password': matrix_mx_puppet_discord_database_password,
2020-12-22 16:16:56 +01:00
}] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == 'matrix-postgres') else [])
+
([{
2020-12-22 16:10:02 +01:00
'name': matrix_mx_puppet_steam_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_mx_puppet_steam_database_username,
'password': matrix_mx_puppet_steam_database_password,
2020-12-22 16:16:56 +01:00
}] if (matrix_mx_puppet_steam_enabled and matrix_mx_puppet_steam_database_engine == 'postgres' and matrix_mx_puppet_steam_database_hostname == 'matrix-postgres') else [])
+
2021-02-13 06:50:00 +01:00
([{
'name': matrix_mx_puppet_groupme_database_name,
'username': matrix_mx_puppet_groupme_database_username,
'password': matrix_mx_puppet_groupme_database_password,
}] if (matrix_mx_puppet_groupme_enabled and matrix_mx_puppet_groupme_database_engine == 'postgres' and matrix_mx_puppet_groupme_database_hostname == 'matrix-postgres') else [])
+
2020-12-14 20:01:47 +01:00
([{
2020-12-22 16:10:02 +01:00
'name': matrix_dimension_database_name,
2020-12-14 12:02:47 +01:00
'username': matrix_dimension_database_username,
'password': matrix_dimension_database_password,
2020-12-14 20:01:47 +01:00
}] if (matrix_dimension_enabled and matrix_dimension_database_engine == 'postgres' and matrix_dimension_database_hostname == 'matrix-postgres') else [])
2021-01-21 00:06:35 +01:00
+
([{
'name': matrix_etherpad_database_name,
'username': matrix_etherpad_database_username,
'password': matrix_etherpad_database_password,
}] if (matrix_etherpad_enabled and matrix_etherpad_database_engine == 'postgres' and matrix_etherpad_database_hostname == 'matrix-postgres') else [])
2020-12-14 10:17:12 +01:00
}}
2020-11-29 15:20:22 +01:00
2020-12-14 21:28:20 +01:00
matrix_postgres_import_roles_to_ignore: |
{{
[matrix_postgres_connection_username]
+
2020-12-23 19:24:45 +01:00
matrix_postgres_additional_databases|map(attribute='username')|list
2020-12-14 21:28:20 +01:00
}}
matrix_postgres_import_databases_to_ignore: |
{{
[matrix_postgres_db_name]
+
2020-12-23 19:24:45 +01:00
matrix_postgres_additional_databases|map(attribute='name')|list
2020-12-14 21:28:20 +01:00
}}
2019-03-03 18:22:52 +01:00
######################################################################
#
# /matrix-postgres
#
######################################################################
2020-09-10 13:39:00 +02:00
######################################################################
#
# matrix-redis
#
######################################################################
matrix_redis_enabled: "{{ matrix_synapse_workers_enabled }}"
######################################################################
#
# /matrix-redis
#
######################################################################
2019-03-03 18:22:52 +01:00
######################################################################
#
2020-07-17 10:31:20 +02:00
# matrix-client-element
2019-03-03 18:22:52 +01:00
#
######################################################################
2020-07-17 10:31:20 +02:00
# By default, this playbook installs the Element web UI on the `matrix_server_fqn_element` domain.
2019-03-03 18:22:52 +01:00
# If you wish to connect to your Matrix server by other means, you may wish to disable this.
2020-07-17 10:31:20 +02:00
matrix_client_element_enabled: true
2019-03-03 18:22:52 +01:00
2020-07-17 10:31:20 +02:00
matrix_client_element_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
2020-03-15 09:10:41 +01:00
2020-07-17 10:31:20 +02:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach Element over the container network.
2019-03-03 18:22:52 +01:00
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
2020-07-17 10:31:20 +02:00
# the Element HTTP port to the local host.
matrix_client_element_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8765' }}"
2019-03-03 18:22:52 +01:00
2020-07-17 10:31:20 +02:00
matrix_client_element_default_hs_url: "{{ matrix_homeserver_url }}"
matrix_client_element_default_is_url: "{{ matrix_identity_server_url }}"
2019-03-03 18:22:52 +01:00
2019-03-08 14:24:59 +01:00
# Use Dimension if enabled, otherwise fall back to Scalar
2020-07-17 10:31:20 +02:00
matrix_client_element_integrations_ui_url: "{{ matrix_dimension_integrations_ui_url if matrix_dimension_enabled else 'https://scalar.vector.im/' }}"
matrix_client_element_integrations_rest_url: "{{ matrix_dimension_integrations_rest_url if matrix_dimension_enabled else 'https://scalar.vector.im/api' }}"
matrix_client_element_integrations_widgets_urls: "{{ matrix_dimension_integrations_widgets_urls if matrix_dimension_enabled else ['https://scalar.vector.im/api'] }}"
matrix_client_element_integrations_jitsi_widget_url: "{{ matrix_dimension_integrations_jitsi_widget_url if matrix_dimension_enabled else 'https://scalar.vector.im/api/widgets/jitsi.html' }}"
2019-03-08 14:24:59 +01:00
2020-09-01 10:44:44 +02:00
matrix_client_element_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
2019-03-22 08:39:17 +01:00
2020-07-17 10:31:20 +02:00
matrix_client_element_registration_enabled: "{{ matrix_synapse_enable_registration }}"
2019-04-25 01:05:28 +02:00
2020-07-17 10:31:20 +02:00
matrix_client_element_enable_presence_by_hs_url: |
2019-04-28 00:09:21 +02:00
{{
none
if matrix_synapse_use_presence
2020-07-17 10:31:20 +02:00
else {matrix_client_element_default_hs_url: false}
2019-04-28 00:09:21 +02:00
}}
2020-07-17 10:31:20 +02:00
matrix_client_element_welcome_user_id: ~
2019-06-14 06:40:24 +02:00
2020-07-17 10:31:20 +02:00
matrix_client_element_jitsi_preferredDomain: "{{ matrix_server_fqn_jitsi if matrix_jitsi_enabled else '' }}"
2020-03-23 16:19:15 +01:00
2019-03-03 18:22:52 +01:00
######################################################################
#
2020-07-17 10:31:20 +02:00
# /matrix-client-element
2019-03-03 18:22:52 +01:00
#
######################################################################
######################################################################
#
# matrix-synapse
#
######################################################################
2021-02-19 08:09:13 +01:00
matrix_synapse_container_image_self_build: "{{ matrix_architecture not in ['arm64', 'amd64'] }}"
2020-03-15 09:10:41 +01:00
2020-04-03 09:08:37 +02:00
# When ma1sd is enabled, we can use it to validate email addresses and phone numbers.
# Synapse can validate email addresses by itself as well, but it's probably not what we want by default when we have an identity server.
matrix_synapse_account_threepid_delegates_email: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
matrix_synapse_account_threepid_delegates_msisdn: "{{ 'http://matrix-ma1sd:8090' if matrix_ma1sd_enabled else '' }}"
2019-03-03 18:22:52 +01:00
# Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse over the container network.
2019-05-25 00:41:04 +02:00
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it,
# you can expose Synapse's ports to the host.
2019-03-03 18:22:52 +01:00
#
2019-05-25 00:41:04 +02:00
# For exposing the Matrix Client API's port (plain HTTP) to the local host.
matrix_synapse_container_client_api_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8008' }}"
#
# For exposing the Matrix Federation API's plain port (plain HTTP) to the local host.
matrix_synapse_container_federation_api_plain_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8048' }}"
#
# For exposing the Matrix Federation API's TLS port (HTTPS) to the internet on all network interfaces.
2020-06-09 07:29:03 +02:00
matrix_synapse_container_federation_api_tls_host_bind_port: "{{ matrix_federation_public_port if (matrix_synapse_federation_enabled and matrix_synapse_tls_federation_listener_enabled) else '' }}"
2019-05-25 00:41:04 +02:00
#
# For exposing the Synapse Metrics API's port (plain HTTP) to the local host.
matrix_synapse_container_metrics_api_host_bind_port: "{{ '127.0.0.1:9100' if (matrix_synapse_metrics_enabled and not matrix_nginx_proxy_enabled) else '' }}"
2019-12-05 07:07:15 +01:00
#
# For exposing the Synapse Manhole port (plain HTTP) to the local host.
matrix_synapse_container_manhole_api_host_bind_port: "{{ '127.0.0.1:9000' if matrix_synapse_manhole_enabled else '' }}"
2021-01-25 07:25:43 +01:00
#
# For exposing the Synapse worker (and metrics) ports to the local host.
matrix_synapse_workers_container_host_bind_address: "{{ '127.0.0.1' if (matrix_synapse_workers_enabled and not matrix_nginx_proxy_enabled) else '' }}"
2019-03-03 18:22:52 +01:00
2021-01-22 11:23:00 +01:00
matrix_synapse_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'synapse.db') | to_uuid }}"
2019-03-03 18:22:52 +01:00
# We do not enable TLS in Synapse by default.
# TLS is handled by the matrix-nginx-proxy, which proxies the requests to Synapse.
matrix_synapse_tls_federation_listener_enabled: false
matrix_synapse_tls_certificate_path: ~
matrix_synapse_tls_private_key_path: ~
2020-12-08 15:48:25 +01:00
matrix_synapse_federation_port_openid_resource_required: "{{ not matrix_synapse_federation_enabled and (matrix_dimension_enabled or matrix_ma1sd_enabled) }}"
2020-04-22 19:01:56 +02:00
2021-02-12 12:47:53 +01:00
# If someone instals Prometheus via the playbook, they most likely wish to monitor Synapse.
matrix_synapse_metrics_enabled: "{{ matrix_prometheus_enabled }}"
2019-03-03 18:22:52 +01:00
matrix_synapse_email_enabled: "{{ matrix_mailer_enabled }}"
matrix_synapse_email_smtp_host: "matrix-mailer"
matrix_synapse_email_smtp_port: 8025
matrix_synapse_email_smtp_require_transport_security: false
matrix_synapse_email_notif_from: "Matrix <{{ matrix_mailer_sender_address }}>"
2019-03-19 09:24:39 +01:00
# Even if TURN doesn't support TLS (it does by default),
# it doesn't hurt to try a secure connection anyway.
2019-03-03 18:22:52 +01:00
matrix_synapse_turn_uris: |
{{
[
2019-03-19 09:24:39 +01:00
'turns:' + matrix_server_fqn_matrix + '?transport=udp',
'turns:' + matrix_server_fqn_matrix + '?transport=tcp',
'turn:' + matrix_server_fqn_matrix + '?transport=udp',
'turn:' + matrix_server_fqn_matrix + '?transport=tcp',
2019-03-03 18:22:52 +01:00
]
if matrix_coturn_enabled
else []
}}
matrix_synapse_turn_shared_secret: "{{ matrix_coturn_turn_static_auth_secret if matrix_coturn_enabled else '' }}"
2020-09-01 10:44:44 +02:00
matrix_synapse_self_check_validate_certificates: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
2019-03-22 08:39:17 +01:00
2019-03-03 18:22:52 +01:00
matrix_synapse_systemd_required_services_list: |
{{
(['docker.service'])
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
+
(['matrix-goofys'] if matrix_s3_media_store_enabled else [])
}}
matrix_synapse_systemd_wanted_services_list: |
{{
(['matrix-coturn.service'] if matrix_coturn_enabled else [])
+
(['matrix-mailer.service'] if matrix_mailer_enabled else [])
}}
2020-10-28 07:13:19 +01:00
# Synapse workers (used for parallel load-scaling) need Redis for IPC.
2020-09-10 13:39:00 +02:00
matrix_synapse_redis_enabled: "{{ matrix_redis_enabled }}"
matrix_synapse_redis_host: "{{ 'matrix-redis' if matrix_redis_enabled else '' }}"
matrix_synapse_redis_password: "{{ matrix_redis_connection_password if matrix_redis_enabled else '' }}"
2019-03-03 18:22:52 +01:00
######################################################################
#
# /matrix-synapse
#
######################################################################
2020-07-22 07:10:26 +02:00
######################################################################
#
# matrix-synapse-admin
#
######################################################################
matrix_synapse_admin_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach Synapse Admin over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# Synapse Admin's HTTP port to the local host.
2020-07-22 11:04:49 +02:00
matrix_synapse_admin_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8766' }}"
2020-07-22 07:10:26 +02:00
2020-09-28 08:06:39 +02:00
matrix_synapse_admin_container_self_build: "{{ matrix_architecture != 'amd64' }}"
2020-07-22 07:10:26 +02:00
######################################################################
#
# /matrix-synapse-admin
#
######################################################################
2020-09-01 12:46:05 +02:00
2021-01-29 06:17:45 +01:00
######################################################################
#
# matrix-prometheus-node-exporter
#
######################################################################
matrix_prometheus_node_exporter_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus Node Exporter over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# Prometheus' HTTP port to the local host.
matrix_prometheus_node_exporter_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9100' }}"
######################################################################
#
# /matrix-prometheus-node-exporter
#
######################################################################
2021-01-29 05:29:25 +01:00
######################################################################
#
# matrix-prometheus
#
######################################################################
matrix_prometheus_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach Prometheus over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# Prometheus' HTTP port to the local host.
matrix_prometheus_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:9090' }}"
2021-01-31 18:23:12 +01:00
matrix_prometheus_scraper_synapse_enabled: "{{ matrix_synapse_enabled and matrix_synapse_metrics_enabled }}"
matrix_prometheus_scraper_synapse_targets: ['matrix-synapse:{{ matrix_synapse_metrics_port }}']
matrix_prometheus_scraper_synapse_rules_synapse_tag: "{{ matrix_synapse_docker_image_tag }}"
2021-01-31 17:26:08 +01:00
matrix_prometheus_scraper_node_enabled: "{{ matrix_prometheus_node_exporter_enabled }}"
2021-01-29 05:29:25 +01:00
######################################################################
#
# /matrix-prometheus
#
######################################################################
2021-01-29 09:10:49 +01:00
######################################################################
#
# matrix-grafana
#
######################################################################
matrix_grafana_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach Grafana over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# Grafana's HTTP port to the local host.
matrix_grafana_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:3000' }}"
######################################################################
#
# /matrix-grafana
#
######################################################################
2020-09-01 12:46:05 +02:00
######################################################################
#
# matrix-registration
#
######################################################################
matrix_registration_enabled: false
# Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-registration over the container network.
# If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose
# matrix-registration's HTTP port to the local host.
matrix_registration_container_http_host_bind_port: "{{ '' if matrix_nginx_proxy_enabled else '127.0.0.1:8767' }}"
matrix_registration_riot_instance: "{{ ('https://' + matrix_server_fqn_element) if matrix_client_element_enabled else 'https://riot.im/app/' }}"
matrix_registration_shared_secret: "{{ matrix_synapse_registration_shared_secret if matrix_synapse_enabled else '' }}"
2021-01-25 12:55:08 +01:00
matrix_registration_server_location: "{{ matrix_homeserver_container_url }}"
2020-09-01 12:46:05 +02:00
matrix_registration_api_validate_certs: "{{ false if matrix_ssl_retrieval_method == 'self-signed' else true }}"
matrix_registration_container_image_self_build: "{{ matrix_architecture != 'amd64' }}"
2020-12-14 17:58:37 +01:00
matrix_registration_systemd_required_services_list: |
{{
['docker.service']
+
(['matrix-postgres.service'] if matrix_postgres_enabled else [])
}}
2020-12-15 22:19:56 +01:00
# Postgres is the default, except if not using `matrix_postgres` (internal postgres)
matrix_registration_database_engine: "{{ 'postgres' if matrix_postgres_enabled else 'sqlite' }}"
2020-12-14 17:58:37 +01:00
matrix_registration_database_password: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mx.registr.db') | to_uuid }}"
2020-09-01 12:46:05 +02:00
######################################################################
#
# /matrix-registration
#
######################################################################