2022-02-05 21:32:54 +01:00
|
|
|
---
|
2019-02-28 10:51:09 +01:00
|
|
|
# The bare domain name which represents your Matrix identity.
|
2024-12-08 09:03:37 +01:00
|
|
|
# Matrix user IDs for your server will be of the form (`@alice:example.com`).
|
2017-07-31 22:07:30 +02:00
|
|
|
#
|
2019-02-28 10:51:09 +01:00
|
|
|
# Note: this playbook does not touch the server referenced here.
|
2024-10-18 09:36:25 +02:00
|
|
|
# Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`).
|
2017-07-31 22:07:30 +02:00
|
|
|
#
|
2021-01-22 11:23:00 +01:00
|
|
|
# If you've deployed using the wrong domain, you'll have to run the Uninstalling step,
|
2020-09-13 08:51:04 +02:00
|
|
|
# because you can't change the Domain after deployment.
|
2024-10-17 18:02:24 +02:00
|
|
|
matrix_domain: example.com
|
2017-07-31 22:07:30 +02:00
|
|
|
|
2021-12-23 15:28:34 +01:00
|
|
|
# The Matrix homeserver software to install.
|
2022-10-27 08:48:49 +02:00
|
|
|
# See:
|
2022-11-03 08:11:29 +01:00
|
|
|
# - `roles/custom/matrix-base/defaults/main.yml` for valid options
|
2022-10-27 08:48:49 +02:00
|
|
|
# - the `docs/configuring-playbook-IMPLEMENTATION_NAME.md` documentation page, if one is available for your implementation choice
|
2024-11-08 05:04:51 +01:00
|
|
|
#
|
|
|
|
# By default, we use Synapse, because it's the only full-featured Matrix server at the moment.
|
|
|
|
#
|
|
|
|
# Note that the homeserver implementation of a server will not be able to be changed without data loss.
|
2021-12-23 15:28:34 +01:00
|
|
|
matrix_homeserver_implementation: synapse
|
|
|
|
|
2022-01-07 15:00:42 +01:00
|
|
|
# A secret used as a base, for generating various other secrets.
|
2024-12-22 06:59:40 +01:00
|
|
|
# You can put any string here, but generating a strong one is preferred. You can create one with a command like `pwgen -s 64 1`.
|
2022-01-07 15:00:42 +01:00
|
|
|
matrix_homeserver_generic_secret_key: ''
|
|
|
|
|
2023-02-26 15:14:05 +01:00
|
|
|
# By default, the playbook manages its own Traefik (https://doc.traefik.io/traefik/) reverse-proxy server.
|
|
|
|
# It will retrieve SSL certificates for you on-demand and forward requests to all other components.
|
|
|
|
# For alternatives, see `docs/configuring-playbook-own-webserver.md`.
|
|
|
|
matrix_playbook_reverse_proxy_type: playbook-managed-traefik
|
|
|
|
|
2019-02-28 10:51:09 +01:00
|
|
|
# This is something which is provided to Let's Encrypt when retrieving SSL certificates for domains.
|
2017-07-31 22:07:30 +02:00
|
|
|
#
|
2019-02-28 10:51:09 +01:00
|
|
|
# In case SSL renewal fails at some point, you'll also get an email notification there.
|
2017-07-31 22:07:30 +02:00
|
|
|
#
|
2021-09-14 16:52:57 +02:00
|
|
|
# If you decide to use another method for managing SSL certificates (different than the default Let's Encrypt),
|
2019-02-28 10:51:09 +01:00
|
|
|
# you won't be required to define this variable (see `docs/configuring-playbook-ssl-certificates.md`).
|
2017-07-31 22:07:30 +02:00
|
|
|
#
|
2019-02-28 10:51:09 +01:00
|
|
|
# Example value: someone@example.com
|
2024-09-27 09:14:29 +02:00
|
|
|
traefik_config_certificatesResolvers_acme_email: ''
|
2018-05-25 20:58:53 +02:00
|
|
|
|
2021-01-22 13:13:56 +01:00
|
|
|
# A Postgres password to use for the superuser Postgres user (called `matrix` by default).
|
2021-01-22 11:23:00 +01:00
|
|
|
#
|
|
|
|
# The playbook creates additional Postgres users and databases (one for each enabled service)
|
|
|
|
# using this superuser account.
|
2024-09-27 08:37:24 +02:00
|
|
|
postgres_connection_password: ''
|
2023-10-10 10:10:21 +02:00
|
|
|
|
|
|
|
# By default, we configure Coturn's external IP address using the value specified for `ansible_host` in your `inventory/hosts` file.
|
|
|
|
# If this value is an external IP address, you can skip this section.
|
|
|
|
#
|
|
|
|
# If `ansible_host` is not the server's external IP address, you have 2 choices:
|
|
|
|
# 1. Uncomment the line below, to allow IP address auto-detection to happen (more on this below)
|
|
|
|
# 2. Uncomment and adjust the line below to specify an IP address manually
|
|
|
|
#
|
|
|
|
# By default, auto-detection will be attempted using the `https://ifconfig.co/json` API.
|
|
|
|
# Default values for this are specified in `matrix_coturn_turn_external_ip_address_auto_detection_*` variables in the Coturn role
|
|
|
|
# (see `roles/custom/matrix-coturn/defaults/main.yml`).
|
|
|
|
#
|
|
|
|
# If your server has multiple IP addresses, you may define them in another variable which allows a list of addresses.
|
|
|
|
# Example: `matrix_coturn_turn_external_ip_addresses: ['1.2.3.4', '4.5.6.7']`
|
|
|
|
#
|
|
|
|
# matrix_coturn_turn_external_ip_address: ''
|