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.

roles/custom/matrix-base/defaults/main.yml

@@ -0,0 +1,305 @@
+---
+# 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, conduit
+#
+# 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
+
+# Controls whether the current playbook's commit hash is saved in `git_hash.yml` on the target
+# Set this to false if GIT is not installed on the local system (the system where the ansible command is run on)
+# to suppress the warning message.
+matrix_playbook_commit_hash_preservation_enabled: true
+
+# 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

roles/custom/matrix-base/files/yum.repos.d/docker-ce-centos.repo

@@ -0,0 +1,62 @@
+[docker-ce-stable]
+name=Docker CE Stable - $basearch
+baseurl=https://download.docker.com/linux/centos/$releasever/$basearch/stable
+enabled=1
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-stable-debuginfo]
+name=Docker CE Stable - Debuginfo $basearch
+baseurl=https://download.docker.com/linux/centos/$releasever/debug-$basearch/stable
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-stable-source]
+name=Docker CE Stable - Sources
+baseurl=https://download.docker.com/linux/centos/$releasever/source/stable
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-test]
+name=Docker CE Test - $basearch
+baseurl=https://download.docker.com/linux/centos/$releasever/$basearch/test
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-test-debuginfo]
+name=Docker CE Test - Debuginfo $basearch
+baseurl=https://download.docker.com/linux/centos/$releasever/debug-$basearch/test
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-test-source]
+name=Docker CE Test - Sources
+baseurl=https://download.docker.com/linux/centos/$releasever/source/test
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-nightly]
+name=Docker CE Nightly - $basearch
+baseurl=https://download.docker.com/linux/centos/$releasever/$basearch/nightly
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-nightly-debuginfo]
+name=Docker CE Nightly - Debuginfo $basearch
+baseurl=https://download.docker.com/linux/centos/$releasever/debug-$basearch/nightly
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg
+
+[docker-ce-nightly-source]
+name=Docker CE Nightly - Sources
+baseurl=https://download.docker.com/linux/centos/$releasever/source/nightly
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/centos/gpg

roles/custom/matrix-base/files/yum.repos.d/docker-ce-fedora.repo

@@ -0,0 +1,62 @@
+[docker-ce-stable]
+name=Docker CE Stable - $basearch
+baseurl=https://download.docker.com/linux/fedora/$releasever/$basearch/stable
+enabled=1
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-stable-debuginfo]
+name=Docker CE Stable - Debuginfo $basearch
+baseurl=https://download.docker.com/linux/fedora/$releasever/debug-$basearch/stable
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-stable-source]
+name=Docker CE Stable - Sources
+baseurl=https://download.docker.com/linux/fedora/$releasever/source/stable
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-test]
+name=Docker CE Test - $basearch
+baseurl=https://download.docker.com/linux/fedora/$releasever/$basearch/test
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-test-debuginfo]
+name=Docker CE Test - Debuginfo $basearch
+baseurl=https://download.docker.com/linux/fedora/$releasever/debug-$basearch/test
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-test-source]
+name=Docker CE Test - Sources
+baseurl=https://download.docker.com/linux/fedora/$releasever/source/test
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-nightly]
+name=Docker CE Nightly - $basearch
+baseurl=https://download.docker.com/linux/fedora/$releasever/$basearch/nightly
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-nightly-debuginfo]
+name=Docker CE Nightly - Debuginfo $basearch
+baseurl=https://download.docker.com/linux/fedora/$releasever/debug-$basearch/nightly
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg
+
+[docker-ce-nightly-source]
+name=Docker CE Nightly - Sources
+baseurl=https://download.docker.com/linux/fedora/$releasever/source/nightly
+enabled=0
+gpgcheck=1
+gpgkey=https://download.docker.com/linux/fedora/gpg

roles/custom/matrix-base/tasks/clean_up_old_files.yml

@@ -0,0 +1,9 @@
+---
+
+- name: Get rid of old files and directories
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: absent
+  with_items:
+    - "{{ matrix_base_data_path }}/environment-variables"
+    - "{{ matrix_base_data_path }}/scratchpad"

roles/custom/matrix-base/tasks/main.yml

@@ -0,0 +1,37 @@
+---
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/sanity_check.yml"
+  tags:
+    - always
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/clean_up_old_files.yml"
+  when: run_setup | bool
+  tags:
+    - setup-all
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/server_base/setup.yml"
+  when: run_setup | bool
+  tags:
+    - setup-all
+
+# This needs to always run, because it populates `matrix_user_uid` and `matrix_user_gid`,
+# which are required by many other roles.
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_matrix_user.yml"
+  when: run_setup | bool
+  tags:
+    - always
+    - setup-system-user
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_matrix_base.yml"
+  when: run_setup | bool
+  tags:
+    - setup-all
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_well_known.yml"
+  when: run_setup | bool
+  tags:
+    - setup-all
+    - setup-ma1sd
+    - setup-synapse
+    - setup-dendrite
+    - setup-nginx-proxy

roles/custom/matrix-base/tasks/sanity_check.yml

@@ -0,0 +1,91 @@
+---
+
+- name: Fail if invalid homeserver implementation
+  ansible.builtin.fail:
+    msg: "You need to set a valid homeserver implementation in `matrix_homeserver_implementation`"
+  when: "matrix_homeserver_implementation not in ['synapse', 'dendrite', 'conduit']"
+
+# We generally support Ansible 2.7.1 and above.
+- name: Fail if running on Ansible < 2.7.1
+  ansible.builtin.fail:
+    msg: "You are running on Ansible {{ ansible_version.string }}, which is not supported. See our guide about Ansible: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/ansible.md"
+  when:
+    - "(ansible_version.major < 2) or (ansible_version.major == 2 and ansible_version.minor < 7) or (ansible_version.major == 2 and ansible_version.minor == 7 and ansible_version.revision < 1)"
+
+# Though we do not support Ansible 2.9.6 which is buggy
+- name: Fail if running on Ansible 2.9.6 on Ubuntu
+  ansible.builtin.fail:
+    msg: "You are running on Ansible {{ ansible_version.string }}, which is not supported. See our guide about Ansible: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/ansible.md"
+  when:
+    - ansible_distribution == 'Ubuntu'
+    - "ansible_version.major == 2 and ansible_version.minor == 9 and ansible_version.revision == 6"
+
+- name: (Deprecation) Catch and report renamed settings
+  ansible.builtin.fail:
+    msg: >-
+      Your configuration contains a variable, which now has a different name.
+      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
+  when: "item.old in vars"
+  with_items:
+    - {'old': 'host_specific_hostname_identity', 'new': 'matrix_domain'}
+    - {'old': 'hostname_identity', 'new': 'matrix_domain'}
+    - {'old': 'hostname_matrix', 'new': 'matrix_server_fqn_matrix'}
+    - {'old': 'hostname_riot', 'new': 'matrix_server_fqn_element'}
+    - {'old': 'matrix_server_fqn_riot', 'new': 'matrix_server_fqn_element'}
+
+# We have a dedicated check for this variable, because we'd like to have a custom (friendlier) message.
+- name: Fail if matrix_homeserver_generic_secret_key is undefined
+  ansible.builtin.fail:
+    msg: |
+      The `matrix_homeserver_generic_secret_key` variable must be defined and have a non-null and non-empty value.
+
+      If you're observing this error on a new installation, you should ensure that the `matrix_homeserver_generic_secret_key` is defined.
+
+      If you're observing this error on an existing homeserver installation, you can fix it easily and in a backward-compatible way by adding
+      `{% raw %}matrix_homeserver_generic_secret_key: "{{ matrix_synapse_macaroon_secret_key }}"{% endraw %}`
+      to your `vars.yml` file. Using another secret value for the new variable is also possible and shouldn't cause any trouble.
+  when: "matrix_homeserver_generic_secret_key is none or matrix_homeserver_generic_secret_key == ''"
+
+- name: Fail if required variables are undefined
+  ansible.builtin.fail:
+    msg: "The `{{ item.var }}` variable must be defined and have a non-null and non-empty value"
+  with_items:
+    - {'var': matrix_domain, 'value': "{{ matrix_domain | default('') }}"}
+    - {'var': matrix_server_fqn_matrix, 'value': "{{ matrix_server_fqn_matrix | default('') }}"}
+    - {'var': matrix_server_fqn_element, 'value': "{{ matrix_server_fqn_element | default('') }}"}
+    - {'var': matrix_homeserver_container_url, 'value': "{{ matrix_homeserver_container_url | default('') }}"}
+    - {'var': matrix_homeserver_container_federation_url, 'value': "{{ matrix_homeserver_container_federation_url | default('') }}"}
+  when: "item.value is none or item.value == ''"
+
+- name: Fail if uppercase domain used
+  ansible.builtin.fail:
+    msg: "Detected that you're using an uppercase domain name - `{{ item }}`. This will cause trouble. Please use all-lowercase!"
+  with_items:
+    - "{{ matrix_domain }}"
+    - "{{ matrix_server_fqn_matrix }}"
+    - "{{ matrix_server_fqn_element }}"
+  when: "item != item | lower"
+
+- name: Fail if using python2 on Archlinux
+  ansible.builtin.fail:
+    msg: "Detected that you're using python2 when installing onto Archlinux. Archlinux by default only supports python3."
+  when:
+    - ansible_distribution == 'Archlinux'
+    - ansible_python.version.major != 3
+
+- name: Fail if architecture is set incorrectly
+  ansible.builtin.fail:
+    msg: "Detected that variable matrix_architecture {{ matrix_architecture }} appears to be set incorrectly. See docs/alternative-architectures.md. Server appears to be {{ ansible_architecture }}."
+  when: (ansible_architecture == "x86_64" and matrix_architecture != "amd64") or
+        (ansible_architecture == "aarch64" and matrix_architecture != "arm64") or
+        (ansible_architecture.startswith("armv") and matrix_architecture != "arm32")
+
+- name: Fail if encountering usage of removed role (mx-puppet-skype)
+  ansible.builtin.fail:
+    msg: >-
+      Your configuration seems to include a reference to `matrix_mx_puppet_skype_enabled`. Are you trying to install the mx-puppet-skype bridge?
+      The playbook no longer includes a role for installing mx-puppet-skype, because the mx-puppet-bridge is unmaintained and has been reported as broken for a long time.
+      To get rid of this error, remove all `matrix_mx_puppet_*` references from your configuration.
+      To clean up your server from mx-puppet-skype's presence, see this changelog entry: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#mx-puppet-skype-removal.
+      If you still need bridging to Skype, consider switching to the go-skype bridge instead. See `docs/configuring-playbook-bridge-go-skype-bridge.md`.
+  when: "'matrix_mx_puppet_skype_enabled' in vars"

roles/custom/matrix-base/tasks/server_base/setup.yml

@@ -0,0 +1,47 @@
+---
+
+- ansible.builtin.include_tasks: "{{ role_path }}/tasks/server_base/setup_redhat.yml"
+  when: ansible_os_family == 'RedHat' and ansible_distribution_major_version | int < 8
+
+- ansible.builtin.include_tasks: "{{ role_path }}/tasks/server_base/setup_redhat8.yml"
+  when: ansible_os_family == 'RedHat' and ansible_distribution_major_version | int > 7 and ansible_distribution_major_version | int < 30
+
+- ansible.builtin.include_tasks: "{{ role_path }}/tasks/server_base/setup_fedora.yml"
+  when: ansible_os_family == 'RedHat' and ansible_distribution_major_version | int > 30
+
+- when: ansible_os_family == 'Debian'
+  block:
+  # ansible_lsb is only available if lsb-release is installed.
+  - name: Ensure lsb-release installed
+    ansible.builtin.apt:
+      name:
+        - lsb-release
+      state: present
+      update_cache: true
+    register: lsb_release_installation_result
+
+  - name: Reread ansible_lsb facts if lsb-release got installed
+    ansible.builtin.setup:
+      filter: ansible_lsb*
+    when: lsb_release_installation_result.changed
+
+  - ansible.builtin.include_tasks: "{{ role_path }}/tasks/server_base/setup_debian.yml"
+    when: (ansible_os_family == 'Debian') and (ansible_lsb.id != 'Raspbian')
+
+  - ansible.builtin.include_tasks: "{{ role_path }}/tasks/server_base/setup_raspbian.yml"
+    when: (ansible_os_family == 'Debian') and (ansible_lsb.id == 'Raspbian')
+
+- ansible.builtin.include_tasks: "{{ role_path }}/tasks/server_base/setup_archlinux.yml"
+  when: ansible_distribution == 'Archlinux'
+
+- name: Ensure Docker is started and autoruns
+  ansible.builtin.service:
+    name: docker
+    state: started
+    enabled: true
+
+- name: "Ensure ntpd is started and autoruns"
+  ansible.builtin.service:
+    name: "{{ matrix_ntpd_service }}"
+    state: started
+    enabled: true

roles/custom/matrix-base/tasks/server_base/setup_archlinux.yml

@@ -0,0 +1,16 @@
+---
+
+- name: Install host dependencies
+  community.general.pacman:
+    name:
+      - python-docker
+      - python-dnspython
+    state: present
+    update_cache: true
+
+- name: Ensure Docker is installed
+  community.general.pacman:
+    name:
+      - docker
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/custom/matrix-base/tasks/server_base/setup_debian.yml

@@ -0,0 +1,41 @@
+---
+
+- name: Ensure APT usage dependencies are installed
+  ansible.builtin.apt:
+    name:
+      - apt-transport-https
+      - ca-certificates
+      - gnupg
+    state: present
+    update_cache: true
+
+- name: Ensure Docker's APT key is trusted
+  ansible.builtin.apt_key:
+    url: "https://download.docker.com/linux/{{ ansible_distribution | lower }}/gpg"
+    id: 9DC858229FC7DD38854AE2D88D81803C0EBFCD88
+    state: present
+  register: add_repository_key
+  ignore_errors: true
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure Docker repository is enabled
+  ansible.builtin.apt_repository:
+    repo: "deb [arch={{ matrix_debian_arch }}] https://download.docker.com/linux/{{ ansible_distribution | lower }} {{ ansible_distribution_release }} stable"
+    state: present
+    update_cache: true
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure APT packages are installed
+  ansible.builtin.apt:
+    name:
+      - "{{ matrix_ntpd_package }}"
+    state: present
+    update_cache: true
+
+- name: Ensure Docker is installed
+  ansible.builtin.apt:
+    name:
+      - "{{ matrix_docker_package_name }}"
+      - "python{{ '3' if ansible_python.version.major == 3 else '' }}-docker"
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/custom/matrix-base/tasks/server_base/setup_fedora.yml

@@ -0,0 +1,39 @@
+---
+
+- name: Ensure Docker repository is enabled
+  ansible.builtin.template:
+    src: "{{ role_path }}/files/yum.repos.d/{{ item }}"
+    dest: "/etc/yum.repos.d/docker-ce.repo"
+    owner: "root"
+    group: "root"
+    mode: 0644
+  with_items:
+    - docker-ce-fedora.repo
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure Docker's RPM key is trusted
+  ansible.builtin.rpm_key:
+    state: present
+    key: https://download.docker.com/linux/fedora/gpg
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure yum packages are installed
+  ansible.builtin.yum:
+    name:
+      - "{{ matrix_ntpd_package }}"
+    state: present
+    update_cache: true
+
+- name: Ensure Docker is installed
+  ansible.builtin.yum:
+    name:
+      - "{{ matrix_docker_package_name }}"
+      - python3-pip
+    state: present
+  when: matrix_docker_installation_enabled | bool
+
+- name: Ensure Docker-Py is installed
+  ansible.builtin.pip:
+    name: docker-py
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/custom/matrix-base/tasks/server_base/setup_raspbian.yml

@@ -0,0 +1,41 @@
+---
+
+- name: Ensure APT usage dependencies are installed
+  ansible.builtin.apt:
+    name:
+      - apt-transport-https
+      - ca-certificates
+      - gnupg
+    state: present
+    update_cache: true
+
+- name: Ensure Docker's APT key is trusted
+  ansible.builtin.apt_key:
+    url: https://download.docker.com/linux/raspbian/gpg
+    id: 9DC858229FC7DD38854AE2D88D81803C0EBFCD88
+    state: present
+  register: add_repository_key
+  ignore_errors: true
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure Docker repository is enabled
+  ansible.builtin.apt_repository:
+    repo: "deb [arch={{ matrix_debian_arch }}] https://download.docker.com/linux/raspbian {{ ansible_distribution_release }} stable"
+    state: present
+    update_cache: true
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure APT packages are installed
+  ansible.builtin.apt:
+    name:
+      - "{{ matrix_ntpd_package }}"
+    state: present
+    update_cache: true
+
+- name: Ensure Docker is installed
+  ansible.builtin.apt:
+    name:
+      - "{{ matrix_docker_package_name }}"
+      - "python{{ '3' if ansible_python.version.major == 3 else '' }}-docker"
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/custom/matrix-base/tasks/server_base/setup_redhat.yml

@@ -0,0 +1,31 @@
+---
+
+- name: Ensure Docker repository is enabled
+  ansible.builtin.template:
+    src: "{{ role_path }}/files/yum.repos.d/docker-ce-centos.repo"
+    dest: "/etc/yum.repos.d/docker-ce.repo"
+    owner: "root"
+    group: "root"
+    mode: 0644
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure Docker's RPM key is trusted
+  ansible.builtin.rpm_key:
+    state: present
+    key: https://download.docker.com/linux/centos/gpg
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure yum packages are installed
+  ansible.builtin.yum:
+    name:
+      - "{{ matrix_ntpd_package }}"
+    state: present
+    update_cache: true
+
+- name: Ensure Docker is installed
+  ansible.builtin.yum:
+    name:
+      - "{{ matrix_docker_package_name }}"
+      - docker-python
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/custom/matrix-base/tasks/server_base/setup_redhat8.yml

@@ -0,0 +1,44 @@
+---
+
+- name: Ensure Docker repository is enabled
+  ansible.builtin.template:
+    src: "{{ role_path }}/files/yum.repos.d/docker-ce-centos.repo"
+    dest: "/etc/yum.repos.d/docker-ce.repo"
+    owner: "root"
+    group: "root"
+    mode: 0644
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure Docker's RPM key is trusted
+  ansible.builtin.rpm_key:
+    state: present
+    key: https://download.docker.com/linux/centos/gpg
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
+
+- name: Ensure EPEL is installed
+  ansible.builtin.yum:
+    name:
+      - epel-release
+    state: present
+    update_cache: true
+
+- name: Ensure yum packages are installed
+  ansible.builtin.yum:
+    name:
+      - "{{ matrix_ntpd_package }}"
+    state: present
+    update_cache: true
+
+- name: Ensure Docker is installed
+  ansible.builtin.yum:
+    name:
+      - "{{ matrix_docker_package_name }}"
+      - python3-pip
+    state: present
+  when: matrix_docker_installation_enabled | bool
+
+- name: Ensure Docker-Py is installed
+  ansible.builtin.pip:
+    name: docker-py
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/custom/matrix-base/tasks/setup_matrix_base.yml

@@ -0,0 +1,77 @@
+---
+
+- name: Ensure Matrix base path exists
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: directory
+    mode: "{{ matrix_base_data_path_mode }}"
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - "{{ matrix_base_data_path }}"
+
+- name: Preserve vars.yml on the server for easily restoring if it gets lost later on
+  ansible.builtin.copy:
+    src: "{{ matrix_vars_yml_snapshotting_src }}"
+    dest: "{{ matrix_base_data_path }}/vars.yml"
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+    mode: '0660'
+  when: "matrix_vars_yml_snapshotting_enabled | bool"
+
+- name: Save current git-repo status on the target to aid with restoring in case of problems
+  when: "matrix_playbook_commit_hash_preservation_enabled|bool"
+  block:
+    - name: Get local git hash  # noqa command-instead-of-module
+      delegate_to: 127.0.0.1
+      become: false
+      register: git_describe
+      changed_when: false
+      ansible.builtin.shell:
+        git describe
+            --always
+            --tags
+            --dirty
+            --long
+            --all
+
+    - ansible.builtin.set_fact:
+        git_hash: "{{ git_describe.stdout }}"
+
+    - name: Git hash
+      ansible.builtin.debug:
+        msg: "Git hash: {{ git_hash }}"
+
+    - name: Save git_hash.yml on target
+      ansible.builtin.copy:
+        content: "{{ git_hash }}"
+        dest: "{{ matrix_base_data_path }}/git_hash.yml"
+        owner: "{{ matrix_user_username }}"
+        group: "{{ matrix_user_groupname }}"
+        mode: '0660'
+
+  rescue:
+    - name: GIT not found error
+      ansible.builtin.debug:
+        msg: >-
+          Couldn't find GIT on the local machine. Continuing without saving the GIT hash.
+          You can disable saving the GIT hash by setting 'matrix_playbook_commit_hash_preservation_enabled: false' in vars.yml
+      when: "git_describe.stderr.find('git: not found') != -1"
+
+    - name: Get GIT hash error
+      ansible.builtin.fail:
+        msg: >-
+          Error when trying to get the GIT hash. Please consult the error message above.
+          You can disable saving the GIT hash by setting 'matrix_playbook_commit_hash_preservation_enabled: false' in vars.yml
+      when: "git_describe.stderr.find('git: not found') == -1"
+
+- name: Ensure Matrix network is created in Docker
+  community.docker.docker_network:
+    name: "{{ matrix_docker_network }}"
+    driver: bridge
+
+- name: Ensure matrix-remove-all script created
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/usr-local-bin/matrix-remove-all.j2"
+    dest: "{{ matrix_local_bin_path }}/matrix-remove-all"
+    mode: 0750

roles/custom/matrix-base/tasks/setup_matrix_user.yml

@@ -0,0 +1,27 @@
+---
+
+- name: Ensure Matrix group is created
+  ansible.builtin.group:
+    name: "{{ matrix_user_groupname }}"
+    gid: "{{ omit if matrix_user_gid is none else matrix_user_gid }}"
+    state: present
+  register: matrix_group
+
+- name: Set Matrix Group GID Variable
+  ansible.builtin.set_fact:
+    matrix_user_gid: "{{ matrix_group.gid }}"
+
+- name: Ensure Matrix user is created
+  ansible.builtin.user:
+    name: "{{ matrix_user_username }}"
+    uid: "{{ omit if matrix_user_uid is none else matrix_user_uid }}"
+    state: present
+    group: "{{ matrix_user_groupname }}"
+    home: "{{ matrix_base_data_path }}"
+    create_home: false
+    system: true
+  register: matrix_user
+
+- name: Set Matrix Group UID Variable
+  ansible.builtin.set_fact:
+    matrix_user_uid: "{{ matrix_user.uid }}"

roles/custom/matrix-base/tasks/setup_well_known.yml

@@ -0,0 +1,52 @@
+---
+# We need others to be able to read these directories too,
+# so that matrix-nginx-proxy's nginx user can access the files.
+#
+# For running with another webserver, we recommend being part of the `matrix` group.
+- name: Ensure Matrix static-files path exists
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: directory
+    mode: 0755
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - "{{ matrix_static_files_base_path }}/.well-known/matrix"
+
+- name: Ensure Matrix /.well-known/matrix/client file configured
+  ansible.builtin.copy:
+    content: "{{ matrix_well_known_matrix_client_configuration | to_nice_json }}"
+    dest: "{{ matrix_static_files_base_path }}/.well-known/matrix/client"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure Matrix /.well-known/matrix/server file configured
+  ansible.builtin.copy:
+    content: "{{ matrix_well_known_matrix_server_configuration | to_nice_json }}"
+    dest: "{{ matrix_static_files_base_path }}/.well-known/matrix/server"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  when: matrix_well_known_matrix_server_enabled | bool
+
+- name: Ensure Matrix /.well-known/matrix/server file deleted
+  ansible.builtin.file:
+    path: "{{ matrix_static_files_base_path }}/.well-known/matrix/server"
+    state: absent
+  when: "not matrix_well_known_matrix_server_enabled | bool"
+
+- name: Ensure Matrix /.well-known/matrix/support file configured
+  ansible.builtin.copy:
+    content: "{{ matrix_well_known_matrix_support_configuration | to_nice_json }}"
+    dest: "{{ matrix_static_files_base_path }}/.well-known/matrix/support"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  when: matrix_well_known_matrix_support_enabled | bool
+
+- name: Ensure Matrix /.well-known/matrix/support file deleted
+  ansible.builtin.file:
+    path: "{{ matrix_static_files_base_path }}/.well-known/matrix/support"
+    state: absent
+  when: "not matrix_well_known_matrix_support_enabled | bool"

roles/custom/matrix-base/tasks/util/ensure_fuse_installed.yml

@@ -0,0 +1,23 @@
+---
+# This is for both RedHat 7 and 8
+- name: Ensure fuse installed (RedHat)
+  ansible.builtin.yum:
+    name:
+      - fuse
+    state: present
+  when: ansible_os_family == 'RedHat'
+
+# This is for both Debian and Raspbian
+- name: Ensure fuse installed (Debian/Raspbian)
+  ansible.builtin.apt:
+    name:
+      - fuse
+    state: present
+  when: ansible_os_family == 'Debian'
+
+- name: Ensure fuse installed (Archlinux)
+  community.general.pacman:
+    name:
+      - fuse3
+    state: present
+  when: ansible_distribution == 'Archlinux'

roles/custom/matrix-base/tasks/util/ensure_openssl_installed.yml

@@ -0,0 +1,23 @@
+---
+# This is for both RedHat 7 and 8
+- name: Ensure openssl installed (RedHat)
+  ansible.builtin.yum:
+    name:
+      - openssl
+    state: present
+  when: ansible_os_family == 'RedHat'
+
+# This is for both Debian and Raspbian
+- name: Ensure openssl installed (Debian/Raspbian)
+  ansible.builtin.apt:
+    name:
+      - openssl
+    state: present
+  when: ansible_os_family == 'Debian'
+
+- name: Ensure openssl installed (Archlinux)
+  community.general.pacman:
+    name:
+      - openssl
+    state: present
+  when: ansible_distribution == 'Archlinux'

roles/custom/matrix-base/templates/static-files/well-known/matrix-client.j2

@@ -0,0 +1,38 @@
+#jinja2: lstrip_blocks: "True"
+{
+	"m.homeserver": {
+		"base_url": "{{ matrix_homeserver_url }}"
+	}
+	{% if matrix_identity_server_url %},
+	"m.identity_server": {
+		"base_url": "{{ matrix_identity_server_url }}"
+	}
+	{% endif %}
+	{% if matrix_integration_manager_rest_url and matrix_integration_manager_ui_url %},
+	"m.integrations": {
+		"managers": [
+			{
+				"api_url": "{{ matrix_integration_manager_rest_url }}",
+				"ui_url": "{{ matrix_integration_manager_ui_url }}"
+			}
+		]
+	}
+	{% endif %}
+	{% if matrix_client_element_jitsi_preferredDomain %},
+	"io.element.jitsi": {
+		"preferredDomain": {{ matrix_client_element_jitsi_preferredDomain|to_json }}
+	},
+	"im.vector.riot.jitsi": {
+		"preferredDomain": {{ matrix_client_element_jitsi_preferredDomain|to_json }}
+	}
+	{% endif %}
+	,
+	"io.element.e2ee": {
+		"default": {{ matrix_client_element_e2ee_default|to_json }},
+		"secure_backup_required": {{ matrix_client_element_e2ee_secure_backup_required|to_json }},
+		"secure_backup_setup_methods": {{ matrix_client_element_e2ee_secure_backup_setup_methods|to_json }}
+	},
+	"im.vector.riot.e2ee": {
+		"default": {{ matrix_client_element_e2ee_default|to_json }}
+	}
+}

roles/custom/matrix-base/templates/static-files/well-known/matrix-server.j2

@@ -0,0 +1,4 @@
+#jinja2: lstrip_blocks: "True"
+{
+	"m.server": "{{ matrix_server_fqn_matrix_federation }}:{{ matrix_federation_public_port }}"
+}

roles/custom/matrix-base/templates/static-files/well-known/matrix-support.j2

@@ -0,0 +1,7 @@
+#jinja2: lstrip_blocks: "True"
+{
+    "admins": {{ matrix_homeserver_admin_contacts|to_json }}
+    {% if matrix_homeserver_support_url %},
+        "support_page": {{ matrix_homeserver_support_url|to_json }}
+    {% endif %}
+}

roles/custom/matrix-base/templates/usr-local-bin/matrix-remove-all.j2

@@ -0,0 +1,36 @@
+#jinja2: lstrip_blocks: "True"
+#!/bin/bash
+
+if [ "$(id -u)" != "0" ]; then
+	echo "This script must be executed as root! Aborting."
+	exit 1
+fi
+
+echo "WARNING! You are about to remove everything the playbook installs for {{ matrix_server_fqn_matrix }}: matrix, docker images,..."
+echo -n "If you're sure you want to do this, type: 'Yes, I really want to remove everything!'"
+read sure
+
+if [ "$sure" != "Yes, I really want to remove everything!" ]; then
+	echo "Good thing I asked, exiting"
+	exit 0
+else
+	echo "Stop and remove matrix services"
+
+	for s in $(find {{ matrix_systemd_path }}/ -type f -name "matrix-*" -printf "%f\n"); do
+		systemctl disable --now $s
+		rm -f {{ matrix_systemd_path }}/$s
+	done
+
+	systemctl daemon-reload
+
+	echo "Remove matrix scripts"
+	find {{ matrix_local_bin_path }}/ -name "matrix-*" -delete
+	echo "Remove unused Docker images and resources"
+	docker system prune -af
+	echo "Remove Docker matrix network (should be gone already, but ..)"
+	docker network rm {{ matrix_docker_network }}
+	echo "Remove {{ matrix_base_data_path }} directory"
+	rm -fr "{{ matrix_base_data_path }}"
+	exit 0
+fi
+

roles/custom/matrix-base/vars/main.yml

@@ -0,0 +1,7 @@
+---
+# This will contain a list of enabled services that the playbook is managing.
+# Each component is expected to append its service name to this list.
+matrix_systemd_services_list: []
+
+matrix_homeserver_container_runtime_injected_arguments: []
+matrix_homeserver_app_service_runtime_injected_config_files: []