Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

809 lines
58 KiB

  1. # SPDX-FileCopyrightText: 2022-2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2024, 2025 MDAD project contributors
  3. # SPDX-FileCopyrightText: 2024-2026 Suguru Hirahara
  4. #
  5. # SPDX-License-Identifier: AGPL-3.0-or-later
  6. ---
  7. - name: (Deprecation) Catch and report renamed Matrix playbook settings
  8. ansible.builtin.fail:
  9. msg: >-
  10. Your configuration contains a variable, which now has a different name.
  11. Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
  12. when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
  13. with_items:
  14. - {'old': 'matrix_vars_yml_snapshotting_enabled', 'new': 'devture_playbook_state_preserver_vars_preservation_enabled'}
  15. - {'old': 'matrix_vars_yml_snapshotting_src', 'new': 'devture_playbook_state_preserver_vars_preservation_src'}
  16. - {'old': 'matrix_playbook_commit_hash_preservation_enabled', 'new': 'devture_playbook_state_preserver_commit_hash_preservation_enabled'}
  17. - {'old': 'matrix_ntpd_package', 'new': 'devture_timesync_ntpd_package'}
  18. - {'old': 'matrix_ntpd_service', 'new': 'devture_timesync_ntpd_service'}
  19. - {'old': 'matrix_systemd_unit_home_path', 'new': 'devture_systemd_docker_base_systemd_unit_home_path'}
  20. - {'old': 'matrix_systemd_path', 'new': 'devture_systemd_docker_base_systemd_path'}
  21. - {'old': 'matrix_host_command_docker', 'new': 'devture_systemd_docker_base_host_command_docker'}
  22. - {'old': 'matrix_host_command_sh', 'new': 'devture_systemd_docker_base_host_command_sh'}
  23. - {'old': 'matrix_host_command_systemctl', 'new': 'devture_systemd_docker_base_host_command_systemctl'}
  24. - {'old': 'matrix_container_retries_count', 'new': 'devture_playbook_help_container_retries_count'}
  25. - {'old': 'matrix_container_retries_delay', 'new': 'devture_playbook_help_container_retries_delay'}
  26. - {'old': 'matrix_geturl_retries_count', 'new': 'devture_playbook_help_geturl_retries_count'}
  27. - {'old': 'matrix_geturl_retries_delay', 'new': 'devture_playbook_help_geturl_retries_delay'}
  28. - {'old': 'matrix_nginx_proxy_synapse_cache_path', 'new': 'matrix_synapse_reverse_proxy_companion_synapse_cache_path'}
  29. - {'old': 'matrix_nginx_proxy_synapse_cache_enabled', 'new': 'matrix_synapse_reverse_proxy_companion_synapse_cache_enabled'}
  30. - {'old': 'matrix_docker_installation_enabled', 'new': 'matrix_playbook_docker_installation_enabled'}
  31. - {'old': 'matrix_docker_package_name', 'new': '<Not applicable. Docker is installed using https://github.com/geerlingguy/ansible-role-docker now>'}
  32. - {'old': 'matrix_systemd_services_list', 'new': 'devture_systemd_service_manager_services_list_additional'}
  33. - {'old': 'matrix_common_after_systemd_service_start_wait_for_timeout_seconds', 'new': 'devture_systemd_service_manager_up_verification_delay_seconds'}
  34. - {'old': 'matrix_systemd_services_autostart_enabled', 'new': 'devture_systemd_service_manager_services_autostart_enabled'}
  35. - {'old': 'matrix_prometheus_node_exporter_metrics_proxying_enabled', 'new': '<prometheus_node_exporter_container_labels_traefik_enabled or matrix_metrics_exposure_enabled>'}
  36. - {'old': 'matrix_prometheus_postgres_exporter_metrics_proxying_enabled', 'new': '<prometheus_postgres_exporter_container_labels_traefik_enabled or matrix_metrics_exposure_enabled>'}
  37. - {'old': 'matrix_playbook_traefik_certs_dumper_role_enabled', 'new': 'traefik_certs_dumper_enabled'}
  38. - {'old': 'matrix_playbook_traefik_role_enabled', 'new': 'traefik_enabled'}
  39. # Most important variables from the old Prometheus role here, for people who miss the changelog entry
  40. - {'old': 'matrix_prometheus_enabled', 'new': 'prometheus_enabled'}
  41. - {'old': 'matrix_prometheus_process_default_arguments', 'new': 'prometheus_process_default_arguments'}
  42. - {'old': 'matrix_prometheus_process_extra_arguments', 'new': 'prometheus_process_extra_arguments'}
  43. - {'old': 'matrix_prometheus_configuration_extension_yaml', 'new': 'prometheus_configuration_extension_yaml'}
  44. - {'old': 'matrix_prometheus_scraper_synapse_enabled', 'new': 'matrix_prometheus_services_connect_synapse_enabled'}
  45. - {'old': 'matrix_prometheus_scraper_synapse_targets', 'new': '<superseded by matrix_prometheus_services_connect_scraper_synapse_main_process_static_configs_target>'}
  46. - {'old': 'matrix_prometheus_scraper_synapse_workers_enabled_list', 'new': 'matrix_prometheus_services_connect_scraper_synapse_workers_enabled_list'}
  47. - {'old': 'matrix_prometheus_scraper_synapse_rules_synapse_tag', 'new': 'matrix_prometheus_services_connect_synapse_rules_download_synapse_tag'}
  48. - {'old': 'matrix_prometheus_scraper_node_enabled', 'new': 'prometheus_self_node_scraper_enabled'}
  49. - {'old': 'matrix_prometheus_scraper_node_targets', 'new': '<superseded by prometheus_self_node_scraper_static_configs_target>'}
  50. - {'old': 'matrix_prometheus_scraper_postgres_enabled', 'new': 'matrix_prometheus_services_connect_scraper_postgres_enabled'}
  51. - {'old': 'matrix_prometheus_scraper_postgres_targets', 'new': '<superseded by matrix_prometheus_services_connect_scraper_postgres_static_configs_target>'}
  52. - {'old': 'matrix_prometheus_scraper_hookshot_enabled', 'new': 'matrix_prometheus_services_connect_scraper_hookshot_enabled'}
  53. - {'old': 'matrix_prometheus_scraper_hookshot_targets', 'new': '<superseded by matrix_prometheus_services_connect_scraper_hookshot_static_configs_target>'}
  54. - {'old': 'matrix_prometheus_scraper_nginxlog_enabled', 'new': 'matrix_prometheus_services_connect_scraper_nginxlog_enabled'}
  55. - {'old': 'matrix_prometheus_scraper_nginxlog_server_port', 'new': 'matrix_prometheus_services_connect_scraper_nginxlog_static_configs_target'}
  56. - {'old': 'matrix_prosody_jitsi_max_participants', 'new': 'jitsi_prosody_max_participants'}
  57. - {'old': 'jitsi_require_well_known', 'new': 'jitsi_web_well_known_element_jitsi_enabled'}
  58. - {'old': 'jitsi_wellknown_element_jitsi_json', 'new': 'jitsi_web_well_known_element_jitsi_json'}
  59. - {'old': 'exim_relay_docker_image', 'new': 'exim_relay_container_image'}
  60. - {'old': 'exim_relay_docker_image_name_prefix', 'new': 'exim_relay_container_image_name_prefix'}
  61. - {'old': 'exim_relay_docker_image_force_pull', 'new': 'exim_relay_container_image_force_pull'}
  62. - {'old': 'matrix_playbook_reverse_proxy_traefik_middleware_compession_enabled', 'new': 'matrix_playbook_reverse_proxy_traefik_middleware_compression_enabled'}
  63. - {'old': 'matrix_playbook_reverse_proxy_traefik_middleware_compession_name', 'new': 'matrix_playbook_reverse_proxy_traefik_middleware_compression_name'}
  64. - {'old': 'matrix_synapse_account_threepid_delegates_msisdn_mas1sd_url', 'new': '<removed>'}
  65. - {'old': 'cinny_docker_image', 'new': 'cinny_container_image'}
  66. - {'old': 'cinny_docker_image_registry_prefix', 'new': 'cinny_container_image_registry_prefix'}
  67. - {'old': 'cinny_docker_image_registry_prefix_upstream', 'new': 'cinny_container_image_registry_prefix_upstream'}
  68. - {'old': 'cinny_docker_image_registry_prefix_upstream_default', 'new': 'cinny_container_image_registry_prefix_upstream_default'}
  69. - {'old': 'coturn_docker_image', 'new': 'coturn_container_image'}
  70. - {'old': 'coturn_docker_image_registry_prefix', 'new': 'coturn_container_image_registry_prefix'}
  71. - {'old': 'coturn_docker_image_registry_prefix_upstream', 'new': 'coturn_container_image_registry_prefix_upstream'}
  72. - {'old': 'coturn_docker_image_registry_prefix_upstream_default', 'new': 'coturn_container_image_registry_prefix_upstream_default'}
  73. - {'old': 'ddclient_docker_image', 'new': 'ddclient_container_image'}
  74. - {'old': 'ddclient_docker_image_registry_prefix', 'new': 'ddclient_container_image_registry_prefix'}
  75. - {'old': 'ddclient_docker_image_registry_prefix_upstream', 'new': 'ddclient_container_image_registry_prefix_upstream'}
  76. - {'old': 'ddclient_docker_image_registry_prefix_upstream_default', 'new': 'ddclient_container_image_registry_prefix_upstream_default'}
  77. - {'old': 'hydrogen_docker_image', 'new': 'hydrogen_container_image'}
  78. - {'old': 'hydrogen_docker_image_registry_prefix', 'new': 'hydrogen_container_image_registry_prefix'}
  79. - {'old': 'hydrogen_docker_image_registry_prefix_upstream', 'new': 'hydrogen_container_image_registry_prefix_upstream'}
  80. - {'old': 'hydrogen_docker_image_registry_prefix_upstream_default', 'new': 'hydrogen_container_image_registry_prefix_upstream_default'}
  81. - {'old': 'synapse_admin_docker_image', 'new': 'synapse_admin_container_image'}
  82. - {'old': 'synapse_admin_docker_image_registry_prefix', 'new': 'synapse_admin_container_image_registry_prefix'}
  83. - {'old': 'synapse_admin_docker_image_registry_prefix_upstream', 'new': 'synapse_admin_container_image_registry_prefix_upstream'}
  84. - {'old': 'synapse_admin_docker_image_registry_prefix_upstream_default', 'new': 'synapse_admin_container_image_registry_prefix_upstream_default'}
  85. - name: (Deprecation) Catch and report matrix_postgres variables
  86. ansible.builtin.fail:
  87. msg: |-
  88. The matrix-postgres role in the playbook has been replaced with the ansible-role-postgres role (https://github.com/mother-of-all-self-hosting/ansible-role-postgres).
  89. The new role is pretty much the same, but uses differently named variables.
  90. The matrix-postgres-backup role in the playbook has been replaced with the ansible-role-postgres-backup role (https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup).
  91. The new role is pretty much the same, but uses differently named variables.
  92. Please rename all `matrix_postgres`-prefixed variables (`matrix_postgres_*` -> `postgres_*`) on your configuration file (vars.yml).
  93. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  94. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_postgres_.+', wantlist=True) | join(', ') }}
  95. when: "lookup('ansible.builtin.varnames', '^matrix_postgres_.+', wantlist=True) | length > 0"
  96. - name: (Deprecation) Catch and report matrix_mailer_ variables
  97. ansible.builtin.fail:
  98. msg: |-
  99. The matrix-mailer role in the playbook has been replaced with the exim-relay role (https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay).
  100. The new role is pretty much the same, but uses differently named variables.
  101. Please rename all `matrix_mailer`-prefixed variables (`matrix_mailer_*` -> `exim_relay_*`) on your configuration file (vars.yml).
  102. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  103. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_mailer_.+', wantlist=True) | join(', ') }}
  104. when: "lookup('ansible.builtin.varnames', '^matrix_mailer_.+', wantlist=True) | length > 0"
  105. - when: matrix_playbook_migration_matrix_prometheus_node_exporter_migration_validation_enabled | bool
  106. block:
  107. - ansible.builtin.set_fact:
  108. matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars: |-
  109. {{ lookup('ansible.builtin.varnames', '^matrix_prometheus_node_exporter_.+', wantlist=True) }}
  110. - name: (Deprecation) Catch and report matrix_prometheus_node_exporter variables
  111. ansible.builtin.fail:
  112. msg: >-
  113. The matrix-prometheus-node-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter.
  114. The new role is compatible with the old one, but uses different names for its variables.
  115. Please rename all variables (`matrix_prometheus_node_exporter_` -> `prometheus_node_exporter_`) on your configuration file (vars.yml).
  116. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  117. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars | join(', ') }}
  118. when: "matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars | length > 0"
  119. - when: matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_validation_enabled | bool
  120. block:
  121. - ansible.builtin.set_fact:
  122. matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars: |-
  123. {{ lookup('ansible.builtin.varnames', '^matrix_prometheus_postgres_exporter_.+', wantlist=True) }}
  124. - name: (Deprecation) Catch and report matrix_prometheus_postgres_exporter variables
  125. ansible.builtin.fail:
  126. msg: >-
  127. The matrix-prometheus-postgres-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter.
  128. The new role is compatible with the old one, but uses different names for its variables.
  129. Please rename all variables (`matrix_prometheus_postgres_exporter_` -> `prometheus_postgres_exporter_`) on your configuration file (vars.yml).
  130. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  131. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars.keys() | join(', ') }}
  132. when: "matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars | length > 0"
  133. - when: matrix_playbook_migration_matrix_backup_borg_migration_validation_enabled | bool
  134. block:
  135. - ansible.builtin.set_fact:
  136. matrix_playbook_migration_backup_borg_migration_vars: |-
  137. {{ lookup('ansible.builtin.varnames', '^matrix_backup_borg_.+', wantlist=True) }}
  138. - name: (Deprecation) Catch and report matrix_backup_borg variables
  139. ansible.builtin.fail:
  140. msg: >-
  141. The matrix-backup-borg role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg.
  142. The new role is compatible with the old one, but uses different names for its variables.
  143. Please rename all variables (`matrix_backup_borg_` -> `backup_borg_`) on your configuration file (vars.yml).
  144. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  145. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_backup_borg_migration_vars.keys() | join(', ') }}
  146. when: "matrix_playbook_migration_backup_borg_migration_vars | length > 0"
  147. - when: matrix_playbook_migration_matrix_grafana_migration_validation_enabled | bool
  148. block:
  149. - ansible.builtin.set_fact:
  150. matrix_playbook_migration_grafana_migration_vars: |-
  151. {{ lookup('ansible.builtin.varnames', '^matrix_grafana_.+', wantlist=True) }}
  152. - name: (Deprecation) Catch and report matrix_grafana variables
  153. ansible.builtin.fail:
  154. msg: >-
  155. The matrix-grafana role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-grafana.
  156. The new role is compatible with the old one, but uses different names for its variables.
  157. Please rename all variables (`matrix_grafana_` -> `grafana_`) on your configuration file (vars.yml).
  158. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  159. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_grafana_migration_vars.keys() | join(', ') }}
  160. when: "matrix_playbook_migration_grafana_migration_vars | length > 0"
  161. - when: matrix_playbook_migration_matrix_ntfy_migration_validation_enabled | bool
  162. block:
  163. - ansible.builtin.set_fact:
  164. matrix_playbook_migration_ntfy_migration_vars: |-
  165. {{ lookup('ansible.builtin.varnames', '^matrix_ntfy_.+', wantlist=True) }}
  166. - name: (Deprecation) Catch and report matrix_ntfy variables
  167. ansible.builtin.fail:
  168. msg: >-
  169. The matrix-ntfy role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-ntfy.
  170. The new role is compatible with the old one, but uses different names for its variables.
  171. Please rename all variables (`matrix_ntfy_` -> `ntfy_`) on your configuration file (vars.yml).
  172. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  173. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_ntfy_migration_vars.keys() | join(', ') }}
  174. when: "matrix_playbook_migration_ntfy_migration_vars | length > 0"
  175. - when: matrix_playbook_migration_matrix_redis_migration_validation_enabled | bool
  176. block:
  177. - ansible.builtin.set_fact:
  178. matrix_playbook_migration_redis_migration_vars: |-
  179. {{ lookup('ansible.builtin.varnames', '^matrix_redis_.+', wantlist=True) }}
  180. - name: (Deprecation) Catch and report matrix_redis variables
  181. ansible.builtin.fail:
  182. msg: >-
  183. The matrix-redis role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-redis.
  184. The new role is compatible with the old one, but uses different names for its variables.
  185. Please rename all variables (`matrix_redis_` -> `redis_`) on your configuration file (vars.yml).
  186. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  187. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
  188. when: "matrix_playbook_migration_redis_migration_vars | length > 0"
  189. - when: matrix_playbook_migration_redis_valkey_migration_validation_enabled | bool
  190. block:
  191. - ansible.builtin.set_fact:
  192. matrix_playbook_migration_redis_migration_vars: |-
  193. {{ lookup('ansible.builtin.varnames', '^redis_.+', wantlist=True) }}
  194. - name: (Deprecation) Catch and report matrix_redis variables
  195. ansible.builtin.fail:
  196. msg: >-
  197. The Redis role that used to be part of this playbook has been superseded by https://github.com/mother-of-all-self-hosting/ansible-role-valkey.
  198. Please rename all variables (`redis_` -> `valkey_`) on your configuration file (vars.yml).
  199. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  200. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
  201. when: "matrix_playbook_migration_redis_migration_vars | length > 0"
  202. - when: matrix_playbook_migration_keydb_valkey_migration_validation_enabled | bool
  203. block:
  204. - ansible.builtin.set_fact:
  205. matrix_playbook_migration_keydb_migration_vars: |-
  206. {{ lookup('ansible.builtin.varnames', '^keydb_.+', wantlist=True) }}
  207. - name: (Deprecation) Catch and report matrix_redis variables
  208. ansible.builtin.fail:
  209. msg: >-
  210. The KeyDB role that used to be part of this playbook has been superseded by https://github.com/mother-of-all-self-hosting/ansible-role-valkey.
  211. Please rename all variables (`keydb_` -> `valkey_`) on your configuration file (vars.yml).
  212. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  213. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_keydb_migration_vars.keys() | join(', ') }}
  214. when: "matrix_playbook_migration_keydb_migration_vars | length > 0"
  215. - when: matrix_playbook_migration_matrix_etherpad_migration_validation_enabled | bool
  216. block:
  217. - ansible.builtin.set_fact:
  218. matrix_playbook_migration_etherpad_migration_vars: |-
  219. {{ lookup('ansible.builtin.varnames', '^matrix_etherpad_.+', wantlist=True) }}
  220. - name: (Deprecation) Catch and report matrix_etherpad variables
  221. ansible.builtin.fail:
  222. msg: >-
  223. The matrix-etherpad role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-etherpad.
  224. The new role is compatible with the old one, but uses different names for its variables.
  225. Please rename all variables (`matrix_etherpad_` -> `etherpad_`) on your configuration file (vars.yml).
  226. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  227. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_etherpad_migration_vars.keys() | join(', ') }}
  228. when: "matrix_playbook_migration_etherpad_migration_vars | length > 0"
  229. - when: matrix_playbook_migration_matrix_aux_migration_validation_enabled | bool
  230. block:
  231. - ansible.builtin.set_fact:
  232. matrix_playbook_migration_aux_migration_vars: |-
  233. {{ lookup('ansible.builtin.varnames', '^matrix_aux_.+', wantlist=True) }}
  234. - name: (Deprecation) Catch and report matrix_aux variables
  235. ansible.builtin.fail:
  236. msg: >-
  237. The matrix-aux role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-aux.
  238. The new role is compatible with the old one, but uses different names for its variables.
  239. Please rename all variables (`matrix_aux_` -> `aux_`) on your configuration file (vars.yml).
  240. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  241. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_aux_migration_vars.keys() | join(', ') }}
  242. when: "matrix_playbook_migration_aux_migration_vars | length > 0"
  243. - when: matrix_playbook_migration_matrix_jitsi_migration_validation_enabled | bool
  244. block:
  245. - ansible.builtin.set_fact:
  246. matrix_playbook_migration_jitsi_migration_vars: |-
  247. {{ lookup('ansible.builtin.varnames', '^matrix_jitsi_.+', wantlist=True) }}
  248. - name: (Deprecation) Catch and report matrix_jitsi variables
  249. ansible.builtin.fail:
  250. msg: >-
  251. The matrix-jitsi role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-jitsi.
  252. The new role is compatible with the old one, but uses different names for its variables.
  253. Please rename all variables (`matrix_jitsi_` -> `jitsi_`) on your configuration file (vars.yml).
  254. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  255. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_jitsi_migration_vars.keys() | join(', ') }}
  256. when: "matrix_playbook_migration_jitsi_migration_vars | length > 0"
  257. - when: matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled | bool
  258. block:
  259. - ansible.builtin.set_fact:
  260. matrix_playbook_migration_postmoogle_migration_vars: |-
  261. {{ lookup('ansible.builtin.varnames', '^matrix_bot_postmoogle_.+', wantlist=True) }}
  262. - name: (Deprecation) Catch and report matrix_bot_postmoogle variables
  263. ansible.builtin.fail:
  264. msg: >-
  265. Your configuration contains a variable, which now has a different name.
  266. Please rename all variables (`matrix_bot_postmoogle_` -> `matrix_postmoogle_`) on your configuration file (vars.yml).
  267. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_postmoogle_migration_vars.keys() | join(', ') }}
  268. when: "matrix_playbook_migration_postmoogle_migration_vars | length > 0"
  269. - when: matrix_playbook_migration_matrix_nginx_proxy_elimination_variable_transition_checks_enabled | bool
  270. block:
  271. - name: (Deprecation) Catch and report transitioned playbook settings during the matrix-nginx-proxy elimination
  272. ansible.builtin.fail:
  273. msg: >-
  274. Your configuration contains a variable, which now has a different name.
  275. Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
  276. when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
  277. with_items:
  278. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_enabled', 'new': 'matrix_metrics_exposure_enabled'}
  279. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_enabled', 'new': 'matrix_metrics_exposure_http_basic_auth_enabled'}
  280. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_username', 'new': '<superseded by matrix_metrics_exposure_http_basic_auth_users>'}
  281. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_password', 'new': '<superseded by matrix_metrics_exposure_http_basic_auth_users>'}
  282. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content', 'new': '<superseded by matrix_metrics_exposure_http_basic_auth_users>'}
  283. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_additional_location_configuration_blocks', 'new': '<superseded by adding labels to each individual service that you care about>'}
  284. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_additional_system_location_configuration_blocks', 'new': '<superseded by adding labels to each individual service that you care about>'}
  285. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_additional_user_location_configuration_blocks', 'new': '<superseded by adding labels to each individual service that you care about>'}
  286. - {'old': 'matrix_well_known_matrix_server_enabled', 'new': 'matrix_static_files_file_matrix_server_enabled'}
  287. - {'old': 'matrix_well_known_matrix_support_enabled', 'new': 'matrix_static_files_file_matrix_support_enabled'}
  288. - {'old': 'matrix_homeserver_admin_contacts', 'new': 'matrix_static_files_file_matrix_support_property_m_contacts'}
  289. - {'old': 'matrix_homeserver_support_url', 'new': 'matrix_static_files_file_matrix_support_property_m_support_page'}
  290. - {'old': 'matrix_well_known_matrix_client_io_element_e2ee_default', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_default'}
  291. - {'old': 'matrix_well_known_matrix_client_io_element_e2ee_secure_backup_required', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required'}
  292. - {'old': 'matrix_well_known_matrix_client_io_element_e2ee_secure_backup_setup_methods', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_setup_methods'}
  293. - {'old': 'matrix_well_known_matrix_client_configuration_extension_json', 'new': 'matrix_static_files_file_matrix_client_configuration_extension_json'}
  294. - {'old': 'matrix_well_known_matrix_server_configuration_extension_json', 'new': 'matrix_static_files_file_matrix_server_configuration_extension_json'}
  295. - {'old': 'matrix_well_known_matrix_support_configuration_extension_json', 'new': 'matrix_static_files_file_matrix_support_configuration_extension_json'}
  296. - {'old': 'matrix_nginx_proxy_self_check_validate_certificates', 'new': 'matrix_static_files_self_check_validate_certificates'}
  297. - {'old': 'matrix_nginx_proxy_self_check_well_known_matrix_client_follow_redirects', 'new': 'matrix_static_files_self_check_well_known_matrix_client_follow_redirects'}
  298. - {'old': 'matrix_nginx_proxy_base_domain_serving_enabled', 'new': 'matrix_static_files_container_labels_base_domain_enabled'}
  299. - {'old': 'matrix_nginx_proxy_base_domain_hostname', 'new': 'matrix_static_files_container_labels_base_domain_traefik_hostname'}
  300. - {'old': 'matrix_nginx_proxy_base_domain_homepage_enabled', 'new': 'matrix_static_files_file_index_html_enabled'}
  301. - {'old': 'matrix_nginx_proxy_base_domain_homepage_template', 'new': 'matrix_static_files_file_index_html_template'}
  302. - {'old': 'matrix_nginx_proxy_base_domain_create_directory', 'new': '<no longer necessary; see matrix_static_files_file_index_html_enabled>'}
  303. - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': '<redirecting the Riot domain to an Element domain is no longer supported - you can implement it yourself using matrix_client_element_container_labels_additional_labels>'}
  304. - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': '<redirecting the Riot domain to an Element domain is no longer supported - you can implement it yourself using matrix_client_element_container_labels_additional_labels>'}
  305. - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_enabled', 'new': '<superseded by matrix_synapse_container_labels_public_client_root_redirection_enabled or other equivalent variables based on the homeserver implementation you use>'}
  306. - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain', 'new': '<superseded by matrix_synapse_container_labels_public_client_root_redirection_url or other equivalent variables based on the homeserver implementation you use>'}
  307. - {'old': 'matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled', 'new': 'matrix_synapse_container_labels_public_client_synapse_client_api_enabled'}
  308. - {'old': 'matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_oidc_api_enabled', 'new': '<replaced by matrix_synapse_container_labels_public_client_synapse_oidc_api_enabled, but if you use matrix_synapse_oidc_enabled then it would be toggled automatically; see the new recommended OIDC example configuration in docs/configuring-playbook-synapse.md>'}
  309. - {'old': 'matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_admin_api_enabled', 'new': 'matrix_synapse_container_labels_public_client_synapse_admin_api_enabled'}
  310. - {'old': 'matrix_nginx_proxy_proxy_matrix_identity_api_enabled', 'new': '<removed>'}
  311. - {'old': 'matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container', 'new': '<removed>'}
  312. - {'old': 'matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container', 'new': '<removed>'}
  313. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled', 'new': '<removed>'}
  314. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container', 'new': '<removed>'}
  315. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container', 'new': '<removed>'}
  316. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_v3_to_r0_redirect_enabled', 'new': '<removed>'}
  317. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_enabled', 'new': '<removed>'}
  318. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_with_container', 'new': '<removed>'}
  319. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_sans_container', 'new': '<removed>'}
  320. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_v3_to_r0_redirect_enabled', 'new': '<removed>'}
  321. - {'old': 'matrix_nginx_proxy_proxy_conduit_enabled', 'new': 'matrix_conduit_container_labels_traefik_enabled'}
  322. - {'old': 'matrix_nginx_proxy_proxy_conduit_block_federation_api_on_client_port', 'new': '<not supported anymore - the /_matrix/federation endpoints are now also being served on the Client-Server API port>'}
  323. - {'old': 'matrix_nginx_proxy_proxy_conduit_federation_api_enabled', 'new': 'matrix_conduit_container_labels_public_federation_api_enabled'}
  324. - {'old': 'matrix_nginx_proxy_proxy_conduit_client_api_addr_with_container', 'new': '<removed>'}
  325. - {'old': 'matrix_nginx_proxy_proxy_conduit_client_api_addr_sans_container', 'new': '<removed>'}
  326. - {'old': 'matrix_nginx_proxy_proxy_conduit_federation_api_addr_with_container', 'new': '<removed>'}
  327. - {'old': 'matrix_nginx_proxy_proxy_conduit_federation_api_addr_sans_container', 'new': '<removed>'}
  328. - {'old': 'matrix_nginx_proxy_proxy_conduit_additional_server_configuration_blocks', 'new': '<removed>'}
  329. - {'old': 'matrix_nginx_proxy_proxy_dendrite_enabled', 'new': 'matrix_dendrite_container_labels_traefik_enabled'}
  330. - {'old': 'matrix_nginx_proxy_proxy_dendrite_block_federation_api_on_client_port', 'new': '<not supported anymore - the /_matrix/federation endpoints are now also being served on the Client-Server API port>'}
  331. - {'old': 'matrix_nginx_proxy_proxy_dendrite_federation_api_enabled', 'new': 'matrix_dendrite_container_labels_public_federation_api_enabled'}
  332. - {'old': 'matrix_nginx_proxy_proxy_dendrite_client_api_addr_with_container', 'new': '<removed>'}
  333. - {'old': 'matrix_nginx_proxy_proxy_dendrite_client_api_addr_sans_container', 'new': '<removed>'}
  334. - {'old': 'matrix_nginx_proxy_proxy_dendrite_federation_api_addr_with_container', 'new': '<removed>'}
  335. - {'old': 'matrix_nginx_proxy_proxy_dendrite_federation_api_addr_sans_container', 'new': '<removed>'}
  336. - {'old': 'matrix_nginx_proxy_proxy_dendrite_additional_server_configuration_blocks', 'new': '<removed>'}
  337. - {'old': 'matrix_nginx_proxy_proxy_synapse_enabled', 'new': 'matrix_synapse_container_labels_traefik_enabled'}
  338. - {'old': 'matrix_nginx_proxy_proxy_synapse_federation_api_enabled', 'new': 'matrix_synapse_container_labels_public_federation_api_enabled'}
  339. - {'old': 'matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container', 'new': '<removed>'}
  340. - {'old': 'matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container', 'new': '<removed>'}
  341. - {'old': 'matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container', 'new': '<removed>'}
  342. - {'old': 'matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container', 'new': '<removed>'}
  343. - {'old': 'matrix_nginx_proxy_proxy_synapse_additional_server_configuration_blocks', 'new': '<removed>'}
  344. - {'old': 'matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks', 'new': '<removed>'}
  345. - {'old': 'matrix_nginx_proxy_access_log_enabled', 'new': 'traefik_config_accessLog_enabled'}
  346. - {'old': 'matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_hostname', 'new': 'matrix_server_fqn_matrix_federation'}
  347. - {'old': 'etherpad_nginx_proxy_dimension_integration_enabled', 'new': '<removed>'}
  348. - {'old': 'etherpad_nginx_proxy_dimension_integration_path_prefix', 'new': '<removed>'}
  349. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_node_exporter_metrics_proxying_enabled', 'new': '<removed>'}
  350. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_node_exporter_matrix_nginx_proxy_not_enabled_proxy_pass_host', 'new': '<removed>'}
  351. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_postgres_exporter_metrics_proxying_enabled', 'new': '<removed>'}
  352. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_postgres_exporter_matrix_nginx_proxy_not_enabled_proxy_pass_host', 'new': '<removed>'}
  353. - {'old': 'matrix_docker_network', 'new': '<removed in favor of various other variables - matrix_addons_container_network, matrix_monitoring_container_network, matrix_homeserver_container_network, etc.>'}
  354. - {'old': 'matrix_playbook_ssl_retrieval_method', 'new': '<removed; see docs/configuring-playbook-ssl-certificates.md for alternatives>'}
  355. - {'old': 'matrix_ssl_lets_encrypt_support_email', 'new': 'traefik_config_certificatesResolvers_acme_email'}
  356. - {'old': 'matrix_federation_traefik_entrypoint', 'new': 'matrix_federation_traefik_entrypoint_name'}
  357. - when: matrix_playbook_migration_matrix_nginx_proxy_leftover_variable_validation_checks_enabled | bool
  358. block:
  359. - ansible.builtin.set_fact:
  360. matrix_playbook_migration_nginx_proxy_migration_vars: |-
  361. {{ lookup('ansible.builtin.varnames', '^matrix_nginx_proxy_.+', wantlist=True) }}
  362. - name: (Deprecation) Catch and report leftover matrix_nginx_proxy variables
  363. ansible.builtin.fail:
  364. msg: >-
  365. The matrix-nginx-proxy role that used to be part of this playbook has been removed.
  366. You should remove all its variables (`matrix_nginx_proxy_*`) from your configuration file (vars.yml).
  367. The following variables in your configuration should be renamed: {{ matrix_playbook_migration_nginx_proxy_migration_vars.keys() | join(', ') }}
  368. when: "matrix_playbook_migration_nginx_proxy_migration_vars | length > 0"
  369. - when: matrix_playbook_migration_matrix_ssl_leftover_variable_checks_enabled | bool
  370. block:
  371. - ansible.builtin.set_fact:
  372. matrix_playbook_migration_ssl_migration_vars: |-
  373. {{ lookup('ansible.builtin.varnames', '^matrix_ssl_.+', wantlist=True) }}
  374. - name: (Deprecation) Catch and report matrix_ssl variables
  375. ansible.builtin.fail:
  376. msg: >-
  377. The matrix-nginx-proxy role that used to be part of this playbook has been removed.
  378. You should remove all its variables (`matrix_ssl_*`) from your configuration file (vars.yml).
  379. The following variables in your configuration should be renamed: {{ matrix_playbook_migration_ssl_migration_vars.keys() | join(', ') }}
  380. when: "matrix_playbook_migration_ssl_migration_vars | length > 0"
  381. - block:
  382. - ansible.builtin.set_fact:
  383. matrix_playbook_migration_matrix_synapse_container_labels_public_client_synapse_oidc_vars: |-
  384. {{ lookup('ansible.builtin.varnames', '^matrix_synapse_container_labels_public_client_synapse_oidc_.+', wantlist=True) }}
  385. - name: (Deprecation) Catch and report matrix_ssl variables
  386. ansible.builtin.fail:
  387. msg: >-
  388. We found usage of the following variables which are now removed: {{ matrix_playbook_migration_matrix_synapse_container_labels_public_client_synapse_oidc_vars.keys() | join(', ') }}
  389. when: "matrix_playbook_migration_matrix_synapse_container_labels_public_client_synapse_oidc_vars | length > 0"
  390. - block:
  391. - ansible.builtin.set_fact:
  392. matrix_playbook_migration_matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_vars: |-
  393. {{ lookup('ansible.builtin.varnames', '^matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_.+', wantlist=True) }}
  394. - name: (Deprecation) Catch and report matrix_ssl variables
  395. ansible.builtin.fail:
  396. msg: >-
  397. We found usage of the following variables which are now removed: {{ matrix_playbook_migration_matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_vars.keys() | join(', ') }}
  398. when: "matrix_playbook_migration_matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_vars | length > 0"
  399. - name: (Deprecation) Catch and report devture_postgres_backup variables
  400. ansible.builtin.fail:
  401. msg: |-
  402. The postgres-backup role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup).
  403. The new role is pretty much the same, but uses differently named variables.
  404. Please rename all `devture_postgres_backup_`-prefixed variables (`devture_postgres_backup_*` -> `postgres_backup_*`) on your configuration file (vars.yml).
  405. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  406. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_postgres_backup_.+', wantlist=True) | join(', ') }}
  407. when: "lookup('ansible.builtin.varnames', '^devture_postgres_backup_.+', wantlist=True) | length > 0"
  408. - name: (Deprecation) Catch and report devture_postgres variables
  409. ansible.builtin.fail:
  410. msg: |-
  411. The Postgres role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-postgres).
  412. The new role is pretty much the same, but uses differently named variables.
  413. Please rename all `devture_postgres_`-prefixed variables (`devture_postgres_*` -> `postgres_*`) on your configuration file (vars.yml).
  414. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  415. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_postgres_.+', wantlist=True) | join(', ') }}
  416. when: "lookup('ansible.builtin.varnames', '^devture_postgres_.+', wantlist=True) | length > 0"
  417. - name: (Deprecation) Catch and report traefik_certs_dumper variables
  418. ansible.builtin.fail:
  419. msg: |-
  420. The traefik-certs-dumper role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-traefik-certs-dumper).
  421. The new role is pretty much the same, but uses differently named variables.
  422. Please rename all `devture_traefik_certs_dumper_`-prefixed variables (`devture_traefik_certs_dumper_*` -> `traefik_certs_dumper_*`) on your configuration file (vars.yml).
  423. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  424. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_traefik_certs_dumper_.+', wantlist=True) | join(', ') }}
  425. when: "lookup('ansible.builtin.varnames', '^devture_traefik_certs_dumper_.+', wantlist=True) | length > 0"
  426. - name: (Deprecation) Catch and report devture_traefik variables
  427. ansible.builtin.fail:
  428. msg: |-
  429. The traefik role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-traefik).
  430. The new role is pretty much the same, but uses differently named variables.
  431. Please rename all `devture_traefik_`-prefixed variables (`devture_traefik_*` -> `traefik_*`) on your configuration file (vars.yml).
  432. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  433. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_traefik_.+', wantlist=True) | join(', ') }}
  434. when: "lookup('ansible.builtin.varnames', '^devture_traefik_.+', wantlist=True) | length > 0"
  435. - name: (Deprecation) Catch and report devture_container_socket_proxy variables
  436. ansible.builtin.fail:
  437. msg: |-
  438. The container-socket-proxy role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-container-socket-proxy).
  439. The new role is pretty much the same, but uses differently named variables.
  440. Please rename all `devture_container_socket_proxy_`-prefixed variables (`devture_container_socket_proxy_*` -> `container_socket_proxy_*`) on your configuration file (vars.yml).
  441. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  442. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_container_socket_proxy_.+', wantlist=True) | join(', ') }}
  443. when: "lookup('ansible.builtin.varnames', '^devture_container_socket_proxy_.+', wantlist=True) | length > 0"
  444. - name: (Deprecation) Catch and report ma1sd variables
  445. ansible.builtin.fail:
  446. msg: |-
  447. ma1sd was completely removed from the playbook in February 2026.
  448. Please remove all `matrix_ma1sd_*` variables from your configuration file (vars.yml).
  449. You may also wish to uninstall the component manually. See `docs/configuring-playbook-ma1sd.md` for more information.
  450. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_ma1sd_.+', wantlist=True) | join(', ') }}
  451. when: "lookup('ansible.builtin.varnames', '^matrix_ma1sd_.+', wantlist=True) | length > 0"
  452. - name: (Deprecation) Catch and report matrix-appservice-webhooks variables
  453. ansible.builtin.fail:
  454. msg: |-
  455. matrix-appservice-webhooks was completely removed from the playbook in November 2025.
  456. Please remove all `matrix_appservice_webhooks_*` variables from your configuration file (vars.yml).
  457. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-appservice-webhooks.md` for more information.
  458. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_appservice_webhooks_.+', wantlist=True) | join(', ') }}
  459. when: "lookup('ansible.builtin.varnames', '^matrix_appservice_webhooks_.+', wantlist=True) | length > 0"
  460. - name: (Deprecation) Catch and report matrix-chatgpt-bot variables
  461. ansible.builtin.fail:
  462. msg: |-
  463. matrix-chatgpt-bot was completely removed from the playbook in November 2025.
  464. Please remove all `matrix_bot_chatgpt_*` variables from your configuration file (vars.yml).
  465. You may also wish to uninstall the bot manually. See `docs/configuring-playbook-bot-chatgpt.md` for more information.
  466. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_bot_chatgpt_.+', wantlist=True) | join(', ') }}
  467. when: "lookup('ansible.builtin.varnames', '^matrix_bot_chatgpt_.+', wantlist=True) | length > 0"
  468. - name: (Deprecation) Catch and report matrix-client-cinny variables
  469. ansible.builtin.fail:
  470. msg: |-
  471. The matrix-client-cinny role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-cinny).
  472. The new role is pretty much the same, but uses differently named variables.
  473. Please rename all `matrix_client_cinny_`-prefixed variables (`matrix_client_cinny_*` -> `cinny_*`) on your configuration file (vars.yml).
  474. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  475. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_client_cinny_.+', wantlist=True) | join(', ') }}
  476. when: "lookup('ansible.builtin.varnames', '^matrix_client_cinny_.+', wantlist=True) | length > 0"
  477. - name: (Deprecation) Catch and report matrix-client-hydrogen variables
  478. ansible.builtin.fail:
  479. msg: |-
  480. The matrix-client-hydrogen role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-hydrogen).
  481. The new role is pretty much the same, but uses differently named variables.
  482. Please rename all `matrix_client_hydrogen_`-prefixed variables (`matrix_client_hydrogen_*` -> `hydrogen_*`) on your configuration file (vars.yml).
  483. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  484. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_client_hydrogen_.+', wantlist=True) | join(', ') }}
  485. when: "lookup('ansible.builtin.varnames', '^matrix_client_hydrogen_.+', wantlist=True) | length > 0"
  486. - name: (Deprecation) Catch and report matrix-coturn variables
  487. ansible.builtin.fail:
  488. msg: |-
  489. The matrix-coturn role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-coturn).
  490. The new role is pretty much the same, but uses differently named variables.
  491. Please rename all `matrix_coturn_`-prefixed variables (`matrix_coturn_*` -> `coturn_*`) on your configuration file (vars.yml).
  492. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  493. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_coturn_.+', wantlist=True) | join(', ') }}
  494. when: "lookup('ansible.builtin.varnames', '^matrix_coturn_.+', wantlist=True) | length > 0"
  495. - name: (Deprecation) Catch and report matrix-conduwuit variables
  496. ansible.builtin.fail:
  497. msg: |-
  498. matrix-conduwuit was completely removed from the playbook in February 2026.
  499. Please remove all `matrix_conduwuit*` variables from your configuration file (vars.yml).
  500. You may wish to migrate to Continuwuity, a drop-in replacement for conduwuit. See `docs/configuring-playbook-continuwuity.md` for more information.
  501. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_conduwuit.+', wantlist=True) | join(', ') }}
  502. when: "lookup('ansible.builtin.varnames', '^matrix_conduwuit.+', wantlist=True) | length > 0"
  503. - name: (Deprecation) Catch and report matrix-dynamic-dns variables
  504. ansible.builtin.fail:
  505. msg: |-
  506. The matrix-dynamic-dns role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-ddclient).
  507. The new role is pretty much the same, but uses differently named variables.
  508. Please rename all `matrix_dynamic_dns_`-prefixed variables (`matrix_dynamic_dns_*` -> `ddclient_*`) on your configuration file (vars.yml).
  509. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  510. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_dynamic_dns_.+', wantlist=True) | join(', ') }}
  511. when: "lookup('ansible.builtin.varnames', '^matrix_dynamic_dns_.+', wantlist=True) | length > 0"
  512. - name: (Deprecation) Catch and report matrix-synapse-admin variables
  513. ansible.builtin.fail:
  514. msg: |-
  515. The matrix-synapse-admin role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-synapse-admin).
  516. The new role is pretty much the same, but uses differently named variables.
  517. Please rename all `matrix_synapse_admin_`-prefixed variables (`matrix_synapse_admin_*` -> `synapse_admin_*`) on your configuration file (vars.yml).
  518. After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
  519. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_synapse_admin_.+', wantlist=True) | join(', ') }}
  520. when: "lookup('ansible.builtin.varnames', '^matrix_synapse_admin_.+', wantlist=True) | length > 0"
  521. - name: (Deprecation) Catch and report mautrix-facebook variables
  522. ansible.builtin.fail:
  523. msg: |-
  524. mautrix-facebook was completely removed from the playbook in November 2025.
  525. Please remove all `matrix_mautrix_facebook_*` variables from your configuration file (vars.yml).
  526. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mautrix-facebook.md` for more information.
  527. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mautrix_facebook_.+', wantlist=True) | join(', ') }}
  528. when: "lookup('ansible.builtin.varnames', '^matrix_mautrix_facebook_.+', wantlist=True) | length > 0"
  529. - name: (Deprecation) Catch and report mautrix-hangouts variables
  530. ansible.builtin.fail:
  531. msg: |-
  532. The Google Hangouts service was discontinued on 1st of November 2022.
  533. The mautrix-hangouts bridge has been deprecated in the playbook since December 2024 and was completely removed from the playbook in February 2025.
  534. Please remove all `matrix_mautrix_hangouts_*` variables from your configuration file (vars.yml).
  535. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mautrix-hangouts.md` for more information.
  536. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mautrix_hangouts_.+', wantlist=True) | join(', ') }}
  537. when: "lookup('ansible.builtin.varnames', '^matrix_mautrix_hangouts_.+', wantlist=True) | length > 0"
  538. - name: (Deprecation) Catch and report mautrix-instagram variables
  539. ansible.builtin.fail:
  540. msg: |-
  541. mautrix-instagram was completely removed from the playbook in November 2025.
  542. Please remove all `matrix_mautrix_instagram_*` variables from your configuration file (vars.yml).
  543. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mautrix-instagram.md` for more information.
  544. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mautrix_instagram_.+', wantlist=True) | join(', ') }}
  545. when: "lookup('ansible.builtin.varnames', '^matrix_mautrix_instagram_.+', wantlist=True) | length > 0"
  546. - name: (Deprecation) Catch and report mx-puppet-discord variables
  547. ansible.builtin.fail:
  548. msg: |-
  549. The MX Puppet Discord bridge was completely removed from the playbook in November 2025.
  550. Please remove all `matrix_mx_puppet_discord_*` variables from your configuration file (vars.yml).
  551. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mx-puppet-discord.md` for more information.
  552. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mx_puppet_discord_.+', wantlist=True) | join(', ') }}
  553. when: "lookup('ansible.builtin.varnames', '^matrix_mx_puppet_discord_.+', wantlist=True) | length > 0"
  554. - name: (Deprecation) Catch and report mx-puppet-instagram variables
  555. ansible.builtin.fail:
  556. msg: |-
  557. The MX Puppet Instagram bridge was completely removed from the playbook in November 2025.
  558. Please remove all `matrix_mx_puppet_instagram_*` variables from your configuration file (vars.yml).
  559. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mx-puppet-instagram.md` for more information.
  560. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mx_puppet_instagram_.+', wantlist=True) | join(', ') }}
  561. when: "lookup('ansible.builtin.varnames', '^matrix_mx_puppet_instagram_.+', wantlist=True) | length > 0"
  562. - name: (Deprecation) Catch and report mx-puppet-slack variables
  563. ansible.builtin.fail:
  564. msg: |-
  565. The MX Puppet Slack bridge was completely removed from the playbook in November 2025.
  566. Please remove all `matrix_mx_puppet_slack_*` variables from your configuration file (vars.yml).
  567. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mx-puppet-slack.md` for more information.
  568. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mx_puppet_slack_.+', wantlist=True) | join(', ') }}
  569. when: "lookup('ansible.builtin.varnames', '^matrix_mx_puppet_slack_.+', wantlist=True) | length > 0"
  570. - name: (Deprecation) Catch and report mx-puppet-twitter variables
  571. ansible.builtin.fail:
  572. msg: |-
  573. The MX Puppet Twitter bridge was completely removed from the playbook in November 2025.
  574. Please remove all `matrix_mx_puppet_twitter_*` variables from your configuration file (vars.yml).
  575. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mx-puppet-twitter.md` for more information.
  576. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mx_puppet_twitter_.+', wantlist=True) | join(', ') }}
  577. when: "lookup('ansible.builtin.varnames', '^matrix_mx_puppet_twitter_.+', wantlist=True) | length > 0"
  578. - name: (Deprecation) Catch and report the Dimension integration manager variables
  579. ansible.builtin.fail:
  580. msg: |-
  581. The Dimension integration manager was completely removed from the playbook in February 2026.
  582. Please remove all `matrix_dimension_*` variables from your configuration file (vars.yml).
  583. You may also wish to uninstall the component manually. See `docs/configuring-playbook-dimension.md` for more information.
  584. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_dimension_.+', wantlist=True) | join(', ') }}
  585. when: "lookup('ansible.builtin.varnames', '^matrix_dimension_.+', wantlist=True) | length > 0"
  586. - name: (Deprecation) Catch and report Email2Matrix variables
  587. ansible.builtin.fail:
  588. msg: |-
  589. The Email2Matrix service has been superseded by the Postmoogle bridge for a long time now and was completely removed from the playbook in February 2025.
  590. Please remove all `matrix_email2matrix_*` variables from your configuration file (vars.yml).
  591. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-email2matrix.md` for more information.
  592. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_email2matrix_.+', wantlist=True) | join(', ') }}
  593. when: "lookup('ansible.builtin.varnames', '^matrix_email2matrix_.+', wantlist=True) | length > 0"
  594. - name: (Deprecation) Catch and report go-skype-bridge variables
  595. ansible.builtin.fail:
  596. msg: |-
  597. The go-skype-bridge was completely removed from the playbook in November 2025, as Skype has been discontinued since May 2025.
  598. Please remove all `matrix_go_skype_bridge_*` variables from your configuration file (vars.yml).
  599. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-go-skype-bridge.md` for more information.
  600. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_go_skype_bridge_.+', wantlist=True) | join(', ') }}
  601. when: "lookup('ansible.builtin.varnames', '^matrix_go_skype_bridge_.+', wantlist=True) | length > 0"
  602. - name: (Deprecation) Catch and report the Sliding Sync proxy variables
  603. ansible.builtin.fail:
  604. msg: |-
  605. The Sliding Sync proxy was completely removed from the playbook in November 2025.
  606. Please remove all `matrix_sliding_sync_*` variables from your configuration file (vars.yml).
  607. You may also wish to uninstall the proxy manually. See `docs/configuring-playbook-sliding-sync-proxy.md` for more information.
  608. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_sliding_sync_.+', wantlist=True) | join(', ') }}
  609. when: "lookup('ansible.builtin.varnames', '^matrix_sliding_sync_.+', wantlist=True) | length > 0"