Merge branch 'master' into conduit

roles/matrix-base/defaults/main.yml

@@ -8,6 +8,25 @@
 # 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
 #
@@ -37,6 +56,9 @@ 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 }}"
 
@@ -52,6 +74,9 @@ 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.
@@ -71,6 +96,10 @@ matrix_container_global_registry_prefix: "docker.io/"
 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"
 
@@ -105,8 +134,8 @@ 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_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 }}"
 
@@ -128,7 +157,7 @@ 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: ''
+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.
@@ -173,11 +202,11 @@ matrix_well_known_matrix_client_configuration_default: "{{ lookup('template', 't
 #   }
 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 {} }}"
+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) }}"
+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.
@@ -205,11 +234,23 @@ matrix_well_known_matrix_server_configuration_default: "{{ lookup('template', 't
 #   }
 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 {} }}"
+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) }}"
+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"
@@ -228,6 +269,13 @@ matrix_vars_yml_snapshotting_src: "{{ inventory_dir }}/host_vars/{{ inventory_ho
 # 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

roles/matrix-base/tasks/clean_up_old_files.yml

@@ -1,7 +1,7 @@
 ---
 
 - name: Get rid of old files and directories
-  file:
+  ansible.builtin.file:
     path: "{{ item }}"
     state: absent
   with_items:

roles/matrix-base/tasks/main.yml

@@ -1,34 +1,34 @@
 ---
 
-- import_tasks: "{{ role_path }}/tasks/sanity_check.yml"
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/sanity_check.yml"
   tags:
     - always
 
-- import_tasks: "{{ role_path }}/tasks/clean_up_old_files.yml"
-  when: run_setup|bool
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/clean_up_old_files.yml"
+  when: run_setup | bool
   tags:
     - setup-all
 
-- import_tasks: "{{ role_path }}/tasks/server_base/setup.yml"
-  when: run_setup|bool
+- 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.
-- import_tasks: "{{ role_path }}/tasks/setup_matrix_user.yml"
-  when: run_setup|bool
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_matrix_user.yml"
+  when: run_setup | bool
   tags:
     - always
     - setup-system-user
 
-- import_tasks: "{{ role_path }}/tasks/setup_matrix_base.yml"
-  when: run_setup|bool
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_matrix_base.yml"
+  when: run_setup | bool
   tags:
     - setup-all
 
-- import_tasks: "{{ role_path }}/tasks/setup_well_known.yml"
-  when: run_setup|bool
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_well_known.yml"
+  when: run_setup | bool
   tags:
     - setup-all
     - setup-ma1sd

roles/matrix-base/tasks/sanity_check.yml

@@ -1,27 +1,27 @@
 ---
 
 - name: Fail if invalid homeserver implementation
-  fail:
+  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
-  fail:
+  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
-  fail:
+  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
-  fail:
+  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 }}`).
@@ -35,7 +35,7 @@
 
 # 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
-  fail:
+  ansible.builtin.fail:
     msg: |
       The `matrix_homeserver_generic_secret_key` variable must be defined and have a non-null and non-empty value.
 
@@ -47,35 +47,45 @@
   when: "matrix_homeserver_generic_secret_key is none or matrix_homeserver_generic_secret_key == ''"
 
 - name: Fail if required variables are undefined
-  fail:
+  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('') }}"}
+    - {'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
-  fail:
+  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"
+  when: "item != item | lower"
 
 - name: Fail if using python2 on Archlinux
-  fail:
+  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
-  fail:
+  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/matrix-base/tasks/server_base/setup.yml

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

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

@@ -5,12 +5,12 @@
     name:
       - python-docker
       - python-dnspython
-    state: latest
+    state: present
     update_cache: true
 
 - name: Ensure Docker is installed
   pacman:
     name:
       - docker
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool

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

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

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

@@ -1,7 +1,7 @@
 ---
 
 - name: Ensure Docker repository is enabled
-  template:
+  ansible.builtin.template:
     src: "{{ role_path }}/files/yum.repos.d/{{ item }}"
     dest: "/etc/yum.repos.d/docker-ce.repo"
     owner: "root"
@@ -9,31 +9,31 @@
     mode: 0644
   with_items:
     - docker-ce-fedora.repo
-  when: matrix_docker_installation_enabled|bool and matrix_docker_package_name == 'docker-ce'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure Docker's RPM key is trusted
-  rpm_key:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure yum packages are installed
-  yum:
+  ansible.builtin.yum:
     name:
       - "{{ matrix_ntpd_package }}"
-    state: latest
+    state: present
     update_cache: true
 
 - name: Ensure Docker is installed
-  yum:
+  ansible.builtin.yum:
     name:
       - "{{ matrix_docker_package_name }}"
       - python3-pip
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool
 
 - name: Ensure Docker-Py is installed
-  pip:
+  ansible.builtin.pip:
     name: docker-py
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool

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

@@ -1,7 +1,7 @@
 ---
 
 - name: Ensure APT usage dependencies are installed
-  apt:
+  ansible.builtin.apt:
     name:
       - apt-transport-https
       - ca-certificates
@@ -10,32 +10,32 @@
     update_cache: true
 
 - name: Ensure Docker's APT key is trusted
-  apt_key:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure Docker repository is enabled
-  apt_repository:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure APT packages are installed
-  apt:
+  ansible.builtin.apt:
     name:
       - "{{ matrix_ntpd_package }}"
-    state: latest
+    state: present
     update_cache: true
 
 - name: Ensure Docker is installed
-  apt:
+  ansible.builtin.apt:
     name:
       - "{{ matrix_docker_package_name }}"
       - "python{{'3' if ansible_python.version.major == 3 else ''}}-docker"
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool

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

@@ -1,31 +1,31 @@
 ---
 
 - name: Ensure Docker repository is enabled
-  template:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure Docker's RPM key is trusted
-  rpm_key:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure yum packages are installed
-  yum:
+  ansible.builtin.yum:
     name:
       - "{{ matrix_ntpd_package }}"
-    state: latest
+    state: present
     update_cache: true
 
 - name: Ensure Docker is installed
-  yum:
+  ansible.builtin.yum:
     name:
       - "{{ matrix_docker_package_name }}"
       - docker-python
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool

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

@@ -1,44 +1,44 @@
 ---
 
 - name: Ensure Docker repository is enabled
-  template:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure Docker's RPM key is trusted
-  rpm_key:
+  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'
+  when: matrix_docker_installation_enabled | bool and matrix_docker_package_name == 'docker-ce'
 
 - name: Ensure EPEL is installed
-  yum:
+  ansible.builtin.yum:
     name:
       - epel-release
-    state: latest
+    state: present
     update_cache: true
 
 - name: Ensure yum packages are installed
-  yum:
+  ansible.builtin.yum:
     name:
       - "{{ matrix_ntpd_package }}"
-    state: latest
+    state: present
     update_cache: true
 
 - name: Ensure Docker is installed
-  yum:
+  ansible.builtin.yum:
     name:
       - "{{ matrix_docker_package_name }}"
       - python3-pip
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool
 
 - name: Ensure Docker-Py is installed
-  pip:
+  ansible.builtin.pip:
     name: docker-py
-    state: latest
-  when: matrix_docker_installation_enabled|bool
+    state: present
+  when: matrix_docker_installation_enabled | bool

roles/matrix-base/tasks/setup_matrix_base.yml

@@ -1,7 +1,7 @@
 ---
 
 - name: Ensure Matrix base path exists
-  file:
+  ansible.builtin.file:
     path: "{{ item }}"
     state: directory
     mode: "{{ matrix_base_data_path_mode }}"
@@ -11,13 +11,13 @@
     - "{{ matrix_base_data_path }}"
 
 - name: Preserve vars.yml on the server for easily restoring if it gets lost later on
-  copy:
+  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"
+  when: "matrix_vars_yml_snapshotting_enabled | bool"
 
 - name: Ensure Matrix network is created in Docker
   docker_network:
@@ -25,7 +25,7 @@
     driver: bridge
 
 - name: Ensure matrix-remove-all script created
-  template:
+  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/matrix-base/tasks/setup_matrix_user.yml

@@ -1,18 +1,18 @@
 ---
 
 - name: Ensure Matrix group is created
-  group:
+  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
-  set_fact:
+  ansible.builtin.set_fact:
     matrix_user_gid: "{{ matrix_group.gid }}"
 
 - name: Ensure Matrix user is created
-  user:
+  ansible.builtin.user:
     name: "{{ matrix_user_username }}"
     uid: "{{ omit if matrix_user_uid is none else matrix_user_uid }}"
     state: present
@@ -23,5 +23,5 @@
   register: matrix_user
 
 - name: Set Matrix Group UID Variable
-  set_fact:
+  ansible.builtin.set_fact:
     matrix_user_uid: "{{ matrix_user.uid }}"

roles/matrix-base/tasks/setup_well_known.yml

@@ -4,7 +4,7 @@
 #
 # For running with another webserver, we recommend being part of the `matrix` group.
 - name: Ensure Matrix static-files path exists
-  file:
+  ansible.builtin.file:
     path: "{{ item }}"
     state: directory
     mode: 0755
@@ -14,24 +14,39 @@
     - "{{ matrix_static_files_base_path }}/.well-known/matrix"
 
 - name: Ensure Matrix /.well-known/matrix/client file configured
-  copy:
-    content: "{{ matrix_well_known_matrix_client_configuration|to_nice_json }}"
+  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
-  copy:
-    content: "{{ matrix_well_known_matrix_server_configuration|to_nice_json }}"
+  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
+  when: matrix_well_known_matrix_server_enabled | bool
 
 - name: Ensure Matrix /.well-known/matrix/server file deleted
-  file:
+  ansible.builtin.file:
     path: "{{ matrix_static_files_base_path }}/.well-known/matrix/server"
     state: absent
-  when: "not matrix_well_known_matrix_server_enabled|bool"
+  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/matrix-base/tasks/util/ensure_fuse_installed.yml

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

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

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

roles/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 %}
+}