From f37010734413ddff35f17209d672df3dae9cb44e Mon Sep 17 00:00:00 2001 From: Aine Date: Thu, 31 Aug 2023 11:22:09 +0300 Subject: [PATCH] cleanup schildichat a bit --- ...configuring-playbook-client-schildichat.md | 10 +++---- .../tasks/validate_config.yml | 27 ------------------- 2 files changed, 5 insertions(+), 32 deletions(-) diff --git a/docs/configuring-playbook-client-schildichat.md b/docs/configuring-playbook-client-schildichat.md index 9b9e5ca61..53d7c9c1f 100644 --- a/docs/configuring-playbook-client-schildichat.md +++ b/docs/configuring-playbook-client-schildichat.md @@ -1,18 +1,18 @@ -# Configuring schildichat (optional) +# Configuring SchildiChat (optional) -By default, this playbook does not install the [schildichat](https://github.com/SchildiChat/schildichat-desktop) Matrix client web application. +By default, this playbook does not install the [SchildiChat](https://github.com/SchildiChat/schildichat-desktop) Matrix client web application. -## Enabling schildichat +## Enabling SchildiChat -If you'd like for the playbook to install schildichat, you can enable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): +If you'd like for the playbook to install SchildiChat, you can enable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): ```yaml matrix_client_schildichat_enabled: true ``` -## Configuring schildichat settings +## Configuring SchildiChat settings The playbook provides some customization variables you could use to change schildichat's settings. diff --git a/roles/custom/matrix-client-schildichat/tasks/validate_config.yml b/roles/custom/matrix-client-schildichat/tasks/validate_config.yml index b3b57f232..f01626453 100644 --- a/roles/custom/matrix-client-schildichat/tasks/validate_config.yml +++ b/roles/custom/matrix-client-schildichat/tasks/validate_config.yml @@ -16,33 +16,6 @@ - matrix_client_schildichat_location_sharing_enabled | bool - matrix_client_schildichat_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 schildichat (https://schildichat.io/blog/welcome-to-schildichat/). - The playbook will migrate your existing configuration and data automatically, but you need to adjust variable names. - Please change your configuration (vars.yml) to rename all riot-web variables (`{{ item.old }}` -> `{{ item.new }}`). - Also note that DNS configuration changes may be necessary. - when: "vars | dict2items | selectattr('key', 'match', item.old) | list | items2dict" - with_items: - - {'old': 'matrix_riot_web_.*', 'new': 'matrix_client_schildichat_.*'} - -- name: (Deprecation) Catch and report renamed schildichat-web settings - ansible.builtin.fail: - msg: >- - Your configuration contains a variable, which now has a different name. - Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`). - when: "item.old in vars" - with_items: - - {'old': 'matrix_client_schildichat_showLabsSettings', 'new': 'matrix_client_schildichat_show_lab_settings'} - - {'old': 'matrix_client_schildichat_permalinkPrefix', 'new': 'matrix_client_schildichat_permalink_prefix'} - - {'old': 'matrix_client_schildichat_roomdir_servers', 'new': 'matrix_client_schildichat_room_directory_servers'} - - {'old': 'matrix_client_schildichat_settingDefaults_custom_themes', 'new': 'matrix_client_schildichat_setting_defaults_custom_themes'} - - {'old': 'matrix_client_schildichat_branding_authFooterLinks', 'new': 'matrix_client_schildichat_branding_auth_footer_links'} - - {'old': 'matrix_client_schildichat_branding_authHeaderLogoUrl', 'new': 'matrix_client_schildichat_branding_auth_header_logo_url'} - - {'old': 'matrix_client_schildichat_branding_welcomeBackgroundUrl', 'new': 'matrix_client_schildichat_branding_welcome_background_url'} - - {'old': 'matrix_client_schildichat_jitsi_preferredDomain', 'new': 'matrix_client_schildichat_jitsi_preferred_domain'} - - when: matrix_client_schildichat_container_labels_traefik_enabled | bool block: - name: Fail if required matrix-client-schildichat Traefik settings not defined