Matrix Docker Ansible eploy
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

585 строки
44 KiB

  1. # SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2024 - 2025 MDAD project contributors
  3. # SPDX-FileCopyrightText: 2024 - 2025 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. - name: (Deprecation) Catch and report matrix_postgres variables
  65. ansible.builtin.fail:
  66. msg: |-
  67. 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).
  68. The new role is pretty much the same, but uses differently named variables.
  69. 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).
  70. The new role is pretty much the same, but uses differently named variables.
  71. Please rename all `matrix_postgres`-prefixed variables (`matrix_postgres_*` -> `postgres_*`) on your configuration file (vars.yml).
  72. 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.
  73. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_postgres_.+', wantlist=True) | join(', ') }}
  74. when: "lookup('ansible.builtin.varnames', '^matrix_postgres_.+', wantlist=True) | length > 0"
  75. - name: (Deprecation) Catch and report matrix_mailer_ variables
  76. ansible.builtin.fail:
  77. msg: |-
  78. 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).
  79. The new role is pretty much the same, but uses differently named variables.
  80. Please rename all `matrix_mailer`-prefixed variables (`matrix_mailer_*` -> `exim_relay_*`) on your configuration file (vars.yml).
  81. 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.
  82. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_mailer_.+', wantlist=True) | join(', ') }}
  83. when: "lookup('ansible.builtin.varnames', '^matrix_mailer_.+', wantlist=True) | length > 0"
  84. - when: matrix_playbook_migration_matrix_prometheus_node_exporter_migration_validation_enabled | bool
  85. block:
  86. - ansible.builtin.set_fact:
  87. matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars: |-
  88. {{ lookup('ansible.builtin.varnames', '^matrix_prometheus_node_exporter_.+', wantlist=True) }}
  89. - name: (Deprecation) Catch and report matrix_prometheus_node_exporter variables
  90. ansible.builtin.fail:
  91. msg: >-
  92. 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.
  93. The new role is compatible with the old one, but uses different names for its variables.
  94. Please rename all variables (`matrix_prometheus_node_exporter_` -> `prometheus_node_exporter_`) on your configuration file (vars.yml).
  95. 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.
  96. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars | join(', ') }}
  97. when: "matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars | length > 0"
  98. - when: matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_validation_enabled | bool
  99. block:
  100. - ansible.builtin.set_fact:
  101. matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars: |-
  102. {{ lookup('ansible.builtin.varnames', '^matrix_prometheus_postgres_exporter_.+', wantlist=True) }}
  103. - name: (Deprecation) Catch and report matrix_prometheus_postgres_exporter variables
  104. ansible.builtin.fail:
  105. msg: >-
  106. 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.
  107. The new role is compatible with the old one, but uses different names for its variables.
  108. Please rename all variables (`matrix_prometheus_postgres_exporter_` -> `prometheus_postgres_exporter_`) on your configuration file (vars.yml).
  109. 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.
  110. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars.keys() | join(', ') }}
  111. when: "matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars | length > 0"
  112. - when: matrix_playbook_migration_matrix_backup_borg_migration_validation_enabled | bool
  113. block:
  114. - ansible.builtin.set_fact:
  115. matrix_playbook_migration_backup_borg_migration_vars: |-
  116. {{ lookup('ansible.builtin.varnames', '^matrix_backup_borg_.+', wantlist=True) }}
  117. - name: (Deprecation) Catch and report matrix_backup_borg variables
  118. ansible.builtin.fail:
  119. msg: >-
  120. 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.
  121. The new role is compatible with the old one, but uses different names for its variables.
  122. Please rename all variables (`matrix_backup_borg_` -> `backup_borg_`) on your configuration file (vars.yml).
  123. 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.
  124. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_backup_borg_migration_vars.keys() | join(', ') }}
  125. when: "matrix_playbook_migration_backup_borg_migration_vars | length > 0"
  126. - when: matrix_playbook_migration_matrix_grafana_migration_validation_enabled | bool
  127. block:
  128. - ansible.builtin.set_fact:
  129. matrix_playbook_migration_grafana_migration_vars: |-
  130. {{ lookup('ansible.builtin.varnames', '^matrix_grafana_.+', wantlist=True) }}
  131. - name: (Deprecation) Catch and report matrix_grafana variables
  132. ansible.builtin.fail:
  133. msg: >-
  134. 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.
  135. The new role is compatible with the old one, but uses different names for its variables.
  136. Please rename all variables (`matrix_grafana_` -> `grafana_`) on your configuration file (vars.yml).
  137. 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.
  138. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_grafana_migration_vars.keys() | join(', ') }}
  139. when: "matrix_playbook_migration_grafana_migration_vars | length > 0"
  140. - when: matrix_playbook_migration_matrix_ntfy_migration_validation_enabled | bool
  141. block:
  142. - ansible.builtin.set_fact:
  143. matrix_playbook_migration_ntfy_migration_vars: |-
  144. {{ lookup('ansible.builtin.varnames', '^matrix_ntfy_.+', wantlist=True) }}
  145. - name: (Deprecation) Catch and report matrix_ntfy variables
  146. ansible.builtin.fail:
  147. msg: >-
  148. 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.
  149. The new role is compatible with the old one, but uses different names for its variables.
  150. Please rename all variables (`matrix_ntfy_` -> `ntfy_`) on your configuration file (vars.yml).
  151. 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.
  152. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_ntfy_migration_vars.keys() | join(', ') }}
  153. when: "matrix_playbook_migration_ntfy_migration_vars | length > 0"
  154. - when: matrix_playbook_migration_matrix_redis_migration_validation_enabled | bool
  155. block:
  156. - ansible.builtin.set_fact:
  157. matrix_playbook_migration_redis_migration_vars: |-
  158. {{ lookup('ansible.builtin.varnames', '^matrix_redis_.+', wantlist=True) }}
  159. - name: (Deprecation) Catch and report matrix_redis variables
  160. ansible.builtin.fail:
  161. msg: >-
  162. 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.
  163. The new role is compatible with the old one, but uses different names for its variables.
  164. Please rename all variables (`matrix_redis_` -> `redis_`) on your configuration file (vars.yml).
  165. 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.
  166. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
  167. when: "matrix_playbook_migration_redis_migration_vars | length > 0"
  168. - when: matrix_playbook_migration_redis_valkey_migration_validation_enabled | bool
  169. block:
  170. - ansible.builtin.set_fact:
  171. matrix_playbook_migration_redis_migration_vars: |-
  172. {{ lookup('ansible.builtin.varnames', '^redis_.+', wantlist=True) }}
  173. - name: (Deprecation) Catch and report matrix_redis variables
  174. ansible.builtin.fail:
  175. msg: >-
  176. 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.
  177. Please rename all variables (`redis_` -> `valkey_`) on your configuration file (vars.yml).
  178. 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.
  179. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
  180. when: "matrix_playbook_migration_redis_migration_vars | length > 0"
  181. - when: matrix_playbook_migration_keydb_valkey_migration_validation_enabled | bool
  182. block:
  183. - ansible.builtin.set_fact:
  184. matrix_playbook_migration_keydb_migration_vars: |-
  185. {{ lookup('ansible.builtin.varnames', '^keydb_.+', wantlist=True) }}
  186. - name: (Deprecation) Catch and report matrix_redis variables
  187. ansible.builtin.fail:
  188. msg: >-
  189. 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.
  190. Please rename all variables (`keydb_` -> `valkey_`) on your configuration file (vars.yml).
  191. 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.
  192. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_keydb_migration_vars.keys() | join(', ') }}
  193. when: "matrix_playbook_migration_keydb_migration_vars | length > 0"
  194. - when: matrix_playbook_migration_matrix_etherpad_migration_validation_enabled | bool
  195. block:
  196. - ansible.builtin.set_fact:
  197. matrix_playbook_migration_etherpad_migration_vars: |-
  198. {{ lookup('ansible.builtin.varnames', '^matrix_etherpad_.+', wantlist=True) }}
  199. - name: (Deprecation) Catch and report matrix_etherpad variables
  200. ansible.builtin.fail:
  201. msg: >-
  202. 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.
  203. The new role is compatible with the old one, but uses different names for its variables.
  204. Please rename all variables (`matrix_etherpad_` -> `etherpad_`) on your configuration file (vars.yml).
  205. 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.
  206. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_etherpad_migration_vars.keys() | join(', ') }}
  207. when: "matrix_playbook_migration_etherpad_migration_vars | length > 0"
  208. - when: matrix_playbook_migration_matrix_aux_migration_validation_enabled | bool
  209. block:
  210. - ansible.builtin.set_fact:
  211. matrix_playbook_migration_aux_migration_vars: |-
  212. {{ lookup('ansible.builtin.varnames', '^matrix_aux_.+', wantlist=True) }}
  213. - name: (Deprecation) Catch and report matrix_aux variables
  214. ansible.builtin.fail:
  215. msg: >-
  216. 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.
  217. The new role is compatible with the old one, but uses different names for its variables.
  218. Please rename all variables (`matrix_aux_` -> `aux_`) on your configuration file (vars.yml).
  219. 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.
  220. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_aux_migration_vars.keys() | join(', ') }}
  221. when: "matrix_playbook_migration_aux_migration_vars | length > 0"
  222. - when: matrix_playbook_migration_matrix_jitsi_migration_validation_enabled | bool
  223. block:
  224. - ansible.builtin.set_fact:
  225. matrix_playbook_migration_jitsi_migration_vars: |-
  226. {{ lookup('ansible.builtin.varnames', '^matrix_jitsi_.+', wantlist=True) }}
  227. - name: (Deprecation) Catch and report matrix_jitsi variables
  228. ansible.builtin.fail:
  229. msg: >-
  230. 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.
  231. The new role is compatible with the old one, but uses different names for its variables.
  232. Please rename all variables (`matrix_jitsi_` -> `jitsi_`) on your configuration file (vars.yml).
  233. 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.
  234. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_jitsi_migration_vars.keys() | join(', ') }}
  235. when: "matrix_playbook_migration_jitsi_migration_vars | length > 0"
  236. - when: matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled | bool
  237. block:
  238. - ansible.builtin.set_fact:
  239. matrix_playbook_migration_postmoogle_migration_vars: |-
  240. {{ lookup('ansible.builtin.varnames', '^matrix_bot_postmoogle_.+', wantlist=True) }}
  241. - name: (Deprecation) Catch and report matrix_bot_postmoogle variables
  242. ansible.builtin.fail:
  243. msg: >-
  244. Your configuration contains a variable, which now has a different name.
  245. Please rename all variables (`matrix_bot_postmoogle_` -> `matrix_postmoogle_`) on your configuration file (vars.yml).
  246. The following variables in your configuration need to be renamed: {{ matrix_playbook_migration_postmoogle_migration_vars.keys() | join(', ') }}
  247. when: "matrix_playbook_migration_postmoogle_migration_vars | length > 0"
  248. - when: matrix_playbook_migration_matrix_nginx_proxy_elimination_variable_transition_checks_enabled | bool
  249. block:
  250. - name: (Deprecation) Catch and report transitioned playbook settings during the matrix-nginx-proxy elimination
  251. ansible.builtin.fail:
  252. msg: >-
  253. Your configuration contains a variable, which now has a different name.
  254. Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
  255. when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
  256. with_items:
  257. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_enabled', 'new': 'matrix_metrics_exposure_enabled'}
  258. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_enabled', 'new': 'matrix_metrics_exposure_http_basic_auth_enabled'}
  259. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_username', 'new': '<superseded by matrix_metrics_exposure_http_basic_auth_users>'}
  260. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_password', 'new': '<superseded by matrix_metrics_exposure_http_basic_auth_users>'}
  261. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_basic_auth_raw_content', 'new': '<superseded by matrix_metrics_exposure_http_basic_auth_users>'}
  262. - {'old': 'matrix_nginx_proxy_proxy_matrix_metrics_additional_location_configuration_blocks', 'new': '<superseded by adding labels to each individual service that you care about>'}
  263. - {'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>'}
  264. - {'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>'}
  265. - {'old': 'matrix_well_known_matrix_server_enabled', 'new': 'matrix_static_files_file_matrix_server_enabled'}
  266. - {'old': 'matrix_well_known_matrix_support_enabled', 'new': 'matrix_static_files_file_matrix_support_enabled'}
  267. - {'old': 'matrix_homeserver_admin_contacts', 'new': 'matrix_static_files_file_matrix_support_property_m_contacts'}
  268. - {'old': 'matrix_homeserver_support_url', 'new': 'matrix_static_files_file_matrix_support_property_m_support_page'}
  269. - {'old': 'matrix_well_known_matrix_client_io_element_e2ee_default', 'new': 'matrix_static_files_file_matrix_client_property_io_element_e2ee_default'}
  270. - {'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'}
  271. - {'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'}
  272. - {'old': 'matrix_well_known_matrix_client_configuration_extension_json', 'new': 'matrix_static_files_file_matrix_client_configuration_extension_json'}
  273. - {'old': 'matrix_well_known_matrix_server_configuration_extension_json', 'new': 'matrix_static_files_file_matrix_server_configuration_extension_json'}
  274. - {'old': 'matrix_well_known_matrix_support_configuration_extension_json', 'new': 'matrix_static_files_file_matrix_support_configuration_extension_json'}
  275. - {'old': 'matrix_nginx_proxy_self_check_validate_certificates', 'new': 'matrix_static_files_self_check_validate_certificates'}
  276. - {'old': 'matrix_nginx_proxy_self_check_well_known_matrix_client_follow_redirects', 'new': 'matrix_static_files_self_check_well_known_matrix_client_follow_redirects'}
  277. - {'old': 'matrix_nginx_proxy_base_domain_serving_enabled', 'new': 'matrix_static_files_container_labels_base_domain_enabled'}
  278. - {'old': 'matrix_nginx_proxy_base_domain_hostname', 'new': 'matrix_static_files_container_labels_base_domain_traefik_hostname'}
  279. - {'old': 'matrix_nginx_proxy_base_domain_homepage_enabled', 'new': 'matrix_static_files_file_index_html_enabled'}
  280. - {'old': 'matrix_nginx_proxy_base_domain_homepage_template', 'new': 'matrix_static_files_file_index_html_template'}
  281. - {'old': 'matrix_nginx_proxy_base_domain_create_directory', 'new': '<no longer necessary; see matrix_static_files_file_index_html_enabled>'}
  282. - {'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>'}
  283. - {'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>'}
  284. - {'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>'}
  285. - {'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>'}
  286. - {'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'}
  287. - {'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>'}
  288. - {'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'}
  289. - {'old': 'matrix_nginx_proxy_proxy_matrix_identity_api_enabled', 'new': '<superseded by matrix_ma1sd_container_labels_traefik_enabled and matrix_ma1sd_container_labels_matrix_identity_enabled>'}
  290. - {'old': 'matrix_nginx_proxy_proxy_matrix_identity_api_addr_with_container', 'new': '<removed>'}
  291. - {'old': 'matrix_nginx_proxy_proxy_matrix_identity_api_addr_sans_container', 'new': '<removed>'}
  292. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled', 'new': '<superseded by matrix_ma1sd_container_labels_traefik_enabled and matrix_ma1sd_container_labels_matrix_client_user_directory_search_enabled>'}
  293. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_with_container', 'new': '<removed>'}
  294. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_addr_sans_container', 'new': '<removed>'}
  295. - {'old': 'matrix_nginx_proxy_proxy_matrix_user_directory_search_v3_to_r0_redirect_enabled', 'new': '<superseded by matrix_ma1sd_container_labels_matrix_client_user_directory_search_path_regexp>'}
  296. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_enabled', 'new': 'matrix_ma1sd_container_labels_matrix_client_3pid_registration_enabled'}
  297. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_with_container', 'new': '<removed>'}
  298. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_addr_sans_container', 'new': '<removed>'}
  299. - {'old': 'matrix_nginx_proxy_proxy_matrix_3pid_registration_v3_to_r0_redirect_enabled', 'new': '<superseded by matrix_ma1sd_container_labels_matrix_client_3pid_registration_path_regexp>'}
  300. - {'old': 'matrix_nginx_proxy_proxy_conduit_enabled', 'new': 'matrix_conduit_container_labels_traefik_enabled'}
  301. - {'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>'}
  302. - {'old': 'matrix_nginx_proxy_proxy_conduit_federation_api_enabled', 'new': 'matrix_conduit_container_labels_public_federation_api_enabled'}
  303. - {'old': 'matrix_nginx_proxy_proxy_conduit_client_api_addr_with_container', 'new': '<removed>'}
  304. - {'old': 'matrix_nginx_proxy_proxy_conduit_client_api_addr_sans_container', 'new': '<removed>'}
  305. - {'old': 'matrix_nginx_proxy_proxy_conduit_federation_api_addr_with_container', 'new': '<removed>'}
  306. - {'old': 'matrix_nginx_proxy_proxy_conduit_federation_api_addr_sans_container', 'new': '<removed>'}
  307. - {'old': 'matrix_nginx_proxy_proxy_conduit_additional_server_configuration_blocks', 'new': '<removed>'}
  308. - {'old': 'matrix_nginx_proxy_proxy_dendrite_enabled', 'new': 'matrix_dendrite_container_labels_traefik_enabled'}
  309. - {'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>'}
  310. - {'old': 'matrix_nginx_proxy_proxy_dendrite_federation_api_enabled', 'new': 'matrix_dendrite_container_labels_public_federation_api_enabled'}
  311. - {'old': 'matrix_nginx_proxy_proxy_dendrite_client_api_addr_with_container', 'new': '<removed>'}
  312. - {'old': 'matrix_nginx_proxy_proxy_dendrite_client_api_addr_sans_container', 'new': '<removed>'}
  313. - {'old': 'matrix_nginx_proxy_proxy_dendrite_federation_api_addr_with_container', 'new': '<removed>'}
  314. - {'old': 'matrix_nginx_proxy_proxy_dendrite_federation_api_addr_sans_container', 'new': '<removed>'}
  315. - {'old': 'matrix_nginx_proxy_proxy_dendrite_additional_server_configuration_blocks', 'new': '<removed>'}
  316. - {'old': 'matrix_nginx_proxy_proxy_synapse_enabled', 'new': 'matrix_synapse_container_labels_traefik_enabled'}
  317. - {'old': 'matrix_nginx_proxy_proxy_synapse_federation_api_enabled', 'new': 'matrix_synapse_container_labels_public_federation_api_enabled'}
  318. - {'old': 'matrix_nginx_proxy_proxy_synapse_client_api_addr_with_container', 'new': '<removed>'}
  319. - {'old': 'matrix_nginx_proxy_proxy_synapse_client_api_addr_sans_container', 'new': '<removed>'}
  320. - {'old': 'matrix_nginx_proxy_proxy_synapse_federation_api_addr_with_container', 'new': '<removed>'}
  321. - {'old': 'matrix_nginx_proxy_proxy_synapse_federation_api_addr_sans_container', 'new': '<removed>'}
  322. - {'old': 'matrix_nginx_proxy_proxy_synapse_additional_server_configuration_blocks', 'new': '<removed>'}
  323. - {'old': 'matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks', 'new': '<removed>'}
  324. - {'old': 'matrix_nginx_proxy_access_log_enabled', 'new': 'traefik_config_accessLog_enabled'}
  325. - {'old': 'matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_hostname', 'new': 'matrix_server_fqn_matrix_federation'}
  326. - {'old': 'etherpad_nginx_proxy_dimension_integration_enabled', 'new': '<removed>'}
  327. - {'old': 'etherpad_nginx_proxy_dimension_integration_path_prefix', 'new': '<removed>'}
  328. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_node_exporter_metrics_proxying_enabled', 'new': '<removed>'}
  329. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_node_exporter_matrix_nginx_proxy_not_enabled_proxy_pass_host', 'new': '<removed>'}
  330. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_postgres_exporter_metrics_proxying_enabled', 'new': '<removed>'}
  331. - {'old': 'matrix_prometheus_services_proxy_connect_prometheus_postgres_exporter_matrix_nginx_proxy_not_enabled_proxy_pass_host', 'new': '<removed>'}
  332. - {'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.>'}
  333. - {'old': 'matrix_playbook_ssl_retrieval_method', 'new': '<removed; see docs/configuring-playbook-ssl-certificates.md for alternatives>'}
  334. - {'old': 'matrix_ssl_lets_encrypt_support_email', 'new': 'traefik_config_certificatesResolvers_acme_email'}
  335. - {'old': 'matrix_federation_traefik_entrypoint', 'new': 'matrix_federation_traefik_entrypoint_name'}
  336. - when: matrix_playbook_migration_matrix_nginx_proxy_leftover_variable_validation_checks_enabled | bool
  337. block:
  338. - ansible.builtin.set_fact:
  339. matrix_playbook_migration_nginx_proxy_migration_vars: |-
  340. {{ lookup('ansible.builtin.varnames', '^matrix_nginx_proxy_.+', wantlist=True) }}
  341. - name: (Deprecation) Catch and report leftover matrix_nginx_proxy variables
  342. ansible.builtin.fail:
  343. msg: >-
  344. The matrix-nginx-proxy role that used to be part of this playbook has been removed.
  345. You should remove all its variables (`matrix_nginx_proxy_*`) from your configuration file (vars.yml).
  346. The following variables in your configuration should be renamed: {{ matrix_playbook_migration_nginx_proxy_migration_vars.keys() | join(', ') }}
  347. when: "matrix_playbook_migration_nginx_proxy_migration_vars | length > 0"
  348. - when: matrix_playbook_migration_matrix_ssl_leftover_variable_checks_enabled | bool
  349. block:
  350. - ansible.builtin.set_fact:
  351. matrix_playbook_migration_ssl_migration_vars: |-
  352. {{ lookup('ansible.builtin.varnames', '^matrix_ssl_.+', wantlist=True) }}
  353. - name: (Deprecation) Catch and report matrix_ssl variables
  354. ansible.builtin.fail:
  355. msg: >-
  356. The matrix-nginx-proxy role that used to be part of this playbook has been removed.
  357. You should remove all its variables (`matrix_ssl_*`) from your configuration file (vars.yml).
  358. The following variables in your configuration should be renamed: {{ matrix_playbook_migration_ssl_migration_vars.keys() | join(', ') }}
  359. when: "matrix_playbook_migration_ssl_migration_vars | length > 0"
  360. - block:
  361. - ansible.builtin.set_fact:
  362. matrix_playbook_migration_matrix_synapse_container_labels_public_client_synapse_oidc_vars: |-
  363. {{ lookup('ansible.builtin.varnames', '^matrix_synapse_container_labels_public_client_synapse_oidc_.+', wantlist=True) }}
  364. - name: (Deprecation) Catch and report matrix_ssl variables
  365. ansible.builtin.fail:
  366. msg: >-
  367. 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(', ') }}
  368. when: "matrix_playbook_migration_matrix_synapse_container_labels_public_client_synapse_oidc_vars | length > 0"
  369. - block:
  370. - ansible.builtin.set_fact:
  371. matrix_playbook_migration_matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_vars: |-
  372. {{ lookup('ansible.builtin.varnames', '^matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_.+', wantlist=True) }}
  373. - name: (Deprecation) Catch and report matrix_ssl variables
  374. ansible.builtin.fail:
  375. msg: >-
  376. 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(', ') }}
  377. when: "matrix_playbook_migration_matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_oidc_vars | length > 0"
  378. - name: (Deprecation) Catch and report devture_postgres_backup variables
  379. ansible.builtin.fail:
  380. msg: |-
  381. 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).
  382. The new role is pretty much the same, but uses differently named variables.
  383. Please rename all `devture_postgres_backup_`-prefixed variables (`devture_postgres_backup_*` -> `postgres_backup_*`) on your configuration file (vars.yml).
  384. 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.
  385. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_postgres_backup_.+', wantlist=True) | join(', ') }}
  386. when: "lookup('ansible.builtin.varnames', '^devture_postgres_backup_.+', wantlist=True) | length > 0"
  387. - name: (Deprecation) Catch and report devture_postgres variables
  388. ansible.builtin.fail:
  389. msg: |-
  390. The Postgres role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-postgres).
  391. The new role is pretty much the same, but uses differently named variables.
  392. Please rename all `devture_postgres_`-prefixed variables (`devture_postgres_*` -> `postgres_*`) on your configuration file (vars.yml).
  393. 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.
  394. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_postgres_.+', wantlist=True) | join(', ') }}
  395. when: "lookup('ansible.builtin.varnames', '^devture_postgres_.+', wantlist=True) | length > 0"
  396. - name: (Deprecation) Catch and report traefik_certs_dumper variables
  397. ansible.builtin.fail:
  398. msg: |-
  399. 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).
  400. The new role is pretty much the same, but uses differently named variables.
  401. Please rename all `devture_traefik_certs_dumper_`-prefixed variables (`devture_traefik_certs_dumper_*` -> `traefik_certs_dumper_*`) on your configuration file (vars.yml).
  402. 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.
  403. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_traefik_certs_dumper_.+', wantlist=True) | join(', ') }}
  404. when: "lookup('ansible.builtin.varnames', '^devture_traefik_certs_dumper_.+', wantlist=True) | length > 0"
  405. - name: (Deprecation) Catch and report devture_traefik variables
  406. ansible.builtin.fail:
  407. msg: |-
  408. The traefik role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-traefik).
  409. The new role is pretty much the same, but uses differently named variables.
  410. Please rename all `devture_traefik_`-prefixed variables (`devture_traefik_*` -> `traefik_*`) on your configuration file (vars.yml).
  411. 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.
  412. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_traefik_.+', wantlist=True) | join(', ') }}
  413. when: "lookup('ansible.builtin.varnames', '^devture_traefik_.+', wantlist=True) | length > 0"
  414. - name: (Deprecation) Catch and report devture_container_socket_proxy variables
  415. ansible.builtin.fail:
  416. msg: |-
  417. 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).
  418. The new role is pretty much the same, but uses differently named variables.
  419. Please rename all `devture_container_socket_proxy_`-prefixed variables (`devture_container_socket_proxy_*` -> `container_socket_proxy_*`) on your configuration file (vars.yml).
  420. 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.
  421. The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^devture_container_socket_proxy_.+', wantlist=True) | join(', ') }}
  422. when: "lookup('ansible.builtin.varnames', '^devture_container_socket_proxy_.+', wantlist=True) | length > 0"
  423. - name: (Deprecation) Catch and report mautrix-hangouts variables
  424. ansible.builtin.fail:
  425. msg: |-
  426. The Google Hangouts service was discontinued on 1st of November 2022.
  427. The mautrix-hangouts bridge has been deprecated in the playbook since December 2024 and was completely removed from the playbook in February 2025.
  428. Please remove all `matrix_mautrix_hangouts_*` variables from your configuration file (vars.yml).
  429. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mautrix-hangouts.md` for more information.
  430. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mautrix_hangouts_.+', wantlist=True) | join(', ') }}
  431. when: "lookup('ansible.builtin.varnames', '^matrix_mautrix_hangouts_.+', wantlist=True) | length > 0"
  432. - name: (Deprecation) Catch and report mx-puppet-twitter variables
  433. ansible.builtin.fail:
  434. msg: |-
  435. The MX Puppet Twitter bridge was completely removed from the playbook in November 2025.
  436. Please remove all `matrix_mx_puppet_twitter_*` variables from your configuration file (vars.yml).
  437. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mx-puppet-twitter.md` for more information.
  438. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mx_puppet_twitter_.+', wantlist=True) | join(', ') }}
  439. when: "lookup('ansible.builtin.varnames', '^matrix_mx_puppet_twitter_.+', wantlist=True) | length > 0"
  440. - name: (Deprecation) Catch and report Email2Matrix variables
  441. ansible.builtin.fail:
  442. msg: |-
  443. 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.
  444. Please remove all `matrix_email2matrix_*` variables from your configuration file (vars.yml).
  445. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-email2matrix.md` for more information.
  446. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_email2matrix_.+', wantlist=True) | join(', ') }}
  447. when: "lookup('ansible.builtin.varnames', '^matrix_email2matrix_.+', wantlist=True) | length > 0"
  448. - name: (Deprecation) Catch and report go-skype-bridge variables
  449. ansible.builtin.fail:
  450. msg: |-
  451. The go-skype-bridge was completely removed from the playbook in November 2025, as Skype has been discontinued since May 2025.
  452. Please remove all `matrix_go_skype_bridge_*` variables from your configuration file (vars.yml).
  453. You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-go-skype-bridge.md` for more information.
  454. The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_go_skype_bridge_.+', wantlist=True) | join(', ') }}
  455. when: "lookup('ansible.builtin.varnames', '^matrix_go_skype_bridge_.+', wantlist=True) | length > 0"