Add support for Element Admin

roles/custom/matrix-element-admin/tasks/install.yml

@@ -0,0 +1,77 @@
+# SPDX-FileCopyrightText: 2024 David Mehren
+# SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+---
+
+- name: Ensure Element Admin paths exist
+  ansible.builtin.file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_name }}"
+    group: "{{ matrix_group_name }}"
+  with_items:
+    - path: "{{ matrix_element_admin_base_path }}"
+      when: true
+    - path: "{{ matrix_element_admin_container_src_path }}"
+      when: "{{ matrix_element_admin_container_image_self_build }}"
+  when: item.when | bool
+
+- name: Ensure Element Admin support files installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/{{ item }}.j2"
+    dest: "{{ matrix_element_admin_base_path }}/{{ item }}"
+    mode: 0640
+    owner: "{{ matrix_user_name }}"
+    group: "{{ matrix_group_name }}"
+  with_items:
+    - labels
+    - env
+
+- name: Ensure Element Admin container image is pulled
+  community.docker.docker_image:
+    name: "{{ matrix_element_admin_container_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_element_admin_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_element_admin_container_image_force_pull }}"
+  when: "not matrix_element_admin_container_image_self_build | bool"
+  register: result
+  retries: "{{ devture_playbook_help_container_retries_count }}"
+  delay: "{{ devture_playbook_help_container_retries_delay }}"
+  until: result is not failed
+
+- when: matrix_element_admin_container_image_self_build | bool
+  block:
+    - name: Ensure Element Admin repository is present on self-build
+      ansible.builtin.git:
+        repo: "{{ matrix_element_admin_container_image_self_build_repo }}"
+        version: "{{ matrix_element_admin_container_image_self_build_repo_version }}"
+        dest: "{{ matrix_element_admin_container_src_path }}"
+        force: "yes"
+      become: true
+      become_user: "{{ matrix_user_name }}"
+      register: matrix_element_admin_git_pull_results
+
+    - name: Ensure Element Admin container image is built
+      ansible.builtin.command:
+        cmd: |-
+          {{ devture_systemd_docker_base_host_command_docker }} buildx build
+          --tag={{ matrix_element_admin_container_image }}
+          --file={{ matrix_element_admin_container_src_path }}/Dockerfile
+          {{ matrix_element_admin_container_src_path }}
+      changed_when: true
+
+- name: Ensure Element Admin container network is created
+  community.general.docker_network:
+    enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
+    name: "{{ matrix_element_admin_container_network }}"
+    driver: bridge
+    driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
+
+- name: Ensure Element Admin systemd service installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/matrix-element-admin.service.j2"
+    dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-element-admin.service"
+    mode: 0644

roles/custom/matrix-element-admin/tasks/main.yml

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: 2024 Slavi Pantaleev
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+---
+
+- tags:
+    - setup-all
+    - setup-element-admin
+    - install-all
+    - install-element-admin
+  block:
+    - when: matrix_element_admin_enabled | bool
+      ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
+
+    - when: matrix_element_admin_enabled | bool
+      ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml"
+
+- tags:
+    - setup-all
+    - setup-element-admin
+  block:
+    - when: not matrix_element_admin_enabled | bool
+      ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml"

roles/custom/matrix-element-admin/tasks/uninstall.yml

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+---
+
+- name: Check existence of Element Admin service
+  ansible.builtin.stat:
+    path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-element-admin.service"
+  register: matrix_element_admin_service_stat
+
+- when: matrix_element_admin_service_stat.stat.exists | bool
+  block:
+    - name: Ensure Element Admin is stopped
+      ansible.builtin.service:
+        name: matrix-element-admin
+        state: stopped
+        enabled: false
+        daemon_reload: true
+
+    - name: Ensure Element Admin systemd service doesn't exist
+      ansible.builtin.file:
+        path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-element-admin.service"
+        state: absent
+
+    - name: Ensure Element Admin paths don't exist
+      ansible.builtin.file:
+        path: "{{ matrix_element_admin_base_path }}"
+        state: absent

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

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+---
+
+- name: Fail if required Element Admin settings not defined
+  ansible.builtin.fail:
+    msg: >
+      You need to define a required configuration setting (`{{ item.name }}`).
+  when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
+  with_items:
+    - {'name': 'matrix_element_admin_hostname', when: true}
+    - {'name': 'matrix_element_admin_path_prefix', when: true}
+    - {'name': 'matrix_element_admin_container_network', when: true}
+    - {'name': 'matrix_element_admin_environment_variable_server_name', when: true}
+
+# Element Admin appears to hardcode all paths to `/` (e.g. `/config.json`, `/assets/...`).
+# While we can properly serve the homepage and handle stripping the path prefix on our side,
+# the hardcoded URLs in the Element Admin are pointing people to the wrong place, which is a problem.
+- name: Fail if Element Admin path prefix is different than /
+  ansible.builtin.fail:
+    msg: >-
+      Element Admin with a path prefix other than '/' is not supported yet.
+      You have configured matrix_element_admin_path_prefix to '{{ matrix_element_admin_path_prefix }}'.
+  when: "matrix_element_admin_path_prefix != '/'"