Merge remote-tracking branch 'origin/master' into hookshot

roles/matrix-awx/tasks/main.yml

@@ -8,9 +8,9 @@
   tags:
     - always
 
-# Renames the variables if needed
+# Renames or updates the vars.yml if needed
 - include_tasks: 
-    file: "rename_variables.yml"
+    file: "update_variables.yml"
     apply:
       tags: always
   when: run_setup|bool and matrix_awx_enabled|bool

roles/matrix-awx/tasks/rename_variables.yml

@@ -1,8 +0,0 @@
----
-
-- name: Rename synapse presence variable
-  delegate_to: 127.0.0.1
-  replace:
-    path: "/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/matrix_vars.yml"
-    regexp: 'matrix_synapse_use_presence'
-    replace: 'matrix_synapse_presence_enabled'

roles/matrix-awx/tasks/update_variables.yml

@@ -0,0 +1,26 @@
+---
+
+- name: Rename synapse presence variable
+  delegate_to: 127.0.0.1
+  replace:
+    path: "/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/matrix_vars.yml"
+    regexp: 'matrix_synapse_use_presence'
+    replace: 'matrix_synapse_presence_enabled'
+
+- name: Generate matrix_homeserver_generic_secret_key variable
+  delegate_to: 127.0.0.1
+  command: |
+      openssl rand -hex 16
+  register: generic_secret
+  no_log: True
+  when: ( matrix_homeserver_generic_secret_key is undefined ) or ( matrix_homeserver_generic_secret_key | length == 0 )
+
+- name: Add new matrix_homeserver_generic_secret_key variable
+  delegate_to: 127.0.0.1
+  lineinfile:
+    path: '/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/matrix_vars.yml'
+    line: "matrix_homeserver_generic_secret_key: {{ generic_secret.stdout }}"
+    insertbefore: '# Basic Settings End'
+    mode: '0600'
+    state: present    
+  when: ( matrix_homeserver_generic_secret_key is undefined ) or ( matrix_homeserver_generic_secret_key | length == 0 )

roles/matrix-base/defaults/main.yml

@@ -7,6 +7,18 @@
 # Example value: example.com
 matrix_domain: ~
 
+# 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 }}"
@@ -21,6 +33,9 @@ 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 Dimension.
 matrix_server_fqn_dimension: "dimension.{{ matrix_domain }}"
 
@@ -88,11 +103,16 @@ matrix_ntpd_service: "{{ 'systemd-timesyncd' if (ansible_distribution == 'CentOS
 
 matrix_homeserver_url: "https://{{ matrix_server_fqn_matrix }}"
 
-# Specifies where the homeserver is on the container network.
-# Where this is depends on whether there's a reverse-proxy in front of it, etc.
+# 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: ~
@@ -218,6 +238,7 @@ 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

roles/matrix-base/tasks/main.yml

@@ -31,4 +31,5 @@
     - setup-all
     - setup-ma1sd
     - setup-synapse
+    - setup-dendrite
     - setup-nginx-proxy

roles/matrix-base/tasks/sanity_check.yml

@@ -1,5 +1,10 @@
 ---
 
+- name: Fail if invalid homeserver implementation
+  fail:
+    msg: "You need to set a valid homeserver implementation in `matrix_homeserver_implementation`"
+  when: "matrix_homeserver_implementation not in ['synapse', 'dendrite']"
+
 # We generally support Ansible 2.7.1 and above.
 - name: Fail if running on Ansible < 2.7.1
   fail:
@@ -28,14 +33,29 @@
     - {'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
+  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
   fail:
-    msg: "The `{{ item }}` variable must be defined and have a non-null value"
+    msg: "The `{{ item.var }}` variable must be defined and have a non-null and non-empty value"
   with_items:
-    - matrix_domain
-    - matrix_server_fqn_matrix
-    - matrix_server_fqn_element
-  when: "item not in vars or vars[item] is none"
+    - {'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:

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

@@ -4,8 +4,6 @@
   pacman:
     name:
       - python-docker
-      # TODO This needs to be verified. Which version do we need?
-      - fuse3
       - python-dnspython
     state: latest
     update_cache: yes

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

@@ -21,7 +21,6 @@
   yum:
     name:
       - "{{ matrix_ntpd_package }}"
-      - fuse
     state: latest
     update_cache: yes
 

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

@@ -28,7 +28,6 @@
   yum:
     name:
       - "{{ matrix_ntpd_package }}"
-      - fuse
     state: latest
     update_cache: yes
 
@@ -44,4 +43,4 @@
   pip:
     name: docker-py
     state: latest
-  when: matrix_docker_installation_enabled|bool
+  when: matrix_docker_installation_enabled|bool

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

@@ -29,7 +29,6 @@
   apt:
     name:
       - "{{ matrix_ntpd_package }}"
-      - fuse
     state: latest
     update_cache: yes
 

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

@@ -29,7 +29,6 @@
   apt:
     name:
       - "{{ matrix_ntpd_package }}"
-      - fuse
     state: latest
     update_cache: yes
 

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

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

roles/matrix-base/tasks/validate_config.yml

@@ -1,9 +0,0 @@
----
-
-- name: Fail if required Matrix Base settings not defined
-  fail:
-    msg: >-
-      You need to define a required configuration setting (`{{ item }}`) for using this playbook.
-  when: "vars[item] == ''"
-  with_items:
-    - "matrix_homeserver_container_url"

roles/matrix-base/vars/main.yml

@@ -1,3 +1,3 @@
 # 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_systemd_services_list: []

roles/matrix-bot-go-neb/templates/systemd/matrix-bot-go-neb.service.j2

@@ -39,8 +39,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-go-neb \
 			{{ matrix_bot_go_neb_docker_image }} \
 			-c "go-neb /config/config.yaml"
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-bot-go-neb

roles/matrix-bot-honoroit/defaults/main.yml

@@ -0,0 +1,103 @@
+# honoroit is a helpdesk bot
+# See: https://gitlab.com/etke.cc/honoroit
+
+matrix_bot_honoroit_enabled: true
+
+matrix_bot_honoroit_container_image_self_build: false
+matrix_bot_honoroit_docker_repo: "https://gitlab.com/etke.cc/honoroit.git"
+matrix_bot_honoroit_docker_src_files_path: "{{ matrix_base_data_path }}/honoroit/docker-src"
+
+matrix_bot_honoroit_version: v0.9.1
+matrix_bot_honoroit_docker_image: "{{ matrix_bot_honoroit_docker_image_name_prefix }}honoroit:{{ matrix_bot_honoroit_version }}"
+matrix_bot_honoroit_docker_image_name_prefix: "{{ 'localhost/' if matrix_bot_honoroit_container_image_self_build else 'registry.gitlab.com/etke.cc/' }}"
+matrix_bot_honoroit_docker_image_force_pull: "{{ matrix_bot_honoroit_docker_image.endswith(':latest') }}"
+
+matrix_bot_honoroit_base_path: "{{ matrix_base_data_path }}/honoroit"
+matrix_bot_honoroit_config_path: "{{ matrix_bot_honoroit_base_path }}/config"
+matrix_bot_honoroit_data_path: "{{ matrix_bot_honoroit_base_path }}/data"
+matrix_bot_honoroit_data_store_path: "{{ matrix_bot_honoroit_data_path }}/store"
+
+# A list of extra arguments to pass to the container
+matrix_bot_honoroit_container_extra_arguments: []
+
+# List of systemd services that matrix-bot-honoroit.service depends on
+matrix_bot_honoroit_systemd_required_services_list: ['docker.service']
+
+# List of systemd services that matrix-bot-honoroit.service wants
+matrix_bot_honoroit_systemd_wanted_services_list: []
+
+
+# Database-related configuration fields.
+#
+# To use SQLite, stick to these defaults.
+#
+# To use Postgres:
+# - change the engine (`matrix_bot_honoroit_database_engine: 'postgres'`)
+# - adjust your database credentials via the `matrix_bot_honoroit_database_*` variables
+matrix_bot_honoroit_database_engine: 'sqlite'
+
+matrix_bot_honoroit_sqlite_database_path_local: "{{ matrix_bot_honoroit_data_path }}/bot.db"
+matrix_bot_honoroit_sqlite_database_path_in_container: "/data/bot.db"
+
+matrix_bot_honoroit_database_username: 'honoroit'
+matrix_bot_honoroit_database_password: 'some-password'
+matrix_bot_honoroit_database_hostname: 'matrix-postgres'
+matrix_bot_honoroit_database_port: 5432
+matrix_bot_honoroit_database_name: 'honoroit'
+
+matrix_bot_honoroit_database_connection_string: 'postgres://{{ matrix_bot_honoroit_database_username }}:{{ matrix_bot_honoroit_database_password }}@{{ matrix_bot_honoroit_database_hostname }}:{{ matrix_bot_honoroit_database_port }}/{{ matrix_bot_honoroit_database_name }}?sslmode=disable'
+
+matrix_bot_honoroit_storage_database: "{{
+	{
+		'sqlite': matrix_bot_honoroit_sqlite_database_path_in_container,
+		'postgres': matrix_bot_honoroit_database_connection_string,
+	}[matrix_bot_honoroit_database_engine]
+}}"
+
+matrix_bot_honoroit_database_dialect: "{{
+  {
+    'sqlite': 'sqlite3',
+    'postgres': 'postgres',
+  }[matrix_bot_honoroit_database_engine]
+}}"
+
+
+# The bot's username. This user needs to be created manually beforehand.
+# Also see `matrix_bot_honoroit_password`.
+matrix_bot_honoroit_login: "honoroit"
+
+# The password that the bot uses to authenticate.
+matrix_bot_honoroit_password: ''
+
+matrix_bot_honoroit_homeserver: "{{ matrix_homeserver_container_url }}"
+
+# The room ID where bot will create threads
+matrix_bot_honoroit_roomid: ''
+
+# Command prefix
+matrix_bot_honoroit_prefix: ''
+
+# Sentry DSN
+matrix_bot_honoroit_sentry: ''
+
+# Log level
+matrix_bot_honoroit_loglevel: ''
+
+# Text: greetings
+matrix_bot_honoroit_text_greetings: ''
+
+# Text: error
+matrix_bot_honoroit_text_error: ''
+
+# Text: empty room
+matrix_bot_honoroit_text_emptyroom: ''
+
+# Text: done
+matrix_bot_honoroit_text_done: ''
+
+# Additional environment variables to pass to the Honoroit container
+#
+# Example:
+# matrix_bot_honoroit_environment_variables_extension: |
+#   HONOROIT_TEXT_DONE=Done
+matrix_bot_honoroit_environment_variables_extension: ''

roles/matrix-bot-honoroit/tasks/init.yml

@@ -0,0 +1,3 @@
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-bot-honoroit.service'] }}"
+  when: matrix_bot_honoroit_enabled|bool

roles/matrix-bot-honoroit/tasks/main.yml

@@ -0,0 +1,21 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup|bool and matrix_bot_honoroit_enabled|bool"
+  tags:
+    - setup-all
+    - setup-bot-honoroit
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_bot_honoroit_enabled|bool"
+  tags:
+    - setup-all
+    - setup-bot-honoroit
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_bot_honoroit_enabled|bool"
+  tags:
+    - setup-all
+    - setup-bot-honoroit

roles/matrix-bot-honoroit/tasks/setup_install.yml

@@ -0,0 +1,92 @@
+---
+- set_fact:
+    matrix_bot_honoroit_requires_restart: false
+
+- block:
+    - name: Check if an SQLite database already exists
+      stat:
+        path: "{{ matrix_bot_honoroit_sqlite_database_path_local }}"
+      register: matrix_bot_honoroit_sqlite_database_path_local_stat_result
+
+    - block:
+        - set_fact:
+            matrix_postgres_db_migration_request:
+              src: "{{ matrix_bot_honoroit_sqlite_database_path_local }}"
+              dst: "{{ matrix_bot_honoroit_database_connection_string }}"
+              caller: "{{ role_path|basename }}"
+              engine_variable_name: 'matrix_bot_honoroit_database_engine'
+              engine_old: 'sqlite'
+              systemd_services_to_stop: ['matrix-bot-honoroit.service']
+
+        - import_tasks: "{{ role_path }}/../matrix-postgres/tasks/util/migrate_db_to_postgres.yml"
+
+        - set_fact:
+            matrix_bot_honoroit_requires_restart: true
+      when: "matrix_bot_honoroit_sqlite_database_path_local_stat_result.stat.exists|bool"
+  when: "matrix_bot_honoroit_database_engine == 'postgres'"
+
+- name: Ensure honoroit paths exist
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_bot_honoroit_config_path }}", when: true }
+    - { path: "{{ matrix_bot_honoroit_data_path }}", when: true }
+    - { path: "{{ matrix_bot_honoroit_data_store_path }}", when: true }
+    - { path: "{{ matrix_bot_honoroit_docker_src_files_path }}", when: true}
+  when: "item.when|bool"
+
+- name: Ensure honoroit environment variables file created
+  template:
+    src: "{{ role_path }}/templates/env.j2"
+    dest: "{{ matrix_bot_honoroit_config_path }}/env"
+    mode: 0640
+
+- name: Ensure honoroit image is pulled
+  docker_image:
+    name: "{{ matrix_bot_honoroit_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_bot_honoroit_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_honoroit_docker_image_force_pull }}"
+  when: "not matrix_bot_honoroit_container_image_self_build|bool"
+
+- name: Ensure honoroit repository is present on self-build
+  git:
+    repo: "{{ matrix_bot_honoroit_docker_repo }}"
+    dest: "{{ matrix_bot_honoroit_docker_src_files_path }}"
+    force: "yes"
+  register: matrix_bot_honoroit_git_pull_results
+  when: "matrix_bot_honoroit_container_image_self_build|bool"
+
+- name: Ensure honoroit image is built
+  docker_image:
+    name: "{{ matrix_bot_honoroit_docker_image }}"
+    source: build
+    force_source: "{{ matrix_bot_honoroit_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mailer_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_bot_honoroit_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_bot_honoroit_container_image_self_build|bool"
+
+- name: Ensure matrix-bot-honoroit.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-bot-honoroit.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-bot-honoroit.service"
+    mode: 0644
+  register: matrix_bot_honoroit_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-bot-honoroit.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_bot_honoroit_systemd_service_result.changed|bool"
+
+- name: Ensure matrix-bot-honoroit.service restarted, if necessary
+  service:
+    name: "matrix-bot-honoroit.service"
+    state: restarted
+  when: "matrix_bot_honoroit_requires_restart|bool"

roles/matrix-bot-honoroit/tasks/setup_uninstall.yml

@@ -0,0 +1,36 @@
+---
+
+- name: Check existence of matrix-honoroit service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-bot-honoroit.service"
+  register: matrix_bot_honoroit_service_stat
+
+- name: Ensure matrix-honoroit is stopped
+  service:
+    name: matrix-bot-honoroit
+    state: stopped
+    enabled: no
+    daemon_reload: yes
+  register: stopping_result
+  when: "matrix_bot_honoroit_service_stat.stat.exists|bool"
+
+- name: Ensure matrix-bot-honoroit.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-bot-honoroit.service"
+    state: absent
+  when: "matrix_bot_honoroit_service_stat.stat.exists|bool"
+
+- name: Ensure systemd reloaded after matrix-bot-honoroit.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_bot_honoroit_service_stat.stat.exists|bool"
+
+- name: Ensure Matrix honoroit paths don't exist
+  file:
+    path: "{{ matrix_bot_honoroit_base_path }}"
+    state: absent
+
+- name: Ensure honoroit Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_bot_honoroit_docker_image }}"
+    state: absent

roles/matrix-bot-honoroit/tasks/validate_config.yml

@@ -0,0 +1,10 @@
+---
+
+- name: Fail if required settings not defined
+  fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`).
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_bot_honoroit_password"
+    - "matrix_bot_honoroit_roomid"

roles/matrix-bot-honoroit/templates/env.j2

@@ -0,0 +1,15 @@
+HONOROIT_LOGIN={{ matrix_bot_honoroit_login }}
+HONOROIT_PASSWORD={{ matrix_bot_honoroit_password }}
+HONOROIT_HOMESERVER={{ matrix_bot_honoroit_homeserver }}
+HONOROIT_ROOMID={{ matrix_bot_honoroit_roomid }}
+HONOROIT_DB_DSN={{ matrix_bot_honoroit_database_connection_string }}
+HONOROIT_DB_DIALECT={{ matrix_bot_honoroit_database_dialect }}
+HONOROIT_PREFIX={{ matrix_bot_honoroit_prefix }}
+HONOROIT_SENTRY={{ matrix_bot_honoroit_sentry }}
+HONOROIT_LOGLEVEL={{ matrix_bot_honoroit_loglevel }}
+HONOROIT_TEXT_GREETINGS={{ matrix_bot_honoroit_text_greetings }}
+HONOROIT_TEXT_ERROR={{ matrix_bot_honoroit_text_error }}
+HONOROIT_TEXT_EMPTYROOM={{ matrix_bot_honoroit_text_emptyroom }}
+HONOROIT_TEXT_DONE={{ matrix_bot_honoroit_text_done }}
+
+{{ matrix_bot_honoroit_environment_variables_extension }}

roles/matrix-bot-honoroit/templates/systemd/matrix-bot-honoroit.service.j2

@@ -0,0 +1,39 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=Matrix helpdesk bot
+{% for service in matrix_bot_honoroit_systemd_required_services_list %}
+Requires={{ service }}
+After={{ service }}
+{% endfor %}
+{% for service in matrix_bot_honoroit_systemd_wanted_services_list %}
+Wants={{ service }}
+{% endfor %}
+DefaultDependencies=no
+
+[Service]
+Type=simple
+Environment="HOME={{ matrix_systemd_unit_home_path }}"
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-honoroit 2>/dev/null'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-honoroit 2>/dev/null'
+
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-honoroit \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--read-only \
+			--network={{ matrix_docker_network }} \
+			--env-file={{ matrix_bot_honoroit_config_path }}/env \
+			--mount type=bind,src={{ matrix_bot_honoroit_data_path }},dst=/data \
+			{% for arg in matrix_bot_honoroit_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_bot_honoroit_docker_image }}
+
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-honoroit 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-honoroit 2>/dev/null'
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-bot-honoroit
+
+[Install]
+WantedBy=multi-user.target

roles/matrix-bot-matrix-reminder-bot/defaults/main.yml

@@ -3,7 +3,7 @@
 
 matrix_bot_matrix_reminder_bot_enabled: true
 
-matrix_bot_matrix_reminder_bot_container_self_build: false
+matrix_bot_matrix_reminder_bot_container_image_self_build: false
 matrix_bot_matrix_reminder_bot_docker_repo: "https://github.com/anoadragon453/matrix-reminder-bot.git"
 matrix_bot_matrix_reminder_bot_docker_src_files_path: "{{ matrix_base_data_path }}/matrix-reminder-bot/docker-src"
 

roles/matrix-bot-matrix-reminder-bot/tasks/setup_install.yml

@@ -46,7 +46,7 @@
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
     force_source: "{{ matrix_bot_matrix_reminder_bot_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
     force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_matrix_reminder_bot_docker_image_force_pull }}"
-  when: "not matrix_bot_matrix_reminder_bot_container_self_build|bool"
+  when: "not matrix_bot_matrix_reminder_bot_container_image_self_build|bool"
 
 - name: Ensure matrix-reminder-bot repository is present on self-build
   git:
@@ -54,7 +54,7 @@
     dest: "{{ matrix_bot_matrix_reminder_bot_docker_src_files_path }}"
     force: "yes"
   register: matrix_bot_matrix_reminder_bot_git_pull_results
-  when: "matrix_bot_matrix_reminder_bot_container_self_build|bool"
+  when: "matrix_bot_matrix_reminder_bot_container_image_self_build|bool"
 
 - name: Ensure matrix-reminder-bot image is built
   docker_image:
@@ -66,7 +66,7 @@
       dockerfile: docker/Dockerfile
       path: "{{ matrix_bot_matrix_reminder_bot_docker_src_files_path }}"
       pull: yes
-  when: "matrix_bot_matrix_reminder_bot_container_self_build|bool"
+  when: "matrix_bot_matrix_reminder_bot_container_image_self_build|bool"
 
 - name: Ensure matrix-reminder-bot config installed
   copy:

roles/matrix-bot-matrix-reminder-bot/tasks/validate_config.yml

@@ -8,3 +8,12 @@
   with_items:
     - "matrix_bot_matrix_reminder_bot_matrix_user_password"
     - "matrix_bot_matrix_reminder_bot_reminders_timezone"
+
+- name: (Deprecation) Catch and report renamed settings
+  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': 'matrix_bot_matrix_reminder_bot_container_self_build', 'new': 'matrix_bot_matrix_reminder_bot_container_image_self_build'}

roles/matrix-bot-matrix-reminder-bot/templates/systemd/matrix-bot-matrix-reminder-bot.service.j2

@@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-matrix-rem
 			{{ matrix_bot_matrix_reminder_bot_docker_image }} \
 			-c "matrix-reminder-bot /config/config.yaml"
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-matrix-reminder-bot 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-matrix-reminder-bot 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-matrix-reminder-bot 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-matrix-reminder-bot 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-bot-matrix-reminder-bot

roles/matrix-bot-mjolnir/templates/systemd/matrix-bot-mjolnir.service.j2

@@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-mjolnir \
 			{% endfor %}
 			{{ matrix_bot_mjolnir_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-mjolnir 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-mjolnir 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-mjolnir 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-mjolnir 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-bot-mjolnir

roles/matrix-bridge-appservice-discord/templates/systemd/matrix-appservice-discord.service.j2

@@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-dis
 			{{ matrix_appservice_discord_docker_image }} \
 			node /build/src/discordas.js -p 9005 -c /cfg/config.yaml -f /cfg/registration.yaml
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-discord 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-discord 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-discord 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-discord 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-appservice-discord

roles/matrix-bridge-appservice-irc/defaults/main.yml

@@ -3,7 +3,7 @@
 
 matrix_appservice_irc_enabled: true
 
-matrix_appservice_irc_container_self_build: false
+matrix_appservice_irc_container_image_self_build: false
 matrix_appservice_irc_docker_repo: "https://github.com/matrix-org/matrix-appservice-irc.git"
 matrix_appservice_irc_docker_src_files_path: "{{ matrix_base_data_path }}/appservice-irc/docker-src"
 

roles/matrix-bridge-appservice-irc/tasks/init.yml

@@ -3,7 +3,7 @@
 - name: Fail if trying to self-build on Ansible < 2.8
   fail:
     msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
-  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_irc_container_self_build and matrix_appservice_irc_enabled"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_irc_container_image_self_build and matrix_appservice_irc_enabled"
 
 # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
 # We don't want to fail in such cases.

roles/matrix-bridge-appservice-irc/tasks/setup_install.yml

@@ -11,7 +11,7 @@
     - { path: "{{ matrix_appservice_irc_base_path }}", when: true }
     - { path: "{{ matrix_appservice_irc_config_path }}", when: true }
     - { path: "{{ matrix_appservice_irc_data_path }}", when: true }
-    - { path: "{{ matrix_appservice_irc_docker_src_files_path }}", when: "{{ matrix_appservice_irc_container_self_build }}" }
+    - { path: "{{ matrix_appservice_irc_docker_src_files_path }}", when: "{{ matrix_appservice_irc_container_image_self_build }}" }
   when: item.when|bool
 
 - name: Check if an old passkey file already exists
@@ -61,7 +61,7 @@
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
     force_source: "{{ matrix_appservice_irc_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
     force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_appservice_irc_docker_image_force_pull }}"
-  when: "matrix_appservice_irc_enabled|bool and not matrix_appservice_irc_container_self_build|bool"
+  when: "matrix_appservice_irc_enabled|bool and not matrix_appservice_irc_container_image_self_build|bool"
 
 - name: Ensure matrix-appservice-irc repository is present when self-building
   git:
@@ -69,7 +69,7 @@
     dest: "{{ matrix_appservice_irc_docker_src_files_path }}"
     force: "yes"
   register: matrix_appservice_irc_git_pull_results
-  when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_self_build|bool"
+  when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_image_self_build|bool"
 
 - name: Ensure matrix-appservice-irc Docker image is built
   docker_image:
@@ -81,7 +81,7 @@
       dockerfile: Dockerfile
       path: "{{ matrix_appservice_irc_docker_src_files_path }}"
       pull: yes
-  when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_self_build|bool and matrix_appservice_irc_git_pull_results.changed"
+  when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_image_self_build|bool and matrix_appservice_irc_git_pull_results.changed"
 
 - name: Ensure Matrix Appservice IRC config installed
   copy:

roles/matrix-bridge-appservice-irc/tasks/validate_config.yml

@@ -33,3 +33,4 @@
   when: "item.old in vars"
   with_items:
     - {'old': 'matrix_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_appservice_irc_container_http_host_bind_port>'}
+    - {'old': 'matrix_appservice_irc_container_self_build', 'new': 'matrix_appservice_irc_container_image_self_build'}

roles/matrix-bridge-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2

@@ -36,8 +36,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-irc
 			{{ matrix_appservice_irc_docker_image }} \
 			-c 'node app.js -c /config/config.yaml -f /config/registration.yaml -p 9999'
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-irc 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-irc 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-irc 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-irc 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-appservice-irc

roles/matrix-bridge-appservice-slack/defaults/main.yml

@@ -3,7 +3,7 @@
 
 matrix_appservice_slack_enabled: true
 
-matrix_appservice_slack_container_self_build: false
+matrix_appservice_slack_container_image_self_build: false
 matrix_appservice_slack_docker_repo: "https://github.com/matrix-org/matrix-appservice-slack.git"
 matrix_appservice_slack_docker_src_files_path: "{{ matrix_base_data_path }}/appservice-slack/docker-src"
 

roles/matrix-bridge-appservice-slack/tasks/init.yml

@@ -3,7 +3,7 @@
 - name: Fail if trying to self-build on Ansible < 2.8
   fail:
     msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
-  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_slack_container_self_build and matrix_appservice_slack_enabled"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_slack_container_image_self_build and matrix_appservice_slack_enabled"
 
 # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
 # We don't want to fail in such cases.
@@ -44,7 +44,7 @@
       msg: >-
         Trying to append Slack Appservice's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-slack role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-appservice-slack/tasks/setup_install.yml

@@ -11,7 +11,7 @@
     - { path: "{{ matrix_appservice_slack_base_path }}", when: true }
     - { path: "{{ matrix_appservice_slack_config_path }}", when: true }
     - { path: "{{ matrix_appservice_slack_data_path }}", when: true }
-    - { path: "{{ matrix_appservice_slack_docker_src_files_path }}", when: "{{ matrix_appservice_slack_container_self_build }}" }
+    - { path: "{{ matrix_appservice_slack_docker_src_files_path }}", when: "{{ matrix_appservice_slack_container_image_self_build }}" }
   when: item.when|bool
 
 - set_fact:
@@ -37,7 +37,7 @@
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
     force_source: "{{ matrix_appservice_slack_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
     force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_appservice_slack_docker_image_force_pull }}"
-  when: "not matrix_appservice_slack_container_self_build|bool"
+  when: "not matrix_appservice_slack_container_image_self_build|bool"
 
 - name: Ensure matrix-appservice-slack repository is present when self-building
   git:
@@ -45,7 +45,7 @@
     dest: "{{ matrix_appservice_slack_docker_src_files_path }}"
     force: "yes"
   register: matrix_appservice_slack_git_pull_results
-  when: "matrix_appservice_slack_container_self_build|bool"
+  when: "matrix_appservice_slack_container_image_self_build|bool"
 
 - name: Ensure matrix-appservice-slack Docker image is built
   docker_image:
@@ -57,7 +57,7 @@
       dockerfile: Dockerfile
       path: "{{ matrix_appservice_slack_docker_src_files_path }}"
       pull: yes
-  when: "matrix_appservice_slack_container_self_build|bool and matrix_appservice_slack_git_pull_results.changed"
+  when: "matrix_appservice_slack_container_image_self_build|bool and matrix_appservice_slack_git_pull_results.changed"
 
 - name: Ensure Matrix Appservice Slack config installed
   copy:

roles/matrix-bridge-appservice-slack/tasks/validate_config.yml

@@ -11,3 +11,12 @@
     - "matrix_appservice_slack_homeserver_url"
     - "matrix_appservice_slack_homeserver_token"
     - "matrix_appservice_slack_id_token"
+
+- name: (Deprecation) Catch and report renamed settings
+  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': 'matrix_appservice_slack_container_self_build', 'new': 'matrix_appservice_slack_container_image_self_build'}

roles/matrix-bridge-appservice-slack/templates/systemd/matrix-appservice-slack.service.j2

@@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-sla
 			{{ matrix_appservice_slack_docker_image }} \
 			node app.js -p {{matrix_appservice_slack_matrix_port}} -c /config/config.yaml -f /config/slack-registration.yaml
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-slack 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-slack 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-slack 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-slack 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-appservice-slack

roles/matrix-bridge-appservice-webhooks/defaults/main.yml

@@ -8,7 +8,7 @@ matrix_appservice_webhooks_container_image_self_build_repo: "https://github.com/
 matrix_appservice_webhooks_container_image_self_build_repo_version: "{{ 'master' if matrix_appservice_webhooks_version == 'latest' else matrix_appservice_webhooks_version }}"
 matrix_appservice_webhooks_container_image_self_build_repo_dockerfile_path: "Dockerfile"
 
-matrix_appservice_webhooks_version: latest
+matrix_appservice_webhooks_version: v1.0.2-01
 matrix_appservice_webhooks_docker_image: "{{ matrix_appservice_webhooks_docker_image_name_prefix }}redoonetworks/matrix-appservice-webhooks:{{ matrix_appservice_webhooks_version }}"
 matrix_appservice_webhooks_docker_image_name_prefix: "{{ 'localhost/' if matrix_appservice_webhooks_container_image_self_build else matrix_container_global_registry_prefix }}"
 matrix_appservice_webhooks_docker_image_force_pull: "{{ matrix_appservice_webhooks_docker_image.endswith(':latest') }}"

roles/matrix-bridge-appservice-webhooks/tasks/init.yml

@@ -37,7 +37,7 @@
       msg: >-
         Trying to append webhooks Appservice's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-webhooks role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-appservice-webhooks/templates/systemd/matrix-appservice-webhooks.service.j2

@@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-web
 			{{ matrix_appservice_webhooks_docker_image }} \
 			node index.js -p {{ matrix_appservice_webhooks_matrix_port }} -c /config/config.yaml -f /config/webhooks-registration.yaml
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-webhooks 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-webhooks 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-webhooks 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-webhooks 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-appservice-webhooks

roles/matrix-bridge-beeper-linkedin/templates/systemd/matrix-beeper-linkedin.service.j2

@@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-beeper-linkedi
 			{{ matrix_beeper_linkedin_docker_image }} \
                         python3 -m linkedin_matrix -c /data/config.yaml -r /data/registration.yaml
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-beeper-linkedin 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-beeper-linkedin 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-beeper-linkedin 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-beeper-linkedin 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-beeper-linkedin

roles/matrix-bridge-heisenbridge/templates/systemd/matrix-heisenbridge.service.j2

@@ -41,8 +41,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-heisenbridge \
           --listen-port 9898 \
           {{ matrix_heisenbridge_homeserver_url }}
 
-ExecStop=-{{ matrix_host_command_docker }} kill matrix-heisenbridge
-ExecStop=-{{ matrix_host_command_docker }} rm matrix-heisenbridge
+ExecStopPost=-{{ matrix_host_command_docker }} kill matrix-heisenbridge
+ExecStopPost=-{{ matrix_host_command_docker }} rm matrix-heisenbridge
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-heisenbridge

roles/matrix-bridge-mautrix-facebook/templates/systemd/matrix-mautrix-facebook.service.j2

@@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-facebo
 			{{ matrix_mautrix_facebook_docker_image }} \
 			python3 -m mautrix_facebook -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-facebook 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-facebook 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-facebook

roles/matrix-bridge-mautrix-googlechat/tasks/init.yml

@@ -28,7 +28,7 @@
       msg: >-
         Trying to append Mautrix googlechat's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-googlechat role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-mautrix-googlechat/templates/systemd/matrix-mautrix-googlechat.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-google
 			{{ matrix_mautrix_googlechat_docker_image }} \
 			python3 -m mautrix_googlechat -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-googlechat 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-googlechat 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-googlechat 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-googlechat 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-googlechat

roles/matrix-bridge-mautrix-hangouts/tasks/init.yml

@@ -28,7 +28,7 @@
       msg: >-
         Trying to append Mautrix Hangouts's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-hangouts role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-mautrix-hangouts/templates/systemd/matrix-mautrix-hangouts.service.j2

@@ -44,8 +44,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-hangou
 			{{ matrix_mautrix_hangouts_docker_image }} \
 			python3 -m mautrix_hangouts -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-hangouts 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-hangouts 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-hangouts 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-hangouts 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-hangouts

roles/matrix-bridge-mautrix-instagram/templates/systemd/matrix-mautrix-instagram.service.j2

@@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-instag
 			{{ matrix_mautrix_instagram_docker_image }} \
 			python3 -m mautrix_instagram -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-instagram 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-instagram 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-instagram 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-instagram 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-instagram

roles/matrix-bridge-mautrix-signal/defaults/main.yml

@@ -3,7 +3,7 @@
 
 matrix_mautrix_signal_enabled: true
 
-matrix_mautrix_signal_container_self_build: false
+matrix_mautrix_signal_container_image_self_build: false
 matrix_mautrix_signal_docker_repo: "https://mau.dev/mautrix/signal.git"
 matrix_mautrix_signal_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-signal/docker-src"
 
@@ -13,7 +13,7 @@ matrix_mautrix_signal_daemon_version: latest
 matrix_mautrix_signal_docker_image: "dock.mau.dev/mautrix/signal:{{ matrix_mautrix_signal_version }}"
 matrix_mautrix_signal_docker_image_force_pull: "{{ matrix_mautrix_signal_docker_image.endswith(':latest') }}"
 
-matrix_mautrix_signal_daemon_container_self_build: false
+matrix_mautrix_signal_daemon_container_image_self_build: false
 matrix_mautrix_signal_daemon_docker_repo: "https://mau.dev/maunium/signald.git"
 matrix_mautrix_signal_daemon_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-signald/docker-src"
 

roles/matrix-bridge-mautrix-signal/tasks/setup_install.yml

@@ -14,7 +14,7 @@
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
     force_source: "{{ matrix_mautrix_signal_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
     force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_docker_image_force_pull }}"
-  when: "not matrix_mautrix_signal_container_self_build|bool"
+  when: "not matrix_mautrix_signal_container_image_self_build|bool"
 
 
 - name: Ensure Mautrix Signal repository is present on self-build
@@ -23,19 +23,19 @@
     dest: "{{ matrix_mautrix_signal_docker_src_files_path }}"
     force: "yes"
   register: matrix_mautrix_signal_git_pull_results
-  when: "matrix_mautrix_signal_container_self_build|bool"
+  when: "matrix_mautrix_signal_container_image_self_build|bool"
 
 - name: Ensure Mautrix Signal image is built
   docker_image:
     name: "{{ matrix_mautrix_signal_docker_image }}"
     source: build
     force_source: "{{ matrix_mautrix_signal_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
-    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mailer_git_pull_results.changed }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_git_pull_results.changed }}"
     build:
       dockerfile: Dockerfile
       path: "{{ matrix_mautrix_signal_docker_src_files_path }}"
       pull: yes
-  when: "matrix_mautrix_signal_container_self_build|bool"
+  when: "matrix_mautrix_signal_container_image_self_build|bool"
 
 
 - name: Ensure Mautrix Signal Daemon image is pulled
@@ -44,7 +44,7 @@
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
     force_source: "{{ matrix_mautrix_signal_daemon_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
     force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_daemon_docker_image_force_pull }}"
-  when: matrix_mautrix_signal_enabled and not matrix_mautrix_signal_daemon_container_self_build|bool
+  when: matrix_mautrix_signal_enabled and not matrix_mautrix_signal_daemon_container_image_self_build|bool
   register: matrix_mautrix_signal_daemon_pull_results
 
 - name: Ensure Mautrix Signal Daemon repository is present on self-build
@@ -53,19 +53,19 @@
     dest: "{{ matrix_mautrix_signal_daemon_docker_src_files_path }}"
     force: "yes"
   register: matrix_mautrix_signal_daemon_git_pull_results
-  when: "matrix_mautrix_signal_daemon_container_self_build|bool"
+  when: "matrix_mautrix_signal_daemon_container_image_self_build|bool"
 
 - name: Ensure Mautrix Signal Daemon image is built
   docker_image:
     name: "{{ matrix_mautrix_signal_daemon_docker_image }}"
     source: build
     force_source: "{{ matrix_mautrix_signal_daemon_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
-    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mailer_git_pull_results.changed }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_daemon_git_pull_results.changed }}"
     build:
       dockerfile: Dockerfile
       path: "{{ matrix_mautrix_signal_daemon_docker_src_files_path }}"
       pull: yes
-  when: "matrix_mautrix_signal_daemon_container_self_build|bool"
+  when: "matrix_mautrix_signal_daemon_container_image_self_build|bool"
 
 - name: Ensure Mautrix Signal paths exist
   file:

roles/matrix-bridge-mautrix-signal/tasks/validate_config.yml

@@ -26,3 +26,5 @@
     - {'old': 'matrix_mautrix_signal_db_port', 'new': 'matrix_mautrix_signal_database_port'}
     - {'old': 'matrix_mautrix_signal_db_url', 'new': 'matrix_mautrix_signal_database_connection_string'}
     - {'old': 'matrix_mautrix_signal_configuration_permissions', 'new': '<superseded by matrix_mautrix_signal_configuration_extension_yaml>'}
+    - {'old': 'matrix_mautrix_signal_container_self_build', 'new': 'matrix_mautrix_signal_container_image_self_build'}
+    - {'old': 'matrix_mautrix_signal_daemon_container_self_build', 'new': 'matrix_mautrix_signal_daemon_container_image_self_build'}

roles/matrix-bridge-mautrix-signal/templates/systemd/matrix-mautrix-signal-daemon.service.j2

@@ -30,8 +30,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal
 			-v {{ matrix_mautrix_signal_daemon_path }}:/signald:z \
 			{{ matrix_mautrix_signal_daemon_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal-daemon 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal-daemon 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal-daemon 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal-daemon 2>/dev/null'
 
 Restart=always
 RestartSec=30

roles/matrix-bridge-mautrix-signal/templates/systemd/matrix-mautrix-signal.service.j2

@@ -37,8 +37,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal
 			{{ matrix_mautrix_signal_docker_image }} \
 			python3 -m mautrix_signal -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal 2>/dev/null'
 
 Restart=always
 RestartSec=30

roles/matrix-bridge-mautrix-telegram/defaults/main.yml

@@ -3,13 +3,13 @@
 
 matrix_mautrix_telegram_enabled: true
 
-matrix_telegram_lottieconverter_container_self_build: false
-matrix_telegram_lottieconverter_container_self_build_mask_arch: false
+matrix_telegram_lottieconverter_container_image_self_build: false
+matrix_telegram_lottieconverter_container_image_self_build_mask_arch: false
 matrix_telegram_lottieconverter_docker_repo: "https://mau.dev/tulir/lottieconverter.git"
 matrix_telegram_lottieconverter_docker_src_files_path: "{{ matrix_base_data_path }}/lotticonverter/docker-src"
 matrix_telegram_lottieconverter_docker_image: "dock.mau.dev/tulir/lottieconverter:alpine-3.14" # needs to be ajusted according to FROM clause of Dockerfile of mautrix-telegram
 
-matrix_mautrix_telegram_container_self_build: false
+matrix_mautrix_telegram_container_image_self_build: false
 matrix_mautrix_telegram_docker_repo: "https://mau.dev/mautrix/telegram.git"
 matrix_mautrix_telegram_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-telegram/docker-src"
 

roles/matrix-bridge-mautrix-telegram/tasks/init.yml

@@ -3,7 +3,7 @@
 - name: Fail if trying to self-build on Ansible < 2.8
   fail:
     msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
-  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mautrix_telegram_container_self_build and matrix_mautrix_telegram_enabled"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mautrix_telegram_container_image_self_build and matrix_mautrix_telegram_enabled"
 
 - set_fact:
     matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-telegram.service'] }}"
@@ -28,7 +28,7 @@
       msg: >-
         Trying to append Mautrix Telegram's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-telegram role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-mautrix-telegram/tasks/setup_install.yml

@@ -45,7 +45,7 @@
     - { path: "{{ matrix_mautrix_telegram_base_path }}", when: true }
     - { path: "{{ matrix_mautrix_telegram_config_path }}", when: true }
     - { path: "{{ matrix_mautrix_telegram_data_path }}", when: true }
-    - { path: "{{ matrix_mautrix_telegram_docker_src_files_path }}", when: "{{ matrix_mautrix_telegram_container_self_build }}" }
+    - { path: "{{ matrix_mautrix_telegram_docker_src_files_path }}", when: "{{ matrix_mautrix_telegram_container_image_self_build }}" }
   when: item.when|bool
 
 - name: Ensure Mautrix Telegram image is pulled
@@ -54,7 +54,7 @@
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
     force_source: "{{ matrix_mautrix_telegram_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
     force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_telegram_docker_image_force_pull }}"
-  when: "not matrix_mautrix_telegram_container_self_build|bool"
+  when: "not matrix_mautrix_telegram_container_image_self_build|bool"
 
 - name: Ensure lottieconverter is present when self-building
   git:
@@ -62,7 +62,7 @@
     dest: "{{ matrix_telegram_lottieconverter_docker_src_files_path }}"
     force: "yes"
   register: matrix_telegram_lottieconverter_git_pull_results
-  when: "matrix_telegram_lottieconverter_container_self_build|bool and matrix_mautrix_telegram_container_self_build|bool"
+  when: "matrix_telegram_lottieconverter_container_image_self_build|bool and matrix_mautrix_telegram_container_image_self_build|bool"
 
 - name: Ensure lottieconverter Docker image is built
   docker_image:
@@ -74,7 +74,7 @@
       dockerfile: Dockerfile
       path: "{{ matrix_telegram_lottieconverter_docker_src_files_path }}"
       pull: yes
-  when: "matrix_telegram_lottieconverter_container_self_build|bool and matrix_telegram_lottieconverter_git_pull_results.changed and matrix_mautrix_telegram_container_self_build|bool"
+  when: "matrix_telegram_lottieconverter_container_image_self_build|bool and matrix_telegram_lottieconverter_git_pull_results.changed and matrix_mautrix_telegram_container_image_self_build|bool"
 
 - name: Ensure matrix-mautrix-telegram repository is present when self-building
   git:
@@ -82,7 +82,7 @@
     dest: "{{ matrix_mautrix_telegram_docker_src_files_path }}"
     force: "yes"
   register: matrix_mautrix_telegram_git_pull_results
-  when: "matrix_mautrix_telegram_container_self_build|bool"
+  when: "matrix_mautrix_telegram_container_image_self_build|bool"
 
 - name: Ensure matrix-mautrix-telegram Docker image is built
   docker_image:
@@ -93,10 +93,10 @@
     build:
       dockerfile: Dockerfile
       path: "{{ matrix_mautrix_telegram_docker_src_files_path }}"
-      pull: "{{ not matrix_telegram_lottieconverter_container_self_build_mask_arch|bool }}"
+      pull: "{{ not matrix_telegram_lottieconverter_container_image_self_build_mask_arch|bool }}"
       args:
         TARGETARCH: ""
-  when: "matrix_mautrix_telegram_container_self_build|bool and matrix_mautrix_telegram_git_pull_results.changed"
+  when: "matrix_mautrix_telegram_container_image_self_build|bool and matrix_mautrix_telegram_git_pull_results.changed"
 
 - name: Check if an old database file already exists
   stat:

roles/matrix-bridge-mautrix-telegram/tasks/validate_config.yml

@@ -20,3 +20,6 @@
   when: "item.old in vars"
   with_items:
     - {'old': 'matrix_mautrix_telegram_container_exposed_port_number', 'new': '<superseded by matrix_mautrix_telegram_container_http_host_bind_port>'}
+    - {'old': 'matrix_mautrix_telegram_container_self_build', 'new': 'matrix_mautrix_telegram_container_image_self_build'}
+    - {'old': 'matrix_telegram_lottieconverter_container_self_build', 'new': 'matrix_mautrix_telegram_container_image_self_build'}
+    - {'old': 'matrix_telegram_lottieconverter_container_self_build_mask_arch', 'new': 'matrix_telegram_lottieconverter_container_image_self_build_mask_arch'}

roles/matrix-bridge-mautrix-telegram/templates/systemd/matrix-mautrix-telegram.service.j2

@@ -44,8 +44,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-telegr
 			{{ matrix_mautrix_telegram_docker_image }} \
 			python3 -m mautrix_telegram -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-telegram 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-telegram 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-telegram 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-telegram 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-telegram

roles/matrix-bridge-mautrix-twitter/defaults/main.yml

@@ -1,10 +1,10 @@
 # mautrix-twitter is a Matrix <-> Twitter bridge
-# See: https://github.com/tulir/mautrix-twitter
+# See: https://github.com/mautrix/twitter
 
 matrix_mautrix_twitter_enabled: true
 
 matrix_mautrix_twitter_container_image_self_build: false
-matrix_mautrix_twitter_container_image_self_build_repo: "https://github.com/tulir/mautrix-twitter.git"
+matrix_mautrix_twitter_container_image_self_build_repo: "https://github.com/mautrix/twitter.git"
 
 matrix_mautrix_twitter_version: latest
 # See: https://mau.dev/tulir/mautrix-twitter/container_registry

roles/matrix-bridge-mautrix-twitter/templates/systemd/matrix-mautrix-twitter.service.j2

@@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-twitte
 			{{ matrix_mautrix_twitter_docker_image }} \
 			python3 -m mautrix_twitter -c /config/config.yaml --no-update
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-twitter 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-twitter 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-twitter 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-twitter 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-twitter

roles/matrix-bridge-mautrix-whatsapp/templates/systemd/matrix-mautrix-whatsapp.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-whatsa
 			{{ matrix_mautrix_whatsapp_docker_image }} \
 			/usr/bin/mautrix-whatsapp -c /config/config.yaml -r /config/registration.yaml
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-whatsapp 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-whatsapp 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-whatsapp 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-whatsapp 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mautrix-whatsapp

roles/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-disc
 			{% endfor %}
 			{{ matrix_mx_puppet_discord_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-discord 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-discord 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-discord 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-discord 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-discord

roles/matrix-bridge-mx-puppet-groupme/templates/systemd/matrix-mx-puppet-groupme.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-grou
 			{% endfor %}
 			{{ matrix_mx_puppet_groupme_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-groupme 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-groupme 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-groupme 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-groupme 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-groupme

roles/matrix-bridge-mx-puppet-instagram/templates/systemd/matrix-mx-puppet-instagram.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-inst
 			{% endfor %}
 			{{ matrix_mx_puppet_instagram_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-instagram 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-instagram 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-instagram 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-instagram 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-instagram

roles/matrix-bridge-mx-puppet-skype/templates/systemd/matrix-mx-puppet-skype.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-skyp
 			{% endfor %}
 			{{ matrix_mx_puppet_skype_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-skype 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-skype 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-skype 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-skype 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-skype

roles/matrix-bridge-mx-puppet-slack/tasks/init.yml

@@ -28,7 +28,7 @@
       msg: >-
         Trying to append Slack Appservice's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-mx-puppet-slack role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-mx-puppet-slack/templates/systemd/matrix-mx-puppet-slack.service.j2

@@ -36,8 +36,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-slac
 			{% endfor %}
 			{{ matrix_mx_puppet_slack_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-slack 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-slack 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-slack 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-slack 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-slack

roles/matrix-bridge-mx-puppet-steam/templates/systemd/matrix-mx-puppet-steam.service.j2

@@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-stea
 			{% endfor %}
 			{{ matrix_mx_puppet_steam_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-steam 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-steam 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-steam 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-steam 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-steam

roles/matrix-bridge-mx-puppet-twitter/tasks/init.yml

@@ -28,7 +28,7 @@
       msg: >-
         Trying to append Twitter Appservice's reverse-proxying configuration to matrix-nginx-proxy,
         but it's pointless since the matrix-nginx-proxy role had already executed.
-        To fix this, please change the order of roles in your plabook,
+        To fix this, please change the order of roles in your playbook,
         so that the matrix-nginx-proxy role would run after the matrix-mx-puppet-twitter role.
     when: matrix_nginx_proxy_role_executed|default(False)|bool
 

roles/matrix-bridge-mx-puppet-twitter/templates/systemd/matrix-mx-puppet-twitter.service.j2

@@ -36,8 +36,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-twit
 			{% endfor %}
 			{{ matrix_mx_puppet_twitter_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-twitter 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-twitter 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mx-puppet-twitter 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mx-puppet-twitter 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-mx-puppet-twitter

roles/matrix-bridge-sms/templates/systemd/matrix-sms-bridge.service.j2

@@ -35,8 +35,8 @@ ExecStart=/usr/bin/docker run --rm --name matrix-sms-bridge \
 			{% endfor %}
 			{{ matrix_sms_bridge_docker_image }}
 
-ExecStop=-/usr/bin/docker kill matrix-sms-bridge
-ExecStop=-/usr/bin/docker rm matrix-sms-bridge
+ExecStopPost=-/usr/bin/docker kill matrix-sms-bridge
+ExecStopPost=-/usr/bin/docker rm matrix-sms-bridge
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-sms-bridge

roles/matrix-client-cinny/defaults/main.yml

@@ -0,0 +1,54 @@
+matrix_client_cinny_enabled: true
+
+matrix_client_cinny_container_image_self_build: false
+matrix_client_cinny_container_image_self_build_repo: "https://github.com/ajbura/cinny.git"
+
+matrix_client_cinny_version: v1.6.1
+matrix_client_cinny_docker_image: "{{ matrix_client_cinny_docker_image_name_prefix }}ajbura/cinny:{{ matrix_client_cinny_version }}"
+matrix_client_cinny_docker_image_name_prefix: "{{ 'localhost/' if matrix_client_cinny_container_image_self_build else matrix_container_global_registry_prefix }}"
+matrix_client_cinny_docker_image_force_pull: "{{ matrix_client_cinny_docker_image.endswith(':latest') }}"
+
+matrix_client_cinny_data_path: "{{ matrix_base_data_path }}/client-cinny"
+matrix_client_cinny_docker_src_files_path: "{{ matrix_client_cinny_data_path }}/docker-src"
+
+# Controls whether the container exposes its HTTP port (tcp/8080 in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8768"), or empty string to not expose.
+matrix_client_cinny_container_http_host_bind_port: ''
+
+# A list of extra arguments to pass to the container
+matrix_client_cinny_container_extra_arguments: []
+
+# List of systemd services that matrix-client-cinny.service depends on
+matrix_client_cinny_systemd_required_services_list: ['docker.service']
+
+# Controls whether the self-check feature should validate SSL certificates.
+matrix_client_cinny_self_check_validate_certificates: true
+
+# config.json
+matrix_client_cinny_default_hs_url: ""
+
+# Default cinny configuration template which covers the generic use case.
+# You can customize it by controlling the various variables inside it.
+#
+# For a more advanced customization, you can extend the default (see `matrix_client_cinny_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_client_cinny_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}"
+
+# Your custom JSON configuration for cinny should go to `matrix_client_cinny_configuration_extension_json`.
+# This configuration extends the default starting configuration (`matrix_client_cinny_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_client_cinny_configuration_default`.
+matrix_client_cinny_configuration_extension_json: '{}'
+
+matrix_client_cinny_configuration_extension: "{{ matrix_client_cinny_configuration_extension_json|from_json if matrix_client_cinny_configuration_extension_json|from_json is mapping else {} }}"
+
+# Holds the final cinny configuration (a combination of the default and its extension).
+# You most likely don't need to touch this variable. Instead, see `matrix_client_cinny_configuration_default`.
+matrix_client_cinny_configuration: "{{ matrix_client_cinny_configuration_default|combine(matrix_client_cinny_configuration_extension, recursive=True) }}"

roles/matrix-client-cinny/tasks/init.yml

@@ -0,0 +1,10 @@
+# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
+# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
+- name: Fail if trying to self-build on Ansible < 2.8
+  fail:
+    msg: "To self-build the Cinny image, you should use Ansible 2.8 or higher. See docs/ansible.md"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_client_cinny_container_image_self_build and matrix_client_cinny_enabled"
+
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-client-cinny.service'] }}"
+  when: matrix_client_cinny_enabled|bool

roles/matrix-client-cinny/tasks/main.yml

@@ -0,0 +1,28 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup|bool and matrix_client_cinny_enabled|bool"
+  tags:
+    - setup-all
+    - setup-client-cinny
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_client_cinny_enabled|bool"
+  tags:
+    - setup-all
+    - setup-client-cinny
+
+- import_tasks: "{{ role_path }}/tasks/self_check.yml"
+  delegate_to: 127.0.0.1
+  become: false
+  when: "run_self_check|bool and matrix_client_cinny_enabled|bool"
+  tags:
+    - self-check
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_client_cinny_enabled|bool"
+  tags:
+    - setup-all
+    - setup-client-cinny

roles/matrix-client-cinny/tasks/self_check.yml

@@ -0,0 +1,22 @@
+---
+
+- set_fact:
+    matrix_client_cinny_url_endpoint_public: "https://{{ matrix_server_fqn_cinny }}/config.json"
+
+- name: Check Cinny
+  uri:
+    url: "{{ matrix_client_cinny_url_endpoint_public }}"
+    follow_redirects: none
+    validate_certs: "{{ matrix_client_cinny_self_check_validate_certificates }}"
+  register: matrix_client_cinny_self_check_result
+  check_mode: no
+  ignore_errors: true
+
+- name: Fail if Cinny not working
+  fail:
+    msg: "Failed checking Cinny is up at `{{ matrix_server_fqn_cinny }}` (checked endpoint: `{{ matrix_client_cinny_url_endpoint_public }}`). Is Cinny running? Is port 443 open in your firewall? Full error: {{ matrix_client_cinny_self_check_result }}"
+  when: "matrix_client_cinny_self_check_result.failed or 'json' not in matrix_client_cinny_self_check_result"
+
+- name: Report working Cinny
+  debug:
+    msg: "Cinny at `{{ matrix_server_fqn_cinny }}` is working (checked endpoint: `{{ matrix_client_cinny_url_endpoint_public }}`)"

roles/matrix-client-cinny/tasks/setup_install.yml

@@ -0,0 +1,71 @@
+---
+- name: Ensure Cinny paths exists
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_client_cinny_data_path }}", when: true }
+    - { path: "{{ matrix_client_cinny_docker_src_files_path }}", when: "{{ matrix_client_cinny_container_image_self_build }}" }
+  when: "item.when|bool"
+
+- name: Ensure Cinny Docker image is pulled
+  docker_image:
+   name: "{{ matrix_client_cinny_docker_image }}"
+   source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+   force_source: "{{ matrix_client_cinny_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+   force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_client_cinny_docker_image_force_pull }}"
+  when: "not matrix_client_cinny_container_image_self_build|bool"
+
+- name: Ensure Cinny repository is present on self-build
+  git:
+    repo: "{{ matrix_client_cinny_container_image_self_build_repo }}"
+    dest: "{{ matrix_client_cinny_docker_src_files_path }}"
+    version: "{{ matrix_client_cinny_docker_image.split(':')[1] }}"
+    force: "yes"
+  register: matrix_client_cinny_git_pull_results
+  when: "matrix_client_cinny_container_image_self_build|bool"
+
+- name: Ensure Cinny configuration installed
+  copy:
+    content: "{{ matrix_client_cinny_configuration|to_nice_json }}"
+    dest: "{{ matrix_client_cinny_data_path }}/config.json"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure Cinny additional config files installed
+  template:
+    src: "{{ item.src }}"
+    dest: "{{ matrix_client_cinny_data_path }}/{{ item.name }}"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - {src: "{{ role_path }}/templates/nginx.conf.j2", name: "nginx.conf"}
+  when: "item.src is not none"
+
+- name: Ensure Cinny Docker image is built
+  docker_image:
+    name: "{{ matrix_client_cinny_docker_image }}"
+    source: build
+    force_source: "{{ matrix_client_cinny_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_client_cinny_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_client_cinny_container_image_self_build|bool"
+
+- name: Ensure matrix-client-cinny.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-client-cinny.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-client-cinny.service"
+    mode: 0644
+  register: matrix_client_cinny_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-client-cinny.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_client_cinny_systemd_service_result.changed|bool"

roles/matrix-client-cinny/tasks/setup_uninstall.yml

@@ -0,0 +1,35 @@
+---
+- name: Check existence of matrix-client-cinny.service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-client-cinny.service"
+  register: matrix_client_cinny_service_stat
+
+- name: Ensure matrix-client-cinny is stopped
+  service:
+    name: matrix-client-cinny
+    state: stopped
+    enabled: no
+    daemon_reload: yes
+  register: stopping_result
+  when: "matrix_client_cinny_service_stat.stat.exists|bool"
+
+- name: Ensure matrix-client-cinny.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-client-cinny.service"
+    state: absent
+  when: "matrix_client_cinny_service_stat.stat.exists|bool"
+
+- name: Ensure systemd reloaded after matrix-client-cinny.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_client_cinny_service_stat.stat.exists|bool"
+
+- name: Ensure Cinny paths doesn't exist
+  file:
+    path: "{{ matrix_client_cinny_data_path }}"
+    state: absent
+
+- name: Ensure Cinny Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_client_cinny_docker_image }}"
+    state: absent

roles/matrix-client-cinny/tasks/validate_config.yml

@@ -0,0 +1,8 @@
+---
+- name: Fail if required Cinny settings not defined
+  fail:
+    msg: >
+      You need to define a required configuration setting (`{{ item }}`) to use Cinny.
+  when: "vars[item] == '' or vars[item] is none"
+  with_items:
+    - "matrix_client_cinny_default_hs_url"

roles/matrix-client-cinny/templates/config.json.j2

@@ -0,0 +1,6 @@
+{
+  "defaultHomeserver": 0,
+  "homeserverList": [
+    {{ matrix_client_cinny_default_hs_url|string|to_json }}
+  ]
+}

roles/matrix-client-cinny/templates/nginx.conf.j2

@@ -0,0 +1,66 @@
+#jinja2: lstrip_blocks: "True"
+# This is a custom nginx configuration file that we use in the container (instead of the default one),
+# because it allows us to run nginx with a non-root user.
+#
+# For this to work, the default vhost file (`/etc/nginx/conf.d/default.conf`) also needs to be removed.
+# (mounting `/dev/null` over `/etc/nginx/conf.d/default.conf` works well)
+#
+# The following changes have been done compared to a default nginx configuration file:
+# - default server port is changed (80 -> 8080), so that a non-root user can bind it
+# - various temp paths are changed to `/tmp`, so that a non-root user can write to them
+# - the `user` directive was removed, as we don't want nginx to switch users
+
+worker_processes 1;
+
+error_log /var/log/nginx/error.log warn;
+pid /tmp/nginx.pid;
+
+
+events {
+	worker_connections 1024;
+}
+
+
+http {
+	proxy_temp_path /tmp/proxy_temp;
+	client_body_temp_path /tmp/client_temp;
+	fastcgi_temp_path /tmp/fastcgi_temp;
+	uwsgi_temp_path /tmp/uwsgi_temp;
+	scgi_temp_path /tmp/scgi_temp;
+
+	include /etc/nginx/mime.types;
+	default_type application/octet-stream;
+
+	log_format main '$remote_addr - $remote_user [$time_local] "$request" '
+					'$status $body_bytes_sent "$http_referer" '
+					'"$http_user_agent" "$http_x_forwarded_for"';
+
+	access_log /var/log/nginx/access.log main;
+
+	sendfile on;
+	#tcp_nopush on;
+
+	keepalive_timeout 65;
+
+	#gzip on;
+
+	server {
+		listen 8080;
+		server_name localhost;
+
+		root /usr/share/nginx/html;
+
+		location / {
+			index index.html index.htm;
+		}
+
+		location ~* ^/(config(.+)?\.json$|(.+)\.html$|i18n) {
+			expires -1;
+		}
+
+		error_page 500 502 503 504 /50x.html;
+		location = /50x.html {
+			root /usr/share/nginx/html;
+		}
+	}
+}

roles/matrix-client-cinny/templates/systemd/matrix-client-cinny.service.j2

@@ -0,0 +1,40 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=Matrix Cinny Client
+{% for service in matrix_client_cinny_systemd_required_services_list %}
+Requires={{ service }}
+After={{ service }}
+{% endfor %}
+DefaultDependencies=no
+
+[Service]
+Type=simple
+Environment="HOME={{ matrix_systemd_unit_home_path }}"
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-cinny 2>/dev/null'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-cinny 2>/dev/null'
+
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-client-cinny \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--read-only \
+			--network={{ matrix_docker_network }} \
+			{% if matrix_client_cinny_container_http_host_bind_port %}
+			-p {{ matrix_client_cinny_container_http_host_bind_port }}:8080 \
+			{% endif %}
+			--tmpfs=/tmp:rw,noexec,nosuid,size=10m \
+			--mount type=bind,src={{ matrix_client_cinny_data_path }}/nginx.conf,dst=/etc/nginx/nginx.conf,ro \
+			--mount type=bind,src={{ matrix_client_cinny_data_path }}/config.json,dst=/app/config.json,ro \
+			{% for arg in matrix_client_cinny_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_client_cinny_docker_image }}
+
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-cinny 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-cinny 2>/dev/null'
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-client-cinny
+
+[Install]
+WantedBy=multi-user.target

roles/matrix-client-element/templates/systemd/matrix-client-element.service.j2

@@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-client-element
 			{% endfor %}
 			{{ matrix_client_element_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-element 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-element 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-element 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-element 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-client-element

roles/matrix-client-hydrogen/defaults/main.yml

@@ -7,7 +7,7 @@ matrix_client_hydrogen_container_image_self_build_repo: "https://github.com/vect
 
 matrix_client_hydrogen_version: v0.2.19
 matrix_client_hydrogen_docker_image: "{{ matrix_client_hydrogen_docker_image_name_prefix }}vectorim/hydrogen-web:{{ matrix_client_hydrogen_version }}"
-matrix_client_hydrogen_docker_image_name_prefix: "{{ 'localhost/' if matrix_client_hydrogen_container_image_self_build }}"
+matrix_client_hydrogen_docker_image_name_prefix: "{{ 'localhost/' if matrix_client_hydrogen_container_image_self_build else matrix_container_global_registry_prefix }}"
 matrix_client_hydrogen_docker_image_force_pull: "{{ matrix_client_hydrogen_docker_image.endswith(':latest') }}"
 
 matrix_client_hydrogen_data_path: "{{ matrix_base_data_path }}/client-hydrogen"

roles/matrix-client-hydrogen/templates/systemd/matrix-client-hydrogen.service.j2

@@ -29,8 +29,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-client-hydroge
 			{% endfor %}
 			{{ matrix_client_hydrogen_docker_image }}
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-hydrogen 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-hydrogen 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-hydrogen 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-hydrogen 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-client-hydrogen

roles/matrix-corporal/templates/systemd/matrix-corporal.service.j2

@@ -34,8 +34,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-corporal \
 			{{ matrix_corporal_docker_image }} \
 			/matrix-corporal -config=/etc/matrix-corporal/config.json
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-corporal 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-corporal 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-corporal 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-corporal 2>/dev/null'
 Restart=always
 RestartSec=30
 SyslogIdentifier=matrix-corporal

roles/matrix-coturn/templates/systemd/matrix-coturn.service.j2

@@ -43,8 +43,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-coturn \
 			{{ matrix_coturn_docker_image }} \
 			-c /turnserver.conf
 
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-coturn 2>/dev/null'
-ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-coturn 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-coturn 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-coturn 2>/dev/null'
 
 # This only reloads certificates (not other configuration).
 # See: https://github.com/coturn/coturn/pull/236

roles/matrix-dendrite/defaults/main.yml

@@ -0,0 +1,174 @@
+# Dendrite is a second-generation Matrix homeserver currently in Beta
+# See: https://github.com/matrix-org/dendrite
+
+matrix_dendrite_enabled: true
+
+matrix_dendrite_docker_image: "{{ matrix_dendrite_docker_image_name_prefix }}matrixdotorg/dendrite-monolith:{{ matrix_dendrite_docker_image_tag }}"
+matrix_dendrite_docker_image_name_prefix: "docker.io/"
+matrix_dendrite_docker_image_tag: "v0.5.1"
+matrix_dendrite_docker_image_force_pull: "{{ matrix_dendrite_docker_image.endswith(':latest') }}"
+
+matrix_dendrite_base_path: "{{ matrix_base_data_path }}/dendrite"
+matrix_dendrite_config_dir_path: "{{ matrix_dendrite_base_path }}/config"
+matrix_dendrite_storage_path: "{{ matrix_dendrite_base_path }}/storage"
+matrix_dendrite_media_store_path: "{{ matrix_dendrite_storage_path }}/media-store"
+matrix_dendrite_ext_path: "{{ matrix_dendrite_base_path }}/ext"
+
+# By default, we make Dendrite only serve HTTP (not HTTPS).
+# HTTPS is usually served at the reverse-proxy side (usually via `matrix-nginx-proxy`).
+#
+# To enable HTTPS serving by Dendrite (directly):
+# - `matrix_dendrite_https_bind_port` must be set
+# - `-tls-cert` and `-tls-key` must be passed to Dendrite via `matrix_dendrite_process_extra_arguments`
+# - the TLS certificate files must be mounted into the container using `matrix_dendrite_container_additional_volumes`
+matrix_dendrite_http_bind_port: 8008
+matrix_dendrite_https_bind_port: ~
+
+# This is passed as an `-http-bind-address` flag to the Dendrite server in the container
+matrix_dendrite_http_bind_address: "{{ (':' + matrix_dendrite_http_bind_port|string) if matrix_dendrite_http_bind_port else '' }}"
+
+# This is passed as an `-https-bind-address` flag to the Dendrite server in the container
+matrix_dendrite_https_bind_address: "{{ (':' + matrix_dendrite_https_bind_port|string) if matrix_dendrite_https_bind_port else '' }}"
+
+# Controls whether the matrix-dendrite container exposes the HTTP port (tcp/{{ matrix_dendrite_http_bind_port }} in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8008"), or empty string to not expose.
+matrix_dendrite_container_http_host_bind_address: ""
+
+# Controls whether the matrix-dendrite container exposes the HTTPS port (tcp/{{ matrix_dendrite_https_bind_port }} in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8448"), or empty string to not expose.
+matrix_dendrite_container_https_host_bind_address: ""
+
+# A list of extra arguments to pass to the container (`docker run` command)
+matrix_dendrite_container_extra_arguments: []
+
+# A list of extra arguments to pass to the container process (`dendrite-monolith` command)
+# Example:
+# matrix_dendrite_process_extra_arguments:
+#  - "-tls-cert /some/path.crt"
+#  - "-tls-key /some/path.pem"
+matrix_dendrite_process_extra_arguments: []
+
+# List of systemd services that matrix-dendrite.service depends on
+matrix_dendrite_systemd_required_services_list: ["docker.service"]
+
+# List of systemd services that matrix-dendrite.service wants
+matrix_dendrite_systemd_wanted_services_list: []
+
+# Specifies which template files to use when configuring Dendrite.
+# If you'd like to have your own different configuration, feel free to copy and paste
+# the original files into your inventory (e.g. in `inventory/host_vars/<host>/`)
+# and then change the specific host's `vars.yaml` file like this:
+# matrix_dendrite_template_dendrite_config: "{{ playbook_dir }}/inventory/host_vars/<host>/dendrite.yaml.j2"
+matrix_dendrite_template_dendrite_config: "{{ role_path }}/templates/dendrite/dendrite.yaml.j2"
+
+matrix_dendrite_registration_shared_secret: ''
+matrix_dendrite_allow_guest_access: false
+
+matrix_dendrite_max_file_size_bytes: 10485760
+
+# Controls which HTTP header (e.g. 'X-Forwarded-For', 'X-Real-IP') to inspect to find the real remote IP address of the client.
+# This is likely required if Dendrite is running behind a reverse proxy server.
+matrix_dendrite_sync_api_real_ip_header: ''
+
+# The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
+matrix_dendrite_tmp_directory_size_mb: 500
+
+# Rate limits
+matrix_dendrite_rate_limiting_enabled: true
+matrix_dendrite_rate_limiting_threshold: 5
+matrix_dendrite_rate_limiting_cooloff_ms: 500
+
+# Controls whether people with access to the homeserver can register by themselves.
+matrix_dendrite_registration_disabled: false
+
+# reCAPTCHA API for validating registration attempts
+matrix_dendrite_enable_registration_captcha: false
+matrix_dendrite_recaptcha_public_key: ""
+matrix_dendrite_recaptcha_private_key: ""
+
+# A list of additional "volumes" to mount in the container.
+# This list gets populated dynamically based on Dendrite extensions that have been enabled.
+# Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
+#
+# Note: internally, this uses the `-v` flag for mounting the specified volumes.
+# It's better (safer) to use the `--mount` flag for mounting volumes.
+# To use `--mount`, specify it in `matrix_dendrite_container_extra_arguments`.
+# Example: `matrix_dendrite_container_extra_arguments: ['--mount type=bind,src=/outside,dst=/inside,ro']
+matrix_dendrite_container_additional_volumes: []
+
+# A list of appservice config files (in-container filesystem paths).
+# This list gets populated dynamically based on Dendrite extensions that have been enabled.
+# You may wish to use this together with `matrix_dendrite_container_additional_volumes` or `matrix_dendrite_container_extra_arguments`.
+matrix_dendrite_app_service_config_files: []
+
+# Enable exposure of metrics
+matrix_dendrite_metrics_enabled: false
+matrix_dendrite_metrics_username: "metrics"
+matrix_dendrite_metrics_password: "metrics"
+
+# Postgres database information
+matrix_dendrite_database_str: "postgresql://{{ matrix_dendrite_database_user }}:{{ matrix_dendrite_database_password }}@{{ matrix_dendrite_database_hostname }}"
+matrix_dendrite_database_hostname: "matrix-postgres"
+matrix_dendrite_database_user: "dendrite"
+matrix_dendrite_database_password: "itsasecret"
+matrix_dendrite_naffka_database: "dendrite_naffka"
+matrix_dendrite_appservice_database: "dendrite_appservice"
+matrix_dendrite_federationsender_database: "dendrite_federationsender"
+matrix_dendrite_keyserver_database: "dendrite_keyserver"
+matrix_dendrite_mediaapi_database: "dendrite_mediaapi"
+matrix_dendrite_room_database: "dendrite_room"
+matrix_dendrite_singingkeyserver_database: "dendrite_sigingkeyserver"
+matrix_dendrite_syncapi_database: "dendrite_syncapi"
+matrix_dendrite_account_database: "dendrite_account"
+matrix_dendrite_device_database: "dendrite_device"
+matrix_dendrite_mscs_database: "dendrite_mscs"
+
+matrix_dendrite_turn_uris: []
+matrix_dendrite_turn_shared_secret: ""
+matrix_dendrite_turn_allow_guests: False
+
+# Controls whether the self-check feature should validate TLS certificates.
+matrix_dendrite_disable_tls_validation: false
+
+matrix_dendrite_trusted_id_servers:
+  - "matrix.org"
+  - "vector.im"
+
+# Controls whether Dendrite will federate at all.
+# Disable this to completely isolate your server from the rest of the Matrix network.
+matrix_dendrite_federation_enabled: true
+
+# Controls whether the self-check feature should validate SSL certificates.
+matrix_dendrite_self_check_validate_certificates: true
+
+# Default Dendrite configuration template which covers the generic use case.
+# You can customize it by controlling the various variables inside it.
+#
+# For a more advanced customization, you can extend the default (see `matrix_dendrite_configuration_extension_yaml`)
+# or completely replace this variable with your own template.
+matrix_dendrite_configuration_yaml: "{{ lookup('template', 'templates/dendrite/dendrite.yaml.j2') }}"
+
+matrix_dendrite_configuration_extension_yaml: |
+  # Your custom YAML configuration for Dendrite goes here.
+  # This configuration extends the default starting configuration (`matrix_dendrite_configuration_yaml`).
+  #
+  # 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_dendrite_configuration_yaml`.
+  #
+  # Example configuration extension follows:
+  #
+  # server_notices:
+  #   system_mxid_localpart: notices
+  #   system_mxid_display_name: "Server Notices"
+  #   system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
+  #   room_name: "Server Notices"
+
+matrix_dendrite_configuration_extension: "{{ matrix_dendrite_configuration_extension_yaml|from_yaml if matrix_dendrite_configuration_extension_yaml|from_yaml is mapping else {} }}"
+
+# Holds the final Dendrite configuration (a combination of the default and its extension).
+# You most likely don't need to touch this variable. Instead, see `matrix_dendrite_configuration_yaml`.
+matrix_dendrite_configuration: "{{ matrix_dendrite_configuration_yaml|from_yaml|combine(matrix_dendrite_configuration_extension, recursive=True) }}"

roles/matrix-dendrite/tasks/dendrite/setup.yml

@@ -0,0 +1,6 @@
+---
+- import_tasks: "{{ role_path }}/tasks/dendrite/setup_install.yml"
+  when: matrix_dendrite_enabled|bool
+
+- import_tasks: "{{ role_path }}/tasks/dendrite/setup_uninstall.yml"
+  when: "not matrix_dendrite_enabled|bool"

roles/matrix-dendrite/tasks/dendrite/setup_install.yml

@@ -0,0 +1,77 @@
+---
+# This will throw a Permission Denied error if already mounted using fuse
+- name: Check Dendrite media store path
+  stat:
+    path: "{{ matrix_dendrite_media_store_path }}"
+  register: local_path_media_store_stat
+  ignore_errors: yes
+
+# This is separate and conditional, to ensure we don't execute it
+# if the path already exists or we failed to check, because it's mounted using fuse.
+- name: Ensure Dendrite media store path exists
+  file:
+    path: "{{ matrix_dendrite_media_store_path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  when: "not local_path_media_store_stat.failed and not local_path_media_store_stat.stat.exists"
+
+- name: Ensure Dendrite Docker image is pulled
+  docker_image:
+    name: "{{ matrix_dendrite_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_dendrite_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_dendrite_docker_image_force_pull }}"
+
+- name: Check if a Dendrite signing key exists
+  stat:
+    path: "{{ matrix_dendrite_config_dir_path }}/{{ matrix_server_fqn_matrix }}.signing.pem"
+  register: matrix_dendrite_signing_key_stat
+
+# We do this so that the signing key would get generated.
+# We don't use the `docker_container` module, because using it with `cap_drop` requires
+# a very recent version, which is not available for a lot of people yet.
+- name: Generate Dendrite signing key
+  command: |
+    docker run
+    --rm
+    --name=matrix-dendrite-config
+    --entrypoint=generate-keys
+    --mount type=bind,src={{ matrix_dendrite_config_dir_path }},dst=/data
+    {{ matrix_dendrite_docker_image }} --private-key=/data/{{ matrix_server_fqn_matrix }}.signing.pem
+    generate
+  when: "not matrix_dendrite_signing_key_stat.stat.exists"
+
+- name: Ensure Dendrite server key exists
+  file:
+    path: "{{ matrix_dendrite_config_dir_path }}/{{ matrix_server_fqn_matrix }}.signing.pem"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure Dendrite configuration installed
+  copy:
+    content: "{{ matrix_dendrite_configuration|to_nice_yaml }}"
+    dest: "{{ matrix_dendrite_config_dir_path }}/dendrite.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-dendrite.service installed
+  template:
+    src: "{{ role_path }}/templates/dendrite/systemd/matrix-dendrite.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-dendrite.service"
+    mode: 0644
+  register: matrix_dendrite_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-dendrite.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_dendrite_systemd_service_result.changed|bool"
+
+- name: Ensure matrix-dendrite-create-account script created
+  template:
+    src: "{{ role_path }}/templates/dendrite/usr-local-bin/matrix-dendrite-create-account.j2"
+    dest: "{{ matrix_local_bin_path }}/matrix-dendrite-create-account"
+    mode: 0750

roles/matrix-dendrite/tasks/dendrite/setup_uninstall.yml

@@ -0,0 +1,28 @@
+- name: Check existence of matrix-dendrite service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-dendrite.service"
+  register: matrix_dendrite_service_stat
+
+- name: Ensure matrix-dendrite is stopped
+  service:
+    name: matrix-dendrite
+    state: stopped
+    daemon_reload: yes
+  register: stopping_result
+  when: "matrix_dendrite_service_stat.stat.exists"
+
+- name: Ensure matrix-dendrite.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-dendrite.service"
+    state: absent
+  when: "matrix_dendrite_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-dendrite.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_dendrite_service_stat.stat.exists"
+
+- name: Ensure Dendrite Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_dendrite_docker_image }}"
+    state: absent

roles/matrix-dendrite/tasks/init.yml

@@ -0,0 +1,3 @@
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-dendrite.service'] }}"
+  when: matrix_dendrite_enabled|bool

roles/matrix-dendrite/tasks/main.yml

@@ -0,0 +1,40 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: run_setup|bool
+  tags:
+    - setup-all
+    - setup-dendrite
+
+- import_tasks: "{{ role_path }}/tasks/setup_dendrite.yml"
+  when: run_setup|bool
+  tags:
+    - setup-all
+    - setup-dendrite
+
+- import_tasks: "{{ role_path }}/tasks/register_user.yml"
+  when: run_dendrite_register_user|bool and matrix_dendrite_enabled|bool
+  tags:
+    - register-user
+
+- import_tasks: "{{ role_path }}/tasks/self_check_client_api.yml"
+  delegate_to: 127.0.0.1
+  become: false
+  when: run_self_check|bool and matrix_dendrite_enabled|bool
+  tags:
+    - self-check
+
+- import_tasks: "{{ role_path }}/tasks/self_check_federation_api.yml"
+  delegate_to: 127.0.0.1
+  become: false
+  when: run_self_check|bool and matrix_dendrite_enabled|bool
+  tags:
+    - self-check
+
+- name: Mark matrix-dendrite role as executed
+  set_fact:
+    matrix_dendrite_role_executed: true
+  tags:
+    - always

roles/matrix-dendrite/tasks/register_user.yml

@@ -0,0 +1,25 @@
+---
+- name: Fail if playbook called incorrectly
+  fail:
+    msg: "The `username` variable needs to be provided to this playbook, via --extra-vars"
+  when: "username is not defined or username == '<your-username>'"
+
+- name: Fail if playbook called incorrectly
+  fail:
+    msg: "The `password` variable needs to be provided to this playbook, via --extra-vars"
+  when: "password is not defined or password == '<your-password>'"
+
+- name: Ensure matrix-dendrite is started
+  service:
+    name: matrix-dendrite
+    state: started
+    daemon_reload: yes
+  register: start_result
+
+- name: Wait a while, so that Dendrite can manage to start
+  pause:
+    seconds: 7
+  when: "start_result.changed"
+
+- name: Register user
+  command: "{{ matrix_local_bin_path }}/matrix-dendrite-create-account {{ username|quote }} {{ password|quote }}"

roles/matrix-dendrite/tasks/self_check_client_api.yml

@@ -0,0 +1,18 @@
+---
+- name: Check Matrix Client API
+  uri:
+    url: "{{ matrix_dendrite_client_api_url_endpoint_public }}"
+    follow_redirects: none
+    validate_certs: "{{ matrix_dendrite_self_check_validate_certificates }}"
+  register: result_matrix_dendrite_client_api
+  ignore_errors: true
+  check_mode: no
+
+- name: Fail if Matrix Client API not working
+  fail:
+    msg: "Failed checking Matrix Client API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_dendrite_client_api_url_endpoint_public }}`). Is Dendrite running? Is port 443 open in your firewall? Full error: {{ result_matrix_dendrite_client_api }}"
+  when: "(result_matrix_dendrite_client_api.failed or 'json' not in result_matrix_dendrite_client_api)"
+
+- name: Report working Matrix Client API
+  debug:
+    msg: "The Matrix Client API at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_dendrite_client_api_url_endpoint_public }}`) is working"

roles/matrix-dendrite/tasks/self_check_federation_api.yml

@@ -0,0 +1,24 @@
+---
+- name: Check Matrix Federation API
+  uri:
+    url: "{{ matrix_dendrite_federation_api_url_endpoint_public }}"
+    follow_redirects: none
+    validate_certs: "{{ matrix_dendrite_self_check_validate_certificates }}"
+  register: result_matrix_dendrite_federation_api
+  ignore_errors: true
+  check_mode: no
+
+- name: Fail if Matrix Federation API not working
+  fail:
+    msg: "Failed checking Matrix Federation API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_dendrite_federation_api_url_endpoint_public }}`). Is Dendrite running? Is port {{ matrix_federation_public_port }} open in your firewall? Full error: {{ result_matrix_dendrite_federation_api }}"
+  when: "matrix_dendrite_federation_enabled|bool and (result_matrix_dendrite_federation_api.failed or 'json' not in result_matrix_dendrite_federation_api)"
+
+- name: Fail if Matrix Federation API unexpectedly enabled
+  fail:
+    msg: "Matrix Federation API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_dendrite_federation_api_url_endpoint_public }}`) despite being disabled."
+  when: "not matrix_dendrite_federation_enabled|bool and not result_matrix_dendrite_federation_api.failed"
+
+- name: Report working Matrix Federation API
+  debug:
+    msg: "The Matrix Federation API at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_dendrite_federation_api_url_endpoint_public }}`) is working"
+  when: "matrix_dendrite_federation_enabled|bool"

roles/matrix-dendrite/tasks/setup_dendrite.yml

@@ -0,0 +1,14 @@
+---
+- name: Ensure Dendrite paths exist
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_dendrite_config_dir_path }}", when: true }
+    - { path: "{{ matrix_dendrite_ext_path }}", when: true }
+  when: "matrix_dendrite_enabled|bool and item.when"
+
+- import_tasks: "{{ role_path }}/tasks/dendrite/setup.yml"

roles/matrix-dendrite/tasks/validate_config.yml

@@ -0,0 +1,16 @@
+---
+- name: Fail if required Dendrite settings not defined
+  fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`) for using Dendrite.
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_dendrite_registration_shared_secret"
+
+- name: (Deprecation) Catch and report renamed settings
+  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: []

roles/matrix-dendrite/templates/dendrite/dendrite.yaml.j2

@@ -0,0 +1,390 @@
+# This is the Dendrite configuration file.
+#
+# The configuration is split up into sections - each Dendrite component has a
+# configuration section, in addition to the "global" section which applies to
+# all components.
+#
+# At a minimum, to get started, you will need to update the settings in the
+# "global" section for your deployment, and you will need to check that the
+# database "connection_string" line in each component section is correct.
+#
+# Each component with a "database" section can accept the following formats
+# for "connection_string":
+#   SQLite:     file:filename.db
+#               file:///path/to/filename.db
+#   PostgreSQL: postgresql://user:pass@hostname/database?params=...
+#
+# SQLite is embedded into Dendrite and therefore no further prerequisites are
+# needed for the database when using SQLite mode. However, performance with
+# PostgreSQL is significantly better and recommended for multi-user deployments.
+# SQLite is typically around 20-30% slower than PostgreSQL when tested with a
+# small number of users and likely will perform worse still with a higher volume
+# of users.
+#
+# The "max_open_conns" and "max_idle_conns" settings configure the maximum
+# number of open/idle database connections. The value 0 will use the database
+# engine default, and a negative value will use unlimited connections. The
+# "conn_max_lifetime" option controls the maximum length of time a database
+# connection can be idle in seconds - a negative value is unlimited.
+
+# The version of the configuration file.
+version: 1
+
+# Global Matrix configuration. This configuration applies to all components.
+global:
+  # The domain name of this homeserver.
+  server_name: {{ matrix_domain|to_json }}
+
+  # The path to the signing private key file, used to sign requests and events.
+  # Note that this is NOT the same private key as used for TLS! To generate a
+  # signing key, use "./bin/generate-keys --private-key matrix_key.pem".
+  private_key: "/data/{{ matrix_server_fqn_matrix }}.signing.pem"
+
+  # The paths and expiry timestamps (as a UNIX timestamp in millisecond precision)
+  # to old signing private keys that were formerly in use on this domain. These
+  # keys will not be used for federation request or event signing, but will be
+  # provided to any other homeserver that asks when trying to verify old events.
+  # old_private_keys:
+  # - private_key: old_matrix_key.pem
+  #   expired_at: 1601024554498
+
+  # How long a remote server can cache our server signing key before requesting it
+  # again. Increasing this number will reduce the number of requests made by other
+  # servers for our key but increases the period that a compromised key will be
+  # considered valid by other homeservers.
+  key_validity_period: 168h0m0s
+
+  # The server name to delegate server-server communications to, with optional port
+  # e.g. localhost:443
+  well_known_server_name: ""
+
+  # Lists of domains that the server will trust as identity servers to verify third
+  # party identifiers such as phone numbers and email addresses.
+  trusted_third_party_id_servers: {{ matrix_dendrite_trusted_id_servers|to_json }}
+
+  # Disables federation. Dendrite will not be able to make any outbound HTTP requests
+  # to other servers and the federation API will not be exposed.
+  disable_federation: {{ (not matrix_dendrite_federation_enabled)|to_json }}
+
+  # Configuration for Kafka/Naffka.
+  kafka:
+    # List of Kafka broker addresses to connect to. This is not needed if using
+    # Naffka in monolith mode.
+    addresses: []
+
+    # The prefix to use for Kafka topic names for this homeserver. Change this only if
+    # you are running more than one Dendrite homeserver on the same Kafka deployment.
+    topic_prefix: Dendrite
+
+    # Whether to use Naffka instead of Kafka. This is only available in monolith
+    # mode, but means that you can run a single-process server without requiring
+    # Kafka.
+    use_naffka: true
+
+    # The max size a Kafka message is allowed to use.
+    # You only need to change this value, if you encounter issues with too large messages.
+    # Must be less than/equal to "max.message.bytes" configured in Kafka.
+    # Defaults to 8388608 bytes.
+    # max_message_bytes: 8388608
+
+    # Naffka database options. Not required when using Kafka.
+    naffka_database:
+      connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_naffka_database }}?sslmode=disable
+      max_open_conns: 10
+      max_idle_conns: 2
+      conn_max_lifetime: -1
+
+  # Configuration for Prometheus metric collection.
+  metrics:
+    # Whether or not Prometheus metrics are enabled.
+    enabled: {{ matrix_dendrite_metrics_enabled|to_json }}
+
+    # HTTP basic authentication to protect access to monitoring.
+    basic_auth:
+      username: {{ matrix_dendrite_metrics_username|to_json }}
+      password: {{ matrix_dendrite_metrics_password|to_json }}
+
+  # DNS cache options. The DNS cache may reduce the load on DNS servers
+  # if there is no local caching resolver available for use.
+  dns_cache:
+    # Whether or not the DNS cache is enabled.
+    enabled: false
+
+    # Maximum number of entries to hold in the DNS cache, and
+    # for how long those items should be considered valid in seconds.
+    cache_size: 256
+    cache_lifetime: "5m" # 5minutes; see https://pkg.go.dev/time@master#ParseDuration for more
+
+# Configuration for the Appservice API.
+app_service_api:
+  internal_api:
+    listen: http://0.0.0.0:7777
+    connect: http://appservice_api:7777
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_appservice_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+  # Disable the validation of TLS certificates of appservices. This is
+  # not recommended in production since it may allow appservice traffic
+  # to be sent to an unverified endpoint.
+  disable_tls_validation: false
+
+  # Appservice configuration files to load into this homeserver.
+  config_files: {{ matrix_dendrite_app_service_config_files|to_json }}
+
+# Configuration for the Client API.
+client_api:
+  internal_api:
+    listen: http://0.0.0.0:7771
+    connect: http://client_api:7771
+  external_api:
+    listen: http://0.0.0.0:8071
+
+  # Prevents new users from being able to register on this homeserver, except when
+  # using the registration shared secret below.
+  registration_disabled: {{ matrix_dendrite_registration_disabled|to_json }}
+
+  # If set, allows registration by anyone who knows the shared secret, regardless of
+  # whether registration is otherwise disabled.
+  registration_shared_secret: {{ matrix_dendrite_registration_shared_secret|string|to_json }}
+
+  # Whether to require reCAPTCHA for registration.
+  enable_registration_captcha: {{ matrix_dendrite_enable_registration_captcha|to_json }}
+
+  # Settings for ReCAPTCHA.
+  recaptcha_public_key: {{ matrix_dendrite_recaptcha_public_key|to_json }}
+  recaptcha_private_key: {{ matrix_dendrite_recaptcha_private_key|to_json }}
+  recaptcha_bypass_secret: ""
+  recaptcha_siteverify_api: ""
+
+  # TURN server information that this homeserver should send to clients.
+  turn:
+    turn_user_lifetime: ""
+    turn_uris: {{ matrix_dendrite_turn_uris|to_json }}
+    turn_shared_secret: {{ matrix_dendrite_turn_shared_secret|to_json }}
+    turn_username: ""
+    turn_password: ""
+
+  # Settings for rate-limited endpoints. Rate limiting will kick in after the
+  # threshold number of "slots" have been taken by requests from a specific
+  # host. Each "slot" will be released after the cooloff time in milliseconds.
+  rate_limiting:
+    enabled: {{ matrix_dendrite_rate_limiting_enabled|to_json }}
+    threshold: {{ matrix_dendrite_rate_limiting_threshold|to_json }}
+    cooloff_ms: {{ matrix_dendrite_rate_limiting_cooloff_ms|to_json }}
+
+# Configuration for the EDU server.
+edu_server:
+  internal_api:
+    listen: http://0.0.0.0:7778
+    connect: http://edu_server:7778
+
+# Configuration for the Federation API.
+federation_api:
+  internal_api:
+    listen: http://0.0.0.0:7772
+    connect: http://federation_api:7772
+  external_api:
+    listen: http://0.0.0.0:8072
+
+  # List of paths to X.509 certificates to be used by the external federation listeners.
+  # These certificates will be used to calculate the TLS fingerprints and other servers
+  # will expect the certificate to match these fingerprints. Certificates must be in PEM
+  # format.
+  federation_certificates: []
+
+# Configuration for the Federation Sender.
+federation_sender:
+  internal_api:
+    listen: http://0.0.0.0:7775
+    connect: http://federation_sender:7775
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_federationsender_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+  # How many times we will try to resend a failed transaction to a specific server. The
+  # backoff is 2**x seconds, so 1 = 2 seconds, 2 = 4 seconds, 3 = 8 seconds etc.
+  send_max_retries: 16
+
+  # Disable the validation of TLS certificates of remote federated homeservers. Do not
+  # enable this option in production as it presents a security risk!
+  disable_tls_validation: {{ matrix_dendrite_disable_tls_validation|to_json }}
+
+  # Use the following proxy server for outbound federation traffic.
+  proxy_outbound:
+    enabled: false
+    protocol: http
+    host: localhost
+    port: 8080
+
+# Configuration for the Key Server (for end-to-end encryption).
+key_server:
+  internal_api:
+    listen: http://0.0.0.0:7779
+    connect: http://key_server:7779
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_keyserver_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+# Configuration for the Media API.
+media_api:
+  internal_api:
+    listen: http://0.0.0.0:7774
+    connect: http://media_api:7774
+  external_api:
+    listen: http://0.0.0.0:8074
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_mediaapi_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+  # Storage path for uploaded media. May be relative or absolute.
+  base_path: "/matrix-media-store-parent/{{ matrix_dendrite_media_store_directory_name }}"
+
+  # The maximum allowed file size (in bytes) for media uploads to this homeserver
+  # (0 = unlimited). If using a reverse proxy, ensure it allows requests at
+  # least this large (e.g. client_max_body_size in nginx.)
+  max_file_size_bytes: {{ matrix_dendrite_max_file_size_bytes|to_json }}
+
+  # Whether to dynamically generate thumbnails if needed.
+  dynamic_thumbnails: false
+
+  # The maximum number of simultaneous thumbnail generators to run.
+  max_thumbnail_generators: 10
+
+  # A list of thumbnail sizes to be generated for media content.
+  thumbnail_sizes:
+  - width: 32
+    height: 32
+    method: crop
+  - width: 96
+    height: 96
+    method: crop
+  - width: 640
+    height: 480
+    method: scale
+
+# Configuration for experimental MSC's
+mscs:
+  # A list of enabled MSC's
+  # Currently valid values are:
+  # - msc2836    (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
+  # - msc2946    (Spaces Summary, see https://github.com/matrix-org/matrix-doc/pull/2946)
+  mscs: []
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_mscs_database }}?sslmode=disable
+    max_open_conns: 5
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+# Configuration for the Room Server.
+room_server:
+  internal_api:
+    listen: http://0.0.0.0:7770
+    connect: http://room_server:7770
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_room_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+# Configuration for the Signing Key Server (for server signing keys).
+signing_key_server:
+  internal_api:
+    listen: http://0.0.0.0:7780
+    connect: http://signing_key_server:7780
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_singingkeyserver_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+  # Perspective keyservers to use as a backup when direct key fetches fail. This may
+  # be required to satisfy key requests for servers that are no longer online when
+  # joining some rooms.
+  key_perspectives:
+  - server_name: matrix.org
+    keys:
+    - key_id: ed25519:auto
+      public_key: Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw
+    - key_id: ed25519:a_RXGa
+      public_key: l8Hft5qXKn1vfHrg3p4+W8gELQVo8N13JkluMfmn2sQ
+
+  # This option will control whether Dendrite will prefer to look up keys directly
+  # or whether it should try perspective servers first, using direct fetches as a
+  # last resort.
+  prefer_direct_fetch: false
+
+# Configuration for the Sync API.
+sync_api:
+  internal_api:
+    listen: http://0.0.0.0:7773
+    connect: http://sync_api:7773
+  external_api:
+      listen: http://0.0.0.0:8073
+  database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_syncapi_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+
+  # This option controls which HTTP header to inspect to find the real remote IP
+  # address of the client. This is likely required if Dendrite is running behind
+  # a reverse proxy server.
+  # real_ip_header: X-Real-IP
+  real_ip_header: {{ matrix_dendrite_sync_api_real_ip_header|to_json }}
+
+# Configuration for the User API.
+user_api:
+  # The cost when hashing passwords on registration/login. Default: 10. Min: 4, Max: 31
+  # See https://pkg.go.dev/golang.org/x/crypto/bcrypt for more information.
+  # Setting this lower makes registration/login consume less CPU resources at the cost of security
+  # should the database be compromised. Setting this higher makes registration/login consume more
+  # CPU resources but makes it harder to brute force password hashes.
+  # This value can be low if performing tests or on embedded Dendrite instances (e.g WASM builds)
+  # bcrypt_cost: 10
+  internal_api:
+    listen: http://0.0.0.0:7781
+    connect: http://user_api:7781
+  account_database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_account_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+  device_database:
+    connection_string: {{ matrix_dendrite_database_str }}/{{ matrix_dendrite_device_database }}?sslmode=disable
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
+  # The length of time that a token issued for a relying party from
+  # /_matrix/client/r0/user/{userId}/openid/request_token endpoint
+  # is considered to be valid in milliseconds.
+  # The default lifetime is 3600000ms (60 minutes).
+  # openid_token_lifetime_ms: 3600000
+
+# Configuration for Opentracing.
+# See https://github.com/matrix-org/dendrite/tree/master/docs/tracing for information on
+# how this works and how to set it up.
+tracing:
+  enabled: false
+  jaeger:
+    serviceName: ""
+    disabled: false
+    rpc_metrics: false
+    tags: []
+    sampler: null
+    reporter: null
+    headers: null
+    baggage_restrictions: null
+    throttler: null
+
+# Logging configuration, in addition to the standard logging that is sent to
+# stdout by Dendrite.
+logging: []