73 lines
4.7 KiB
YAML
73 lines
4.7 KiB
YAML
# SPDX-FileCopyrightText: 2020 - 2025 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2022 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2024 Suguru Hirahara
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
|
|
- name: Fail if required Element Web settings not defined
|
|
ansible.builtin.fail:
|
|
msg: >
|
|
You need to define a required configuration setting (`{{ item }}`) for using Element Web.
|
|
when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
|
|
with_items:
|
|
- {'name': 'matrix_client_element_default_hs_url', when: true}
|
|
- {'name': 'matrix_client_element_container_network', when: true}
|
|
- {'name': 'matrix_client_element_container_labels_traefik_compression_middleware_name', when: "{{ matrix_client_element_container_labels_traefik_compression_middleware_enabled }}"}
|
|
|
|
- name: Fail if Element location sharing enabled, but no tile server defined
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
You need to define at least one map tile server in matrix_client_element_location_sharing_map_style_content_sources_localsource_tiles list
|
|
when:
|
|
- matrix_client_element_location_sharing_enabled | bool
|
|
- matrix_client_element_location_sharing_map_style_content_sources_localsource_tiles | length == 0
|
|
|
|
- name: (Deprecation) Catch and report riot-web variables
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
Riot has been renamed to Element (https://element.io/blog/welcome-to-element/).
|
|
The playbook will migrate your existing configuration and data automatically, but you need to adjust variable names.
|
|
Please rename these variable (`matrix_riot_web_*` -> `matrix_client_element_*`) on your configuration file (vars.yml): {{ lookup('ansible.builtin.varnames', '^matrix_riot_web_.+', wantlist=True) | join(', ') }}
|
|
Also note that DNS configuration changes may be necessary.
|
|
when: "lookup('ansible.builtin.varnames', '^matrix_riot_web_.+', wantlist=True) | length > 0"
|
|
|
|
- name: (Deprecation) Catch and report renamed element-web 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_client_element_showLabsSettings', 'new': 'matrix_client_element_show_lab_settings'}
|
|
- {'old': 'matrix_client_element_permalinkPrefix', 'new': 'matrix_client_element_permalink_prefix'}
|
|
- {'old': 'matrix_client_element_roomdir_servers', 'new': 'matrix_client_element_room_directory_servers'}
|
|
- {'old': 'matrix_client_element_settingDefaults_custom_themes', 'new': 'matrix_client_element_setting_defaults_custom_themes'}
|
|
- {'old': 'matrix_client_element_branding_authFooterLinks', 'new': 'matrix_client_element_branding_auth_footer_links'}
|
|
- {'old': 'matrix_client_element_branding_authHeaderLogoUrl', 'new': 'matrix_client_element_branding_auth_header_logo_url'}
|
|
- {'old': 'matrix_client_element_branding_welcomeBackgroundUrl', 'new': 'matrix_client_element_branding_welcome_background_url'}
|
|
- {'old': 'matrix_client_element_jitsi_preferredDomain', 'new': 'matrix_client_element_jitsi_preferred_domain'}
|
|
- {'old': 'matrix_client_element_welcome_user_id', 'new': '<removed>'}
|
|
- {'old': 'matrix_client_element_docker_image_name_prefix', 'new': 'matrix_client_element_docker_image_registry_prefix'}
|
|
|
|
- when: matrix_client_element_container_labels_traefik_enabled | bool
|
|
block:
|
|
- name: Fail if required matrix-client-element Traefik settings not defined
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
You need to define a required configuration setting (`{{ item }}`).
|
|
when: "lookup('vars', item, default='') | string | length == 0"
|
|
with_items:
|
|
- matrix_client_element_container_labels_traefik_hostname
|
|
- matrix_client_element_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_client_element_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_client_element_container_labels_traefik_path_prefix ends with a slash
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
matrix_client_element_container_labels_traefik_path_prefix (`{{ matrix_client_element_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/element`).
|
|
when: "matrix_client_element_container_labels_traefik_path_prefix != '/' and matrix_client_element_container_labels_traefik_path_prefix[-1] == '/'"
|