|
- # SPDX-FileCopyrightText: 2020 - 2025 Slavi Pantaleev
- # SPDX-FileCopyrightText: 2022 MDAD project contributors
- # SPDX-FileCopyrightText: 2025 Suguru Hirahara
- #
- # SPDX-License-Identifier: AGPL-3.0-or-later
-
- ---
-
- - name: Fail if matrix-synapse-admin is enabled for a non-Synapse homeserver
- ansible.builtin.fail:
- msg: >-
- matrix-synapse-admin can only be used with the Synapse homeserver implementation.
- Your configuration has `matrix_synapse_admin_enabled: true`, but `matrix_homeserver_implementation` is set to `{{ matrix_homeserver_implementation }}`.
- Disable matrix-synapse-admin or switch to Synapse.
- when:
- - matrix_synapse_admin_enabled | bool
- - matrix_homeserver_implementation != 'synapse'
-
- - name: (Deprecation) Catch and report renamed matrix-synapse-admin settings
- ansible.builtin.fail:
- msg: >-
- Your configuration contains a variable, which now has a different name.
- Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
- when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
- with_items:
- - {'old': 'matrix_synapse_admin_docker_repo', 'new': 'matrix_synapse_admin_container_self_build_repo'}
- - {'old': 'matrix_synapse_admin_container_self_build', 'new': 'matrix_synapse_admin_container_image_self_build'}
- - {'old': 'matrix_synapse_admin_container_self_build_repo', 'new': 'matrix_synapse_admin_container_image_self_build_repo'}
- - {'old': 'matrix_synapse_admin_public_endpoint', 'new': 'matrix_synapse_admin_path_prefix'}
- - {'old': 'matrix_synapse_admin_nginx_proxy_integration_enabled', 'new': '<removed>'}
- - {'old': 'matrix_synapse_admin_docker_image_name_prefix', 'new': 'matrix_synapse_admin_container_image_registry_prefix'}
- - {'old': 'matrix_synapse_admin_docker_image', 'new': 'matrix_synapse_admin_container_image'}
- - {'old': 'matrix_synapse_admin_docker_image_force_pull', 'new': 'matrix_synapse_admin_container_image_force_pull'}
- - {'old': 'matrix_synapse_admin_docker_image_registry_prefix', 'new': 'matrix_synapse_admin_container_image_registry_prefix'}
- - {'old': 'matrix_synapse_admin_docker_image_registry_prefix_upstream', 'new': 'matrix_synapse_admin_container_image_registry_prefix_upstream'}
- - {'old': 'matrix_synapse_admin_docker_image_registry_prefix_upstream_default', 'new': 'matrix_synapse_admin_container_image_registry_prefix_upstream_default'}
- - {'old': 'matrix_synapse_admin_docker_src_files_path', 'new': 'matrix_synapse_admin_container_src_files_path'}
-
- - when: matrix_synapse_admin_container_labels_traefik_enabled | bool
- block:
- - name: Fail if required matrix-synapse-admin Traefik settings not defined
- ansible.builtin.fail:
- msg: >-
- You need to define a required configuration setting (`{{ item }}`).
- when: "lookup('vars', item, default='') == ''"
- with_items:
- - matrix_synapse_admin_container_labels_traefik_hostname
- - matrix_synapse_admin_container_labels_traefik_path_prefix
-
- # We ensure it doesn't end with a slash, because we handle both (slash and no-slash).
- # Knowing that `matrix_synapse_admin_container_labels_traefik_path_prefix` does not end with a slash
- # ensures we know how to set these routes up without having to do "does it end with a slash" checks elsewhere.
- - name: Fail if matrix_synapse_admin_container_labels_traefik_path_prefix ends with a slash
- ansible.builtin.fail:
- msg: >-
- matrix_synapse_admin_container_labels_traefik_path_prefix (`{{ matrix_synapse_admin_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/synapse-admin`).
- when: "matrix_synapse_admin_container_labels_traefik_path_prefix != '/' and matrix_synapse_admin_container_labels_traefik_path_prefix[-1] == '/'"
|
