2019-02-28 17:51:09 +08:00
# The bare domain name which represents your Matrix identity.
# Matrix user ids for your server will be of the form (`@user:<matrix-domain>`).
#
2019-01-12 23:53:00 +08:00
# Note: this playbook does not touch the server referenced here.
2019-02-28 17:51:09 +08:00
# Installation happens on another server ("matrix.<matrix-domain>", see `matrix_server_fqn_matrix`).
#
# Example value: example.com
matrix_domain : ~
2019-01-12 23:53:00 +08:00
2019-02-28 17:51:09 +08:00
# This is where your data lives and what we set up.
2020-07-17 16:31:20 +08:00
# This and the Element FQN (see below) are expected to be on the same server.
2019-02-28 17:51:09 +08:00
matrix_server_fqn_matrix : "matrix.{{ matrix_domain }}"
2019-01-12 23:53:00 +08:00
2021-06-28 20:30:48 +08:00
# This is where you access federation API.
matrix_server_fqn_matrix_federation : '{{ matrix_server_fqn_matrix }}'
2020-07-17 16:31:20 +08:00
# This is where you access the Element web UI from (if enabled via matrix_client_element_enabled; enabled by default).
2019-02-28 17:51:09 +08:00
# This and the Matrix FQN (see above) are expected to be on the same server.
2020-07-17 16:31:20 +08:00
matrix_server_fqn_element : "element.{{ matrix_domain }}"
2019-01-12 23:53:00 +08:00
2021-05-15 17:23:36 +08:00
# This is where you access the Hydrogen web client from (if enabled via matrix_client_hydrogen_enabled; disabled by default).
matrix_server_fqn_hydrogen : "hydrogen.{{ matrix_domain }}"
2019-03-07 13:22:08 +08:00
# This is where you access the Dimension.
matrix_server_fqn_dimension : "dimension.{{ matrix_domain }}"
2021-03-12 02:23:01 +08:00
# For use with Go-NEB! (github callback url for example)
matrix_server_fqn_bot_go_neb : "goneb.{{ matrix_domain }}"
2020-03-23 23:19:15 +08:00
# This is where you access Jitsi.
matrix_server_fqn_jitsi : "jitsi.{{ matrix_domain }}"
2021-01-29 17:30:04 +08:00
# This is where you access Grafana.
matrix_server_fqn_grafana : "stats.{{ matrix_domain }}"
2021-03-20 19:31:34 +08:00
# This is where you access the Sygnal push gateway.
matrix_server_fqn_sygnal : "sygnal.{{ matrix_domain }}"
2020-06-09 13:29:03 +08:00
matrix_federation_public_port : 8448
2020-12-17 17:33:18 +08:00
# The architecture that your server runs.
# Recognized values by us are 'amd64', 'arm32' and 'arm64'.
# Not all architectures support all services, so your experience (on non-amd64) may vary.
# See docs/alternative-architectures.md
matrix_architecture : amd64
2020-12-17 17:37:30 +08:00
# The architecture for Debian packages.
# See: https://wiki.debian.org/SupportedArchitectures
# We just remap from our `matrix_architecture` values to what Debian and possibly other distros call things.
matrix_debian_arch : "{{ 'armhf' if matrix_architecture == 'arm32' else matrix_architecture }}"
2019-01-12 23:53:00 +08:00
matrix_user_username : "matrix"
2020-05-02 01:59:32 +08:00
matrix_user_groupname : "matrix"
2019-01-12 23:53:00 +08:00
2020-07-06 16:05:34 +08:00
# By default, the playbook creates the user (`matrix_user_username`)
# and group (`matrix_user_groupname`) with a random id.
# To use a specific user/group id, override these variables.
matrix_user_uid : ~
matrix_user_gid : ~
2019-01-12 23:53:00 +08:00
matrix_base_data_path : "/matrix"
2019-01-14 21:28:37 +08:00
matrix_base_data_path_mode : "750"
2019-01-12 23:53:00 +08:00
matrix_static_files_base_path : "{{ matrix_base_data_path }}/static-files"
2020-03-25 02:27:58 +08:00
matrix_systemd_path : "/etc/systemd/system"
2021-01-15 05:23:46 +08:00
2021-01-15 06:21:55 +08:00
# Specifies the path to use for the `HOME` environment variable for systemd unit files.
# Docker 20.10 complains with `WARNING: Error loading config file: .dockercfg: $HOME is not defined`
# if `$HOME` is not defined, so we define something to make it happy.
matrix_systemd_unit_home_path : /root
2021-01-15 05:23:46 +08:00
# This is now unused. We keep it so that cleanup tasks can use it.
# To be removed in the future.
2020-03-25 02:27:58 +08:00
matrix_cron_path : "/etc/cron.d"
2021-01-15 05:23:46 +08:00
2020-03-25 02:27:58 +08:00
matrix_local_bin_path : "/usr/local/bin"
2019-01-12 23:53:00 +08:00
2020-05-28 00:53:52 +08:00
matrix_host_command_docker : "/usr/bin/env docker"
matrix_host_command_sleep : "/usr/bin/env sleep"
matrix_host_command_chown : "/usr/bin/env chown"
matrix_host_command_fusermount : "/usr/bin/env fusermount"
2020-05-28 04:18:24 +08:00
matrix_host_command_openssl : "/usr/bin/env openssl"
2020-05-28 04:52:51 +08:00
matrix_host_command_systemctl : "/usr/bin/env systemctl"
2021-01-27 16:22:46 +08:00
matrix_host_command_sh : "/usr/bin/env sh"
2020-05-28 00:53:52 +08:00
2021-09-14 14:35:20 +08:00
matrix_ntpd_package : "{{ 'systemd-timesyncd' if ansible_distribution == 'CentOS' and ansible_distribution_major_version > '7' else ( 'systemd' if ansible_os_family == 'Suse' else 'ntp' ) }}"
matrix_ntpd_service : "{{ 'systemd-timesyncd' if ( (ansible_distribution == 'CentOS' and ansible_distribution_major_version > '7') or ansible_os_family == 'Suse') else ('ntpd' if ansible_os_family == 'RedHat' or ansible_distribution == 'Archlinux' else 'ntp') }}"
2020-04-05 14:42:52 +08:00
2019-02-28 17:51:09 +08:00
matrix_homeserver_url : "https://{{ matrix_server_fqn_matrix }}"
2019-01-17 00:05:48 +08:00
2021-01-25 19:55:08 +08:00
# Specifies where the homeserver is on the container network.
# Where this is depends on whether there's a reverse-proxy in front of it, etc.
# This likely gets overriden elsewhere.
matrix_homeserver_container_url : "http://matrix-synapse:8008"
2019-01-17 00:05:48 +08:00
matrix_identity_server_url : ~
2019-01-12 23:53:00 +08:00
2019-12-10 12:23:56 +08:00
matrix_integration_manager_rest_url : ~
matrix_integration_manager_ui_url : ~
2020-04-09 14:58:35 +08:00
# The domain name where a Jitsi server is self-hosted.
2020-07-17 16:31:20 +08:00
# If set, `/.well-known/matrix/client` will suggest Element clients to use that Jitsi server.
2020-09-27 00:24:09 +08:00
# See: https://github.com/vector-im/element-web/blob/develop/docs/jitsi.md#configuring-element-to-use-your-self-hosted-jitsi-server
matrix_client_element_jitsi_preferredDomain : ''
2020-04-09 14:58:35 +08:00
2020-07-17 16:31:20 +08:00
# Controls whether Element should use End-to-End Encryption by default.
# Setting this to false will update `/.well-known/matrix/client` and tell Element clients to avoid E2EE.
2020-09-27 00:24:09 +08:00
# See: https://github.com/vector-im/element-web/blob/develop/docs/e2ee.md
matrix_client_element_e2ee_default : true
2020-06-24 16:38:51 +08:00
2020-10-16 06:32:00 +08:00
# Controls whether Element should require a secure backup set up before Element can be used.
# Setting this to true will update `/.well-known/matrix/client` and tell Element require a secure backup.
# See: https://github.com/vector-im/element-web/blob/develop/docs/e2ee.md
2020-10-16 15:24:50 +08:00
matrix_client_element_e2ee_secure_backup_required : false
2020-10-16 06:32:00 +08:00
# Controls which backup methods from ["key", "passphrase"] should be used, both is the default.
# Setting this to other then empty will update `/.well-known/matrix/client` and tell Element which method to use
# See: https://github.com/vector-im/element-web/blob/develop/docs/e2ee.md
2020-10-16 15:24:50 +08:00
matrix_client_element_e2ee_secure_backup_setup_methods : [ ]
2020-10-16 06:32:00 +08:00
2019-01-12 23:53:00 +08:00
# The Docker network that all services would be put into
matrix_docker_network : "matrix"
2020-06-14 15:00:22 +08:00
# Controls whether we'll preserve the vars.yml file on the Matrix server.
# If you have a differently organized inventory, you may wish to disable this feature,
# or to repoint `matrix_vars_yml_snapshotting_src` to the file you'd like to preserve.
matrix_vars_yml_snapshotting_enabled : true
matrix_vars_yml_snapshotting_src : "{{ inventory_dir }}/host_vars/{{ inventory_hostname }}/vars.yml"
2019-02-05 18:08:00 +08:00
# Controls whether a `/.well-known/matrix/server` file is generated and used at all.
#
# If you wish to rely on DNS SRV records only, you can disable this.
2019-02-15 00:40:55 +08:00
# Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
2019-02-28 17:51:09 +08:00
# using certificates for the base domain (`matrix_domain`) and not for the
# matrix domain (`matrix_server_fqn_matrix`).
2019-02-05 18:08:00 +08:00
matrix_well_known_matrix_server_enabled : true
2019-11-19 01:29:14 +08:00
# Controls whether Docker is automatically installed.
2020-08-05 23:35:25 +08:00
# If you change this to false you must install and update Docker manually. You also need to install the docker (https://pypi.org/project/docker/) Python package.
2019-11-19 01:20:01 +08:00
matrix_docker_installation_enabled : true
2019-11-19 01:29:14 +08:00
# Controls the Docker package that is installed.
# Possible values are "docker-ce" (default) and "docker.io" (Debian).
matrix_docker_package_name : docker-ce
2019-01-12 23:53:00 +08:00
# Variables to Control which parts of our roles run.
2019-07-08 13:55:08 +08:00
run_postgres_import : true
run_postgres_upgrade : true
run_postgres_import_sqlite_db : true
2019-07-08 14:38:24 +08:00
run_postgres_vacuum : true
2019-07-08 13:55:08 +08:00
run_synapse_register_user : true
run_synapse_update_user_password : true
run_synapse_import_media_store : true
2020-08-21 18:52:16 +08:00
run_synapse_rust_synapse_compress_state : true
2019-01-12 23:53:00 +08:00
run_setup : true
2019-07-08 13:55:08 +08:00
run_self_check : true
2019-01-12 23:53:00 +08:00
run_start : true
2019-05-20 23:59:58 +08:00
run_stop : true
