matrix-docker-ansible-deploy/examples/vars.yml

---
# The bare domain name which represents your Matrix identity.
# Matrix user IDs for your server will be of the form (`@alice:example.com`).
#
# Note: this playbook does not touch the server referenced here.
# Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`).
#
# If you've deployed using the wrong domain, you'll have to run the Uninstalling step,
# because you can't change the Domain after deployment.
matrix_domain: example.com

# The Matrix homeserver software to install.
# See:
#  - `roles/custom/matrix-base/defaults/main.yml` for valid options
# - the `docs/configuring-playbook-IMPLEMENTATION_NAME.md` documentation page, if one is available for your implementation choice
#
# 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.
matrix_homeserver_implementation: synapse

# A secret used as a base, for generating various other secrets.
# You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`).
matrix_homeserver_generic_secret_key: ''

# 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

# This is something which is provided to Let's Encrypt when retrieving SSL certificates for domains.
#
# In case SSL renewal fails at some point, you'll also get an email notification there.
#
# If you decide to use another method for managing SSL certificates (different than the default Let's Encrypt),
# you won't be required to define this variable (see `docs/configuring-playbook-ssl-certificates.md`).
#
# Example value: someone@example.com
traefik_config_certificatesResolvers_acme_email: ''

# A Postgres password to use for the superuser Postgres user (called `matrix` by default).
#
# The playbook creates additional Postgres users and databases (one for each enabled service)
# using this superuser account.
postgres_connection_password: ''

# 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: ''
fix: all praise the allmighty yamllinter 2022-02-05 20:32:54 +00:00			`---`
Rename some variables 2019-02-28 09:51:09 +00:00			`# The bare domain name which represents your Matrix identity.`
Edit user identifier examples: to `@alice` and `@bob` Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-12-08 08:03:37 +00:00			# Matrix user IDs for your server will be of the form (`@alice:example.com`).
Initial commit 2017-07-31 20:07:30 +00:00			`#`
Rename some variables 2019-02-28 09:51:09 +00:00			`# Note: this playbook does not touch the server referenced here.`
Update examples/vars.yml: update a comment to sync with roles/custom/matrix-base/defaults/main.yml Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-18 07:36:25 +00:00			# Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`).
Initial commit 2017-07-31 20:07:30 +00:00			`#`
Reorganize Postgres access (breaking change) In short, this makes Synapse a 2nd class citizen, preparing for a future where it's just one-of-many homeserver software options. We also no longer have a default Postgres superuser password, which improves security. The changelog explains more as to why this was done and how to proceed from here. 2021-01-22 10:23:00 +00:00			`# If you've deployed using the wrong domain, you'll have to run the Uninstalling step,`
Fix typo and wording 2020-09-13 06:51:04 +00:00			`# because you can't change the Domain after deployment.`
Replace YOUR_BARE_DOMAIN_NAME_HERE with example.com Remove an explanation about example as it is self-explanatory Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-17 16:02:24 +00:00			`matrix_domain: example.com`
Initial commit 2017-07-31 20:07:30 +00:00
Make matrix_homeserver_implementation influence matrix_IMPLEMENTATION_enabled, not the other way around Doing this seems more reasonable and simpler. 2021-12-23 14:28:34 +00:00			`# The Matrix homeserver software to install.`
Document Conduit installation Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076 2022-10-27 06:48:49 +00:00			`# See:`
Move roles/matrix* to roles/custom/matrix* This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those. 2022-11-03 07:11:29 +00:00			# - `roles/custom/matrix-base/defaults/main.yml` for valid options
Document Conduit installation Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076 2022-10-27 06:48:49 +00:00			# - the `docs/configuring-playbook-IMPLEMENTATION_NAME.md` documentation page, if one is available for your implementation choice
Edit the note about "matrix_homeserver_implementation" variable Since a casual user might want to try another homeserver than Synapse without thinking about its consequence, it is important to clarify that it is not possible to switch homeservers once specified. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-11-08 04:04:51 +00: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.`
Make matrix_homeserver_implementation influence matrix_IMPLEMENTATION_enabled, not the other way around Doing this seems more reasonable and simpler. 2021-12-23 14:28:34 +00:00			`matrix_homeserver_implementation: synapse`

Derive secrets from matrix_homeserver_generic_secret_key, not matrix_synapse_macaroon_secret_key We're trying to move away from implementation-specific variables, hoping for a clean (implementation-neutral) examples/vars.yml file. 2022-01-07 14:00:42 +00:00			`# A secret used as a base, for generating various other secrets.`
			# You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`).
			`matrix_homeserver_generic_secret_key: ''`

Switch default reverse-proxy to Traefik, force reverse-proxy choice on existing users 2023-02-26 14:14:05 +00: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`

Rename some variables 2019-02-28 09:51:09 +00:00			`# This is something which is provided to Let's Encrypt when retrieving SSL certificates for domains.`
Initial commit 2017-07-31 20:07:30 +00:00			`#`
Rename some variables 2019-02-28 09:51:09 +00:00			`# In case SSL renewal fails at some point, you'll also get an email notification there.`
Initial commit 2017-07-31 20:07:30 +00:00			`#`
Fix typo 2021-09-14 14:52:57 +00:00			`# If you decide to use another method for managing SSL certificates (different than the default Let's Encrypt),`
Rename some variables 2019-02-28 09:51:09 +00:00			# you won't be required to define this variable (see `docs/configuring-playbook-ssl-certificates.md`).
Initial commit 2017-07-31 20:07:30 +00:00			`#`
Rename some variables 2019-02-28 09:51:09 +00:00			`# Example value: someone@example.com`
Switch traefik/traefik-certs-dumper Ansible role sources and adjust variable names (devture_traefik_ -> traefik_) 2024-09-27 07:14:29 +00:00			`traefik_config_certificatesResolvers_acme_email: ''`
Switch Docker image to official one Switching from from avhost/docker-matrix (silviof/docker-matrix) to matrixdotorg/synapse. The avhost/docker-matrix (silviof/docker-matrix) image used to bundle in the coturn STUN/TURN server, so as part of the move, we're separating this to a separately-ran service (matrix-coturn.service, powered by instrumentisto/coturn-docker-image) 2018-05-25 18:58:53 +00:00
Fix typo 2021-01-22 12:13:56 +00:00			# A Postgres password to use for the superuser Postgres user (called `matrix` by default).
Reorganize Postgres access (breaking change) In short, this makes Synapse a 2nd class citizen, preparing for a future where it's just one-of-many homeserver software options. We also no longer have a default Postgres superuser password, which improves security. The changelog explains more as to why this was done and how to proceed from here. 2021-01-22 10:23:00 +00:00			`#`
			`# The playbook creates additional Postgres users and databases (one for each enabled service)`
			`# using this superuser account.`
Switch postgres/postgres-backup Ansible role sources and adjust variable names (devture_postgres_ -> postgres_) 2024-09-27 06:37:24 +00:00			`postgres_connection_password: ''`
Add support for external-IP-address-autodetection to Coturn 2023-10-10 08:10:21 +00: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: ''`