mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-25 18:38:30 +01:00
c73680712b
Reference: https://ansible-lint.readthedocs.io/en/latest/default_rules/#var-naming We don't really fix these, but just suppress them, because they're like that intentionally. We try to name variables in a way that is consistent with the configuration key they control. If the upstream component uses camelCase, we also need to include camelCase in the variable name.
301 lines
16 KiB
YAML
301 lines
16 KiB
YAML
---
|
|
# The bare domain name which represents your Matrix identity.
|
|
# Matrix user ids for your server will be of the form (`@user:<matrix-domain>`).
|
|
#
|
|
# Note: this playbook does not touch the server referenced here.
|
|
# Installation happens on another server ("matrix.<matrix-domain>", see `matrix_server_fqn_matrix`).
|
|
#
|
|
# Example value: example.com
|
|
matrix_domain: ~
|
|
|
|
# The optional matrix admin MXID, used in bridges' configs to set bridge admin user
|
|
# Example value: "@someone:{{ matrix_domain }}"
|
|
matrix_admin: ''
|
|
|
|
# Homeserver admin contacts and support page as per MSC 1929
|
|
# See: https://github.com/matrix-org/matrix-spec-proposals/pull/1929
|
|
# Users in form:
|
|
# matrix_homeserver_admin_contacts:
|
|
# - matrix_id: @admin:domain.tld
|
|
# email_address: admin@domain.tld
|
|
# role: admin
|
|
# - email_address: security@domain.tld
|
|
# role: security
|
|
# Also see: `matrix_well_known_matrix_support_enabled`
|
|
matrix_homeserver_admin_contacts: []
|
|
# Url string like https://domain.tld/support.html
|
|
# Also see: `matrix_well_known_matrix_support_enabled`
|
|
matrix_homeserver_support_url: ''
|
|
|
|
# This will contain the homeserver implementation that is in use.
|
|
# Valid values: synapse, dendrite
|
|
#
|
|
# By default, we use Synapse, because it's the only full-featured Matrix server at the moment.
|
|
#
|
|
# This value automatically influences other variables (`matrix_synapse_enabled`, `matrix_dendrite_enabled`, etc.).
|
|
# The homeserver implementation of an existing server cannot be changed without data loss.
|
|
matrix_homeserver_implementation: synapse
|
|
|
|
# This contains a secret, which is used for generating various other secrets later on.
|
|
matrix_homeserver_generic_secret_key: ''
|
|
|
|
# This is where your data lives and what we set up.
|
|
# This and the Element FQN (see below) are expected to be on the same server.
|
|
matrix_server_fqn_matrix: "matrix.{{ matrix_domain }}"
|
|
|
|
# This is where you access federation API.
|
|
matrix_server_fqn_matrix_federation: '{{ matrix_server_fqn_matrix }}'
|
|
|
|
# This is where you access the Element web UI from (if enabled via matrix_client_element_enabled; enabled by default).
|
|
# This and the Matrix FQN (see above) are expected to be on the same server.
|
|
matrix_server_fqn_element: "element.{{ matrix_domain }}"
|
|
|
|
# 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 }}"
|
|
|
|
# This is where you access the Cinny web client from (if enabled via matrix_client_cinny_enabled; disabled by default).
|
|
matrix_server_fqn_cinny: "cinny.{{ matrix_domain }}"
|
|
|
|
# This is where you access the buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default).
|
|
matrix_server_fqn_buscarron: "buscarron.{{ matrix_domain }}"
|
|
|
|
# This is where you access the Dimension.
|
|
matrix_server_fqn_dimension: "dimension.{{ matrix_domain }}"
|
|
|
|
# For use with Go-NEB! (github callback url for example)
|
|
matrix_server_fqn_bot_go_neb: "goneb.{{ matrix_domain }}"
|
|
|
|
# This is where you access Jitsi.
|
|
matrix_server_fqn_jitsi: "jitsi.{{ matrix_domain }}"
|
|
|
|
# This is where you access Grafana.
|
|
matrix_server_fqn_grafana: "stats.{{ matrix_domain }}"
|
|
|
|
# This is where you access the Sygnal push gateway.
|
|
matrix_server_fqn_sygnal: "sygnal.{{ matrix_domain }}"
|
|
|
|
# This is where you access the ntfy push notification service.
|
|
matrix_server_fqn_ntfy: "ntfy.{{ matrix_domain }}"
|
|
|
|
matrix_federation_public_port: 8448
|
|
|
|
# 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
|
|
|
|
# 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 }}"
|
|
|
|
matrix_container_global_registry_prefix: "docker.io/"
|
|
|
|
# Each docker pull will retry on failed attempt 10 times with delay of 10 seconds between each attempt.
|
|
matrix_container_retries_count: 10
|
|
matrix_container_retries_delay: 10
|
|
|
|
# Each get_url will retry on failed attempt 10 times with delay of 10 seconds between each attempt.
|
|
matrix_geturl_retries_count: 10
|
|
matrix_geturl_retries_delay: 10
|
|
|
|
matrix_user_username: "matrix"
|
|
matrix_user_groupname: "matrix"
|
|
|
|
# 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: ~
|
|
|
|
matrix_base_data_path: "/matrix"
|
|
matrix_base_data_path_mode: "750"
|
|
|
|
matrix_static_files_base_path: "{{ matrix_base_data_path }}/static-files"
|
|
matrix_systemd_path: "/etc/systemd/system"
|
|
|
|
# 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
|
|
|
|
# This is now unused. We keep it so that cleanup tasks can use it.
|
|
# To be removed in the future.
|
|
matrix_cron_path: "/etc/cron.d"
|
|
|
|
matrix_local_bin_path: "/usr/local/bin"
|
|
|
|
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"
|
|
matrix_host_command_openssl: "/usr/bin/env openssl"
|
|
matrix_host_command_systemctl: "/usr/bin/env systemctl"
|
|
matrix_host_command_sh: "/usr/bin/env sh"
|
|
|
|
matrix_ntpd_package: "{{ 'systemd-timesyncd' if (ansible_os_family == 'RedHat' and ansible_distribution_major_version | int > 7) or (ansible_distribution == 'Ubuntu' and ansible_distribution_major_version | int > 18) else ( 'systemd' if ansible_os_family == 'Suse' else 'ntp' ) }}"
|
|
matrix_ntpd_service: "{{ 'systemd-timesyncd' if (ansible_os_family == 'RedHat' and ansible_distribution_major_version | int > 7) or (ansible_distribution == 'Ubuntu' and ansible_distribution_major_version | int > 18) or ansible_distribution == 'Archlinux' or ansible_os_family == 'Suse' else ('ntpd' if ansible_os_family == 'RedHat' else 'ntp') }}"
|
|
|
|
matrix_homeserver_url: "https://{{ matrix_server_fqn_matrix }}"
|
|
|
|
# Specifies where the homeserver's Client-Server API is on the container network.
|
|
# Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc.
|
|
# This likely gets overriden elsewhere.
|
|
matrix_homeserver_container_url: ""
|
|
|
|
# Specifies where the homeserver's Federation API is on the container network.
|
|
# Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc.
|
|
# This likely gets overriden elsewhere.
|
|
matrix_homeserver_container_federation_url: ""
|
|
|
|
matrix_identity_server_url: ~
|
|
|
|
matrix_integration_manager_rest_url: ~
|
|
matrix_integration_manager_ui_url: ~
|
|
|
|
# The domain name where a Jitsi server is self-hosted.
|
|
# If set, `/.well-known/matrix/client` will suggest Element clients to use that Jitsi server.
|
|
# 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: '' # noqa var-naming
|
|
|
|
# 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.
|
|
# See: https://github.com/vector-im/element-web/blob/develop/docs/e2ee.md
|
|
matrix_client_element_e2ee_default: true
|
|
|
|
# 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
|
|
matrix_client_element_e2ee_secure_backup_required: false
|
|
|
|
# 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
|
|
matrix_client_element_e2ee_secure_backup_setup_methods: []
|
|
|
|
# Default `/.well-known/matrix/client` configuration - it covers the generic use case.
|
|
# You can customize it by controlling the various variables inside the template file that it references.
|
|
#
|
|
# For a more advanced customization, you can extend the default (see `matrix_well_known_matrix_client_configuration_extension_json`)
|
|
# or completely replace this variable with your own template.
|
|
#
|
|
# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
|
|
# This is unlike what it does when looking up YAML template files (no automatic parsing there).
|
|
matrix_well_known_matrix_client_configuration_default: "{{ lookup('template', 'templates/static-files/well-known/matrix-client.j2') }}"
|
|
|
|
# Your custom JSON configuration for `/.well-known/matrix/client` should go to `matrix_well_known_matrix_client_configuration_extension_json`.
|
|
# This configuration extends the default starting configuration (`matrix_well_known_matrix_client_configuration_default`).
|
|
#
|
|
# You can override individual variables from the default configuration, or introduce new ones.
|
|
#
|
|
# If you need something more special, you can take full control by
|
|
# completely redefining `matrix_well_known_matrix_client_configuration`.
|
|
#
|
|
# Example configuration extension follows:
|
|
#
|
|
# matrix_well_known_matrix_client_configuration_extension_json: |
|
|
# {
|
|
# "io.element.call_behaviour": {
|
|
# "widget_build_url": "https://dimension.example.com/api/v1/dimension/bigbluebutton/widget_state"
|
|
# }
|
|
# }
|
|
matrix_well_known_matrix_client_configuration_extension_json: '{}'
|
|
|
|
matrix_well_known_matrix_client_configuration_extension: "{{ matrix_well_known_matrix_client_configuration_extension_json | from_json if matrix_well_known_matrix_client_configuration_extension_json | from_json is mapping else {} }}"
|
|
|
|
# Holds the final `/.well-known/matrix/client` configuration (a combination of the default and its extension).
|
|
# You most likely don't need to touch this variable. Instead, see `matrix_well_known_matrix_client_configuration_default` and `matrix_well_known_matrix_client_configuration_extension_json`.
|
|
matrix_well_known_matrix_client_configuration: "{{ matrix_well_known_matrix_client_configuration_default | combine(matrix_well_known_matrix_client_configuration_extension, recursive=True) }}"
|
|
|
|
# Default `/.well-known/matrix/server` configuration - it covers the generic use case.
|
|
# You can customize it by controlling the various variables inside the template file that it references.
|
|
#
|
|
# For a more advanced customization, you can extend the default (see `matrix_well_known_matrix_server_configuration_extension_json`)
|
|
# or completely replace this variable with your own template.
|
|
#
|
|
# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
|
|
# This is unlike what it does when looking up YAML template files (no automatic parsing there).
|
|
matrix_well_known_matrix_server_configuration_default: "{{ lookup('template', 'templates/static-files/well-known/matrix-server.j2') }}"
|
|
|
|
# Your custom JSON configuration for `/.well-known/matrix/server` should go to `matrix_well_known_matrix_server_configuration_extension_json`.
|
|
# This configuration extends the default starting configuration (`matrix_well_known_matrix_server_configuration_default`).
|
|
#
|
|
# You can override individual variables from the default configuration, or introduce new ones.
|
|
#
|
|
# If you need something more special, you can take full control by
|
|
# completely redefining `matrix_well_known_matrix_server_configuration`.
|
|
#
|
|
# Example configuration extension follows:
|
|
#
|
|
# matrix_well_known_matrix_server_configuration_extension_json: |
|
|
# {
|
|
# "something": "another"
|
|
# }
|
|
matrix_well_known_matrix_server_configuration_extension_json: '{}'
|
|
|
|
matrix_well_known_matrix_server_configuration_extension: "{{ matrix_well_known_matrix_server_configuration_extension_json | from_json if matrix_well_known_matrix_server_configuration_extension_json | from_json is mapping else {} }}"
|
|
|
|
# Holds the final `/.well-known/matrix/server` configuration (a combination of the default and its extension).
|
|
# You most likely don't need to touch this variable. Instead, see `matrix_well_known_matrix_server_configuration_default` and `matrix_well_known_matrix_server_configuration_extension_json`.
|
|
matrix_well_known_matrix_server_configuration: "{{ matrix_well_known_matrix_server_configuration_default | combine(matrix_well_known_matrix_server_configuration_extension, recursive=True) }}"
|
|
|
|
# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
|
|
# This is unlike what it does when looking up YAML template files (no automatic parsing there).
|
|
matrix_well_known_matrix_support_configuration_default: "{{ lookup('template', 'templates/static-files/well-known/matrix-support.j2') }}"
|
|
|
|
matrix_well_known_matrix_support_configuration_extension_json: '{}'
|
|
|
|
matrix_well_known_matrix_support_configuration_extension: "{{ matrix_well_known_matrix_support_configuration_extension_json | from_json if matrix_well_known_matrix_support_configuration_extension_json | from_json is mapping else {} }}"
|
|
|
|
# Holds the final `/.well-known/matrix/support` configuration (a combination of the default and its extension).
|
|
# You most likely don't need to touch this variable. Instead, see `matrix_well_known_matrix_support_configuration_default` and `matrix_well_known_matrix_support_configuration_extension_json`.
|
|
matrix_well_known_matrix_support_configuration: "{{ matrix_well_known_matrix_support_configuration_default | combine(matrix_well_known_matrix_support_configuration_extension, recursive=True) }}"
|
|
|
|
# The Docker network that all services would be put into
|
|
matrix_docker_network: "matrix"
|
|
|
|
# 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"
|
|
|
|
# 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.
|
|
# Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
|
|
# using certificates for the base domain (`matrix_domain`) and not for the
|
|
# matrix domain (`matrix_server_fqn_matrix`).
|
|
matrix_well_known_matrix_server_enabled: true
|
|
|
|
# Controls whether a `/.well-known/matrix/support` file is generated and used at all.
|
|
#
|
|
# This is not enabled by default, until the MSC gets accepted: https://github.com/matrix-org/matrix-spec-proposals/pull/1929
|
|
#
|
|
# See `matrix_homeserver_admin_contacts`, `matrix_homeserver_support_url`, etc.
|
|
matrix_well_known_matrix_support_enabled: false
|
|
|
|
# Controls whether Docker is automatically installed.
|
|
# 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.
|
|
matrix_docker_installation_enabled: true
|
|
|
|
# Controls the Docker package that is installed.
|
|
# Possible values are "docker-ce" (default) and "docker.io" (Debian).
|
|
matrix_docker_package_name: docker-ce
|
|
|
|
# Variables to Control which parts of our roles run.
|
|
run_postgres_import: true
|
|
run_postgres_upgrade: true
|
|
run_postgres_import_sqlite_db: true
|
|
run_postgres_vacuum: true
|
|
run_synapse_register_user: true
|
|
run_synapse_update_user_password: true
|
|
run_synapse_import_media_store: true
|
|
run_synapse_rust_synapse_compress_state: true
|
|
run_dendrite_register_user: true
|
|
run_setup: true
|
|
run_self_check: true
|
|
run_start: true
|
|
run_stop: true
|