Add "Web" to Element and SchildiChat web application (#3755)

* Replace "Element" with "Element Web"

- If Element indicates the web application, then it is changed to Element Web.
- If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients.
- If it is combined with location sharing functionality, it is not changed.

with other some changes, including:

- Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Replace "SchildiChat" with "SchildiChat Web"

- If SchildiChat indicates the web application, then it is changed to SchildiChat Web.
- If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients.
- If it is combined with location sharing functionality, it is not changed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

roles/custom/matrix-client-element/defaults/main.yml

@@ -130,14 +130,14 @@ matrix_client_element_floc_optout_enabled: true
 matrix_client_element_hsts_preload_enabled: false
 
 matrix_client_element_scheme: https
-# The hostname at which Element is served.
+# The hostname at which Element Web is served.
 matrix_client_element_hostname: "{{ matrix_server_fqn_element }}"
 
-# The path at which Element is exposed.
+# The path at which Element Web is exposed.
 # This value must either be `/` or not end with a slash (e.g. `/element`).
 matrix_client_element_path_prefix: /
 
-# Element config.json customizations
+# Element Web config.json customizations
 matrix_client_element_default_server_name: "{{ matrix_domain }}"
 matrix_client_element_default_hs_url: ""
 matrix_client_element_default_is_url: ~
@@ -177,7 +177,7 @@ matrix_client_element_branding_welcome_background_url: ~  # noqa var-naming
 
 matrix_client_element_page_template_welcome_path: "{{ role_path }}/templates/welcome.html.j2"
 
-# By default, there's no Element homepage (when logged in). If you wish to have one,
+# By default, there's no Element Web homepage (when logged in). If you wish to have one,
 # point this to a `home.html` template file on your local filesystem.
 matrix_client_element_embedded_pages_home_path: ~
 
@@ -195,7 +195,7 @@ matrix_client_element_default_country_code: "GB"
 # Controls whether presence will be enabled
 matrix_client_element_enable_presence_by_hs_url: ~
 
-# Controls whether custom Element themes will be installed.
+# Controls whether custom Element Web themes will be installed.
 # When enabled, all themes found in the `matrix_client_element_themes_repository_url` repository
 # will be installed and enabled automatically.
 matrix_client_element_themes_enabled: false
@@ -205,16 +205,16 @@ matrix_client_element_themes_repository_version: master
 # Controls the default theme
 matrix_client_element_default_theme: 'light'
 
-# Controls the `setting_defaults.custom_themes` setting of the Element configuration.
+# Controls the `setting_defaults.custom_themes` setting of the Element Web configuration.
 # You can use this setting to define custom themes.
 #
 # Also, look at `matrix_client_element_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_element_themes_enabled: true`, your themes will be preserved as well.
 #
-# Note that for a custom theme to work well, all Element instances that you use must have the same theme installed.
+# Note that for a custom theme to work well, all Element Web instances that you use must have the same theme installed.
 matrix_client_element_setting_defaults_custom_themes: []  # noqa var-naming
 
-# Default Element configuration template which covers the generic use case.
+# Default Element Web 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_element_configuration_extension_json`)
@@ -224,7 +224,7 @@ matrix_client_element_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_element_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}"
 
-# Your custom JSON configuration for Element should go to `matrix_client_element_configuration_extension_json`.
+# Your custom JSON configuration for Element Web should go to `matrix_client_element_configuration_extension_json`.
 # This configuration extends the default starting configuration (`matrix_client_element_configuration_default`).
 #
 # You can override individual variables from the default configuration, or introduce new ones.
@@ -243,7 +243,7 @@ matrix_client_element_configuration_extension_json: '{}'
 
 matrix_client_element_configuration_extension: "{{ matrix_client_element_configuration_extension_json | from_json if matrix_client_element_configuration_extension_json | from_json is mapping else {} }}"
 
-# Holds the final Element configuration (a combination of the default and its extension).
+# Holds the final Element Web configuration (a combination of the default and its extension).
 # You most likely don't need to touch this variable. Instead, see `matrix_client_element_configuration_default`.
 matrix_client_element_configuration: "{{ matrix_client_element_configuration_default | combine(matrix_client_element_configuration_extension, recursive=True) }}"
 

roles/custom/matrix-client-element/tasks/prepare_themes.yml

@@ -1,7 +1,7 @@
 ---
 
 #
-# Tasks related to setting up Element themes
+# Tasks related to setting up Element Web themes
 #
 
 - when: matrix_client_element_themes_enabled | bool
@@ -9,35 +9,35 @@
   delegate_to: 127.0.0.1
   become: false
   block:
-    - name: Ensure Element themes repository is pulled
+    - name: Ensure Element Web themes repository is pulled
       ansible.builtin.git:
         repo: "{{ matrix_client_element_themes_repository_url }}"
         version: "{{ matrix_client_element_themes_repository_version }}"
         dest: "{{ role_path }}/files/scratchpad/themes"
 
-    - name: Find all Element theme files
+    - name: Find all Element Web theme files
       ansible.builtin.find:
         paths: "{{ role_path }}/files/scratchpad/themes"
         patterns: "*.json"
         recurse: true
       register: matrix_client_element_theme_file_list
 
-    - name: Read Element theme
+    - name: Read Element Web theme
       ansible.builtin.slurp:
         path: "{{ item.path }}"
       register: "matrix_client_element_theme_file_contents"
       with_items: "{{ matrix_client_element_theme_file_list.files }}"
 
-    - name: Load Element theme
+    - name: Load Element Web theme
       ansible.builtin.set_fact:
         matrix_client_element_setting_defaults_custom_themes: "{{ matrix_client_element_setting_defaults_custom_themes + [item['content'] | b64decode | from_json] }}"  # noqa var-naming
       with_items: "{{ matrix_client_element_theme_file_contents.results }}"
 
 #
-# Tasks related to getting rid of Element themes (if it was previously enabled)
+# Tasks related to getting rid of Element Web themes (if it was previously enabled)
 #
 
-- name: Ensure Element themes repository is removed
+- name: Ensure Element Web themes repository is removed
   ansible.builtin.file:
     path: "{{ role_path }}/files/scratchpad/themes"
     state: absent

roles/custom/matrix-client-element/tasks/self_check.yml

@@ -3,7 +3,7 @@
 - ansible.builtin.set_fact:
     matrix_client_element_url_endpoint_public: "{{ matrix_client_element_scheme }}://{{ matrix_client_element_hostname }}/config.json"
 
-- name: Check Element
+- name: Check Element Web
   ansible.builtin.uri:
     url: "{{ matrix_client_element_url_endpoint_public }}"
     follow_redirects: none
@@ -14,11 +14,11 @@
   delegate_to: 127.0.0.1
   become: false
 
-- name: Fail if Element not working
+- name: Fail if Element Web not working
   ansible.builtin.fail:
-    msg: "Failed checking Element is up at `{{ matrix_server_fqn_element }}` (checked endpoint: `{{ matrix_client_element_url_endpoint_public }}`). Is Element running? Is port 443 open in your firewall? Full error: {{ matrix_client_element_self_check_result }}"
+    msg: "Failed checking Element Web is up at `{{ matrix_server_fqn_element }}` (checked endpoint: `{{ matrix_client_element_url_endpoint_public }}`). Is Element Web running? Is port 443 open in your firewall? Full error: {{ matrix_client_element_self_check_result }}"
   when: "matrix_client_element_self_check_result.failed or 'json' not in matrix_client_element_self_check_result"
 
-- name: Report working Element
+- name: Report working Element Web
   ansible.builtin.debug:
-    msg: "Element at `{{ matrix_server_fqn_element }}` is working (checked endpoint: `{{ matrix_client_element_url_endpoint_public }}`)"
+    msg: "Element Web at `{{ matrix_server_fqn_element }}` is working (checked endpoint: `{{ matrix_client_element_url_endpoint_public }}`)"

roles/custom/matrix-client-element/tasks/setup_install.yml

@@ -1,6 +1,6 @@
 ---
 
-- name: Ensure Element paths exists
+- name: Ensure Element Web paths exists
   ansible.builtin.file:
     path: "{{ item.path }}"
     state: directory
@@ -12,7 +12,7 @@
     - {path: "{{ matrix_client_element_docker_src_files_path }}", when: "{{ matrix_client_element_container_image_self_build }}"}
   when: "item.when | bool"
 
-- name: Ensure Element Docker image is pulled
+- name: Ensure Element Web Docker image is pulled
   community.docker.docker_image:
     name: "{{ matrix_client_element_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 Element repository is present on self-build
+- name: Ensure Element Web repository is present on self-build
   ansible.builtin.git:
     repo: "{{ matrix_client_element_container_image_self_build_repo }}"
     dest: "{{ matrix_client_element_docker_src_files_path }}"
@@ -49,7 +49,7 @@
     mode: '0644'
   when: "matrix_client_element_container_image_self_build | bool and matrix_client_element_container_image_self_build_low_memory_system_patch_enabled | bool"
 
-- name: Ensure Element Docker image is built
+- name: Ensure Element Web 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_element_container_image_self_build | bool
 
-- name: Ensure Element configuration installed
+- name: Ensure Element Web configuration installed
   ansible.builtin.copy:
     content: "{{ matrix_client_element_configuration | to_nice_json }}"
     dest: "{{ matrix_client_element_data_path }}/config.json"
@@ -76,7 +76,7 @@
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
 
-- name: Ensure Element config files installed
+- name: Ensure Element Web config files installed
   ansible.builtin.template:
     src: "{{ item.src }}"
     dest: "{{ matrix_client_element_data_path }}/{{ item.name }}"
@@ -90,7 +90,7 @@
     - {src: "{{ matrix_client_element_embedded_pages_home_path }}", name: "home.html"}
   when: "item.src is not none"
 
-- name: Ensure Element config files removed
+- name: Ensure Element Web config files removed
   ansible.builtin.file:
     path: "{{ matrix_client_element_data_path }}/{{ item.name }}"
     state: absent
@@ -98,7 +98,7 @@
     - {src: "{{ matrix_client_element_embedded_pages_home_path }}", name: "home.html"}
   when: "item.src is none"
 
-- name: Ensure Element container network is created
+- name: Ensure Element Web container network is created
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
     name: "{{ matrix_client_element_container_network }}"

roles/custom/matrix-client-element/tasks/setup_uninstall.yml

@@ -19,7 +19,7 @@
         path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-client-element.service"
         state: absent
 
-    - name: Ensure Element path doesn't exist
+    - name: Ensure Element Web path doesn't exist
       ansible.builtin.file:
         path: "{{ matrix_client_element_data_path }}"
         state: absent

roles/custom/matrix-client-element/tasks/validate_config.yml

@@ -1,9 +1,9 @@
 ---
 
-- name: Fail if required Element settings not defined
+- 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.
+      You need to define a required configuration setting (`{{ item }}`) for using Element Web.
   when: "vars[item] == ''"
   with_items:
     - matrix_client_element_default_hs_url

roles/custom/matrix-client-element/templates/systemd/matrix-client-element.service.j2

@@ -1,6 +1,6 @@
 #jinja2: lstrip_blocks: "True"
 [Unit]
-Description=Matrix Element server
+Description=Matrix Element Web server
 {% for service in matrix_client_element_systemd_required_services_list %}
 Requires={{ service }}
 After={{ service }}