From 2a443046c89f5ac50a0f60a9d5f8824d3ac09395 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 11 Oct 2024 17:47:12 +0900 Subject: [PATCH] =?UTF-8?q?Fix=20capitalization:=20schildichat=20=E2=86=92?= =?UTF-8?q?=20SchildiChat?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Suguru Hirahara --- ...configuring-playbook-client-schildichat.md | 10 +++--- roles/custom/matrix-base/defaults/main.yml | 2 +- .../defaults/main.yml | 32 +++++++++---------- .../tasks/prepare_themes.yml | 14 ++++---- .../tasks/self_check.yml | 10 +++--- .../tasks/setup_install.yml | 18 +++++------ .../tasks/setup_uninstall.yml | 2 +- .../tasks/validate_config.yml | 6 ++-- .../matrix-client-schildichat.service.j2 | 2 +- 9 files changed, 48 insertions(+), 48 deletions(-) diff --git a/docs/configuring-playbook-client-schildichat.md b/docs/configuring-playbook-client-schildichat.md index 733901920..856e71c13 100644 --- a/docs/configuring-playbook-client-schildichat.md +++ b/docs/configuring-playbook-client-schildichat.md @@ -26,15 +26,15 @@ To enable SchildiChat, add the following configuration to your `inventory/host_v matrix_client_schildichat_enabled: true ``` -The playbook provides some customization variables you could use to change schildichat's settings. +The playbook provides some customization variables you could use to change SchildiChat's settings. Their defaults are defined in [`roles/custom/matrix-client-schildichat/defaults/main.yml`](../roles/custom/matrix-client-schildichat/defaults/main.yml) and they ultimately end up in the generated `/matrix/schildichat/config.json` file (on the server). This file is generated from the [`roles/custom/matrix-client-schildichat/templates/config.json.j2`](../roles/custom/matrix-client-schildichat/templates/config.json.j2) template. **If there's an existing variable** which controls a setting you wish to change, you can simply define that variable in your configuration file (`inventory/host_vars/matrix./vars.yml`) and [re-run the playbook](installing.md) to apply the changes. -Alternatively, **if there is no pre-defined variable** for an schildichat setting you wish to change: +Alternatively, **if there is no pre-defined variable** for a SchildiChat setting you wish to change: -- you can either **request a variable to be created** (or you can submit such a contribution yourself). Keep in mind that it's **probably not a good idea** to create variables for each one of schildichat's various settings that rarely get used. +- you can either **request a variable to be created** (or you can submit such a contribution yourself). Keep in mind that it's **probably not a good idea** to create variables for each one of SchildiChat's various settings that rarely get used. - or, you can **extend and override the default configuration** ([`config.json.j2`](../roles/custom/matrix-client-schildichat/templates/config.json.j2)) by making use of the `matrix_client_schildichat_configuration_extension_json_` variable. You can find information about this in [`roles/custom/matrix-client-schildichat/defaults/main.yml`](../roles/custom/matrix-client-schildichat/defaults/main.yml). @@ -42,13 +42,13 @@ Alternatively, **if there is no pre-defined variable** for an schildichat settin ### Themes -To change the look of schildichat, you can define your own themes manually by using the `matrix_client_schildichat_setting_defaults_custom_themes` setting. +To change the look of SchildiChat, you can define your own themes manually by using the `matrix_client_schildichat_setting_defaults_custom_themes` setting. Or better yet, you can automatically pull it all themes provided by the [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes) project by simply flipping a flag (`matrix_client_schildichat_themes_enabled: true`). If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it. -Note that for a custom theme to work well, all schildichat instances that you use must have the same theme installed. +Note that for a custom theme to work well, all SchildiChat instances that you use must have the same theme installed. ## Installing diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml index 7d34808e7..850fe1a53 100644 --- a/roles/custom/matrix-base/defaults/main.yml +++ b/roles/custom/matrix-base/defaults/main.yml @@ -77,7 +77,7 @@ matrix_server_fqn_hydrogen: "hydrogen.{{ matrix_domain }}" # This is where you access the Cinny web client from (if enabled via matrix_client_cinny_enabled; disabled by default). matrix_server_fqn_cinny: "cinny.{{ matrix_domain }}" -# This is where you access the schildichat web client from (if enabled via matrix_client_schildichat_enabled; disabled by default). +# This is where you access the SchildiChat web client from (if enabled via matrix_client_schildichat_enabled; disabled by default). matrix_server_fqn_schildichat: "schildichat.{{ matrix_domain }}" # This is where you access the buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default). diff --git a/roles/custom/matrix-client-schildichat/defaults/main.yml b/roles/custom/matrix-client-schildichat/defaults/main.yml index c7c616b03..83145dc4c 100644 --- a/roles/custom/matrix-client-schildichat/defaults/main.yml +++ b/roles/custom/matrix-client-schildichat/defaults/main.yml @@ -124,14 +124,14 @@ matrix_client_schildichat_floc_optout_enabled: true matrix_client_schildichat_hsts_preload_enabled: false matrix_client_schildichat_scheme: https -# The hostname at which schildichat is served. +# The hostname at which SchildiChat is served. matrix_client_schildichat_hostname: "{{ matrix_server_fqn_schildichat }}" -# The path at which schildichat is exposed. +# The path at which SchildiChat is exposed. # This value must either be `/` or not end with a slash (e.g. `/schildichat`). matrix_client_schildichat_path_prefix: / -# schildichat config.json customizations +# SchildiChat config.json customizations matrix_client_schildichat_default_server_name: "{{ matrix_domain }}" matrix_client_schildichat_default_hs_url: "" matrix_client_schildichat_default_is_url: ~ @@ -145,9 +145,9 @@ matrix_client_schildichat_integrations_jitsi_widget_url: "https://scalar.vector. matrix_client_schildichat_permalink_prefix: "https://matrix.to" # noqa var-naming matrix_client_schildichat_bug_report_endpoint_url: "https://element.io/bugreports/submit" matrix_client_schildichat_show_lab_settings: true # noqa var-naming -# schildichat public room directory server(s) +# SchildiChat public room directory server(s) matrix_client_schildichat_room_directory_servers: ['matrix.org'] -# Branding of schildichat +# Branding of SchildiChat matrix_client_schildichat_brand: "schildichat" # URL to Logo on welcome page @@ -171,7 +171,7 @@ matrix_client_schildichat_branding_welcome_background_url: ~ # noqa var-naming matrix_client_schildichat_page_template_welcome_path: "{{ role_path }}/templates/welcome.html.j2" -# By default, there's no schildichat homepage (when logged in). If you wish to have one, +# By default, there's no SchildiChat homepage (when logged in). If you wish to have one, # point this to a `home.html` template file on your local filesystem. matrix_client_schildichat_embedded_pages_home_path: ~ @@ -189,7 +189,7 @@ matrix_client_schildichat_default_country_code: "GB" # Controls whether presence will be enabled matrix_client_schildichat_enable_presence_by_hs_url: ~ -# Controls whether custom schildichat themes will be installed. +# Controls whether custom SchildiChat themes will be installed. # When enabled, all themes found in the `matrix_client_schildichat_themes_repository_url` repository # will be installed and enabled automatically. matrix_client_schildichat_themes_enabled: false @@ -199,16 +199,16 @@ matrix_client_schildichat_themes_repository_version: master # Controls the default theme matrix_client_schildichat_default_theme: 'light' -# Controls the `setting_defaults.custom_themes` setting of the schildichat configuration. +# Controls the `setting_defaults.custom_themes` setting of the SchildiChat configuration. # You can use this setting to define custom themes. # # Also, look at `matrix_client_schildichat_themes_enabled` for a way to pull in a bunch of custom themes automatically. # If you define your own themes here and set `matrix_client_schildichat_themes_enabled: true`, your themes will be preserved as well. # -# Note that for a custom theme to work well, all schildichat instances that you use must have the same theme installed. +# Note that for a custom theme to work well, all SchildiChat instances that you use must have the same theme installed. matrix_client_schildichat_setting_defaults_custom_themes: [] # noqa var-naming -# Default schildichat configuration template which covers the generic use case. +# Default SchildiChat configuration template which covers the generic use case. # You can customize it by controlling the various variables inside it. # # For a more advanced customization, you can extend the default (see `matrix_client_schildichat_configuration_extension_json`) @@ -218,7 +218,7 @@ matrix_client_schildichat_setting_defaults_custom_themes: [] # noqa var-naming # This is unlike what it does when looking up YAML template files (no automatic parsing there). matrix_client_schildichat_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}" -# Your custom JSON configuration for schildichat should go to `matrix_client_schildichat_configuration_extension_json`. +# Your custom JSON configuration for SchildiChat should go to `matrix_client_schildichat_configuration_extension_json`. # This configuration extends the default starting configuration (`matrix_client_schildichat_configuration_default`). # # You can override individual variables from the default configuration, or introduce new ones. @@ -237,16 +237,16 @@ matrix_client_schildichat_configuration_extension_json: '{}' matrix_client_schildichat_configuration_extension: "{{ matrix_client_schildichat_configuration_extension_json | from_json if matrix_client_schildichat_configuration_extension_json | from_json is mapping else {} }}" -# Holds the final schildichat configuration (a combination of the default and its extension). +# Holds the final SchildiChat configuration (a combination of the default and its extension). # You most likely don't need to touch this variable. Instead, see `matrix_client_schildichat_configuration_default`. matrix_client_schildichat_configuration: "{{ matrix_client_schildichat_configuration_default | combine(matrix_client_schildichat_configuration_extension, recursive=True) }}" -# schildichat Location sharing functionality +# SchildiChat Location sharing functionality # More info: https://element.io/blog/element-launches-e2ee-location-sharing/ # How to host your own map tile server: https://matrix.org/docs/guides/map-tile-server matrix_client_schildichat_location_sharing_enabled: false -# Default schildichat location sharing map style configuration template which covers the generic use case. +# Default SchildiChat location sharing map style configuration template which covers the generic use case. # You can customize it by controlling the various variables inside it. # # For a more advanced customization, you can extend the default (see `matrix_client_schildichat_location_sharing_map_style_extension_json`) @@ -256,7 +256,7 @@ matrix_client_schildichat_location_sharing_enabled: false # This is unlike what it does when looking up YAML template files (no automatic parsing there). matrix_client_schildichat_location_sharing_map_style_default: "{{ lookup('template', 'templates/map_style.json.j2') }}" -# Your custom JSON configuration for schildichat location sharing map style should go to `matrix_client_schildichat_location_sharing_map_style_extension_json`. +# Your custom JSON configuration for SchildiChat location sharing map style should go to `matrix_client_schildichat_location_sharing_map_style_extension_json`. # This configuration extends the default starting configuration (`matrix_client_schildichat_location_sharing_map_style_default`). # # You can override individual variables from the default configuration, or introduce new ones. @@ -292,7 +292,7 @@ matrix_client_schildichat_location_sharing_map_style_extension_json: '{}' matrix_client_schildichat_location_sharing_map_style_extension: "{{ matrix_client_schildichat_location_sharing_map_style_extension_json | from_json if matrix_client_schildichat_location_sharing_map_style_extension_json | from_json is mapping else {} }}" -# Holds the final schildichat location sharing map style configuration (a combination of the default and its extension). +# Holds the final SchildiChat location sharing map style configuration (a combination of the default and its extension). # You most likely don't need to touch this variable. Instead, see `matrix_client_schildichat_location_sharing_map_style_default`. matrix_client_schildichat_location_sharing_map_style: "{{ matrix_client_schildichat_location_sharing_map_style_default | combine(matrix_client_schildichat_location_sharing_map_style_extension, recursive=True) }}" diff --git a/roles/custom/matrix-client-schildichat/tasks/prepare_themes.yml b/roles/custom/matrix-client-schildichat/tasks/prepare_themes.yml index 9e29ef90c..cd3f3ecb1 100644 --- a/roles/custom/matrix-client-schildichat/tasks/prepare_themes.yml +++ b/roles/custom/matrix-client-schildichat/tasks/prepare_themes.yml @@ -1,7 +1,7 @@ --- # -# Tasks related to setting up schildichat themes +# Tasks related to setting up SchildiChat themes # - when: matrix_client_schildichat_themes_enabled | bool @@ -9,35 +9,35 @@ delegate_to: 127.0.0.1 become: false block: - - name: Ensure schildichat themes repository is pulled + - name: Ensure SchildiChat themes repository is pulled ansible.builtin.git: repo: "{{ matrix_client_schildichat_themes_repository_url }}" version: "{{ matrix_client_schildichat_themes_repository_version }}" dest: "{{ role_path }}/files/scratchpad/themes" - - name: Find all schildichat theme files + - name: Find all SchildiChat theme files ansible.builtin.find: paths: "{{ role_path }}/files/scratchpad/themes" patterns: "*.json" recurse: true register: matrix_client_schildichat_theme_file_list - - name: Read schildichat theme + - name: Read SchildiChat theme ansible.builtin.slurp: path: "{{ item.path }}" register: "matrix_client_schildichat_theme_file_contents" with_items: "{{ matrix_client_schildichat_theme_file_list.files }}" - - name: Load schildichat theme + - name: Load SchildiChat theme ansible.builtin.set_fact: matrix_client_schildichat_setting_defaults_custom_themes: "{{ matrix_client_schildichat_setting_defaults_custom_themes + [item['content'] | b64decode | from_json] }}" # noqa var-naming with_items: "{{ matrix_client_schildichat_theme_file_contents.results }}" # -# Tasks related to getting rid of schildichat themes (if it was previously enabled) +# Tasks related to getting rid of SchildiChat themes (if it was previously enabled) # -- name: Ensure schildichat themes repository is removed +- name: Ensure SchildiChat themes repository is removed ansible.builtin.file: path: "{{ role_path }}/files/scratchpad/themes" state: absent diff --git a/roles/custom/matrix-client-schildichat/tasks/self_check.yml b/roles/custom/matrix-client-schildichat/tasks/self_check.yml index 7ecdd1c0a..11895e8c6 100644 --- a/roles/custom/matrix-client-schildichat/tasks/self_check.yml +++ b/roles/custom/matrix-client-schildichat/tasks/self_check.yml @@ -3,7 +3,7 @@ - ansible.builtin.set_fact: matrix_client_schildichat_url_endpoint_public: "{{ matrix_client_schildichat_scheme }}://{{ matrix_client_schildichat_hostname }}/config.json" -- name: Check schildichat +- name: Check SchildiChat ansible.builtin.uri: url: "{{ matrix_client_schildichat_url_endpoint_public }}" follow_redirects: none @@ -14,11 +14,11 @@ delegate_to: 127.0.0.1 become: false -- name: Fail if schildichat not working +- name: Fail if SchildiChat not working ansible.builtin.fail: - msg: "Failed checking schildichat is up at `{{ matrix_server_fqn_schildichat }}` (checked endpoint: `{{ matrix_client_schildichat_url_endpoint_public }}`). Is schildichat running? Is port 443 open in your firewall? Full error: {{ matrix_client_schildichat_self_check_result }}" + msg: "Failed checking SchildiChat is up at `{{ matrix_server_fqn_schildichat }}` (checked endpoint: `{{ matrix_client_schildichat_url_endpoint_public }}`). Is SchildiChat running? Is port 443 open in your firewall? Full error: {{ matrix_client_schildichat_self_check_result }}" when: "matrix_client_schildichat_self_check_result.failed or 'json' not in matrix_client_schildichat_self_check_result" -- name: Report working schildichat +- name: Report working SchildiChat ansible.builtin.debug: - msg: "schildichat at `{{ matrix_server_fqn_schildichat }}` is working (checked endpoint: `{{ matrix_client_schildichat_url_endpoint_public }}`)" + msg: "SchildiChat at `{{ matrix_server_fqn_schildichat }}` is working (checked endpoint: `{{ matrix_client_schildichat_url_endpoint_public }}`)" diff --git a/roles/custom/matrix-client-schildichat/tasks/setup_install.yml b/roles/custom/matrix-client-schildichat/tasks/setup_install.yml index 870b640a6..77c1b45c5 100644 --- a/roles/custom/matrix-client-schildichat/tasks/setup_install.yml +++ b/roles/custom/matrix-client-schildichat/tasks/setup_install.yml @@ -1,6 +1,6 @@ --- -- name: Ensure schildichat paths exists +- name: Ensure SchildiChat paths exists ansible.builtin.file: path: "{{ item.path }}" state: directory @@ -12,7 +12,7 @@ - {path: "{{ matrix_client_schildichat_docker_src_files_path }}", when: "{{ matrix_client_schildichat_container_image_self_build }}"} when: "item.when | bool" -- name: Ensure schildichat Docker image is pulled +- name: Ensure SchildiChat Docker image is pulled community.docker.docker_image: name: "{{ matrix_client_schildichat_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" @@ -24,7 +24,7 @@ delay: "{{ devture_playbook_help_container_retries_delay }}" until: result is not failed -- name: Ensure schildichat repository is present on self-build +- name: Ensure SchildiChat repository is present on self-build ansible.builtin.git: repo: "{{ matrix_client_schildichat_container_image_self_build_repo }}" dest: "{{ matrix_client_schildichat_docker_src_files_path }}" @@ -49,7 +49,7 @@ mode: '0644' when: "matrix_client_schildichat_container_image_self_build | bool and matrix_client_schildichat_container_image_self_build_low_memory_system_patch_enabled | bool" -- name: Ensure schildichat Docker image is built +- name: Ensure SchildiChat Docker image is built ansible.builtin.command: cmd: |- {{ devture_systemd_docker_base_host_command_docker }} buildx build @@ -59,7 +59,7 @@ changed_when: true when: matrix_client_schildichat_container_image_self_build | bool -- name: Ensure schildichat configuration installed +- name: Ensure SchildiChat configuration installed ansible.builtin.copy: content: "{{ matrix_client_schildichat_configuration | to_nice_json }}" dest: "{{ matrix_client_schildichat_data_path }}/config.json" @@ -67,7 +67,7 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" -- name: Ensure schildichat location sharing map style installed +- name: Ensure SchildiChat location sharing map style installed when: matrix_client_schildichat_location_sharing_enabled | bool ansible.builtin.copy: content: "{{ matrix_client_schildichat_location_sharing_map_style | to_nice_json }}" @@ -76,7 +76,7 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" -- name: Ensure schildichat config files installed +- name: Ensure SchildiChat config files installed ansible.builtin.template: src: "{{ item.src }}" dest: "{{ matrix_client_schildichat_data_path }}/{{ item.name }}" @@ -89,7 +89,7 @@ - {src: "{{ matrix_client_schildichat_embedded_pages_home_path }}", name: "home.html"} when: "item.src is not none" -- name: Ensure schildichat config files removed +- name: Ensure SchildiChat config files removed ansible.builtin.file: path: "{{ matrix_client_schildichat_data_path }}/{{ item.name }}" state: absent @@ -97,7 +97,7 @@ - {src: "{{ matrix_client_schildichat_embedded_pages_home_path }}", name: "home.html"} when: "item.src is none" -- name: Ensure schildichat container network is created +- name: Ensure SchildiChat container network is created community.general.docker_network: enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" name: "{{ matrix_client_schildichat_container_network }}" diff --git a/roles/custom/matrix-client-schildichat/tasks/setup_uninstall.yml b/roles/custom/matrix-client-schildichat/tasks/setup_uninstall.yml index f752ba300..98a4ae494 100644 --- a/roles/custom/matrix-client-schildichat/tasks/setup_uninstall.yml +++ b/roles/custom/matrix-client-schildichat/tasks/setup_uninstall.yml @@ -19,7 +19,7 @@ path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-client-schildichat.service" state: absent - - name: Ensure schildichat path doesn't exist + - name: Ensure SchildiChat path doesn't exist ansible.builtin.file: path: "{{ matrix_client_schildichat_data_path }}" state: absent diff --git a/roles/custom/matrix-client-schildichat/tasks/validate_config.yml b/roles/custom/matrix-client-schildichat/tasks/validate_config.yml index b5b5db54d..0e3b832a7 100644 --- a/roles/custom/matrix-client-schildichat/tasks/validate_config.yml +++ b/roles/custom/matrix-client-schildichat/tasks/validate_config.yml @@ -9,16 +9,16 @@ with_items: - {'old': 'matrix_client_schildichat_welcome_user_id', 'new': ''} -- name: Fail if required schildichat settings not defined +- name: Fail if required SchildiChat settings not defined ansible.builtin.fail: msg: > - You need to define a required configuration setting (`{{ item }}`) for using schildichat. + You need to define a required configuration setting (`{{ item }}`) for using SchildiChat. when: "vars[item] == ''" with_items: - matrix_client_schildichat_default_hs_url - matrix_client_schildichat_container_network -- name: Fail if schildichat location sharing enabled, but no tile server defined +- name: Fail if SchildiChat 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_schildichat_location_sharing_map_style_content_sources_localsource_tiles list diff --git a/roles/custom/matrix-client-schildichat/templates/systemd/matrix-client-schildichat.service.j2 b/roles/custom/matrix-client-schildichat/templates/systemd/matrix-client-schildichat.service.j2 index 97eac7704..74111ffa8 100644 --- a/roles/custom/matrix-client-schildichat/templates/systemd/matrix-client-schildichat.service.j2 +++ b/roles/custom/matrix-client-schildichat/templates/systemd/matrix-client-schildichat.service.j2 @@ -1,6 +1,6 @@ #jinja2: lstrip_blocks: "True" [Unit] -Description=Matrix schildichat server +Description=Matrix SchildiChat server {% for service in matrix_client_schildichat_systemd_required_services_list %} Requires={{ service }} After={{ service }}