mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-06-25 10:47:51 +02:00
Add sliding-sync support
This allows people to try out the new Element X clients, which need to run against the sliding-sync proxy (https://github.com/matrix-org/sliding-sync). Supersedes https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2515 The code is based on the existing PR (#2515), but heavily reworked. Major changes: - lots of internal refactoring and variable renaming - fixed self-building to support non-amd64 architectures - changed to talk to the homeserver locally, over the container network (not publicly) - no more matrix-nginx-proxy support due to complexity (see below) - no more `matrix_server_fqn_sliding_sync_proxy` in favor of `matrix_sliding_sync_hostname` and `matrix_sliding_sync_path_prefix` - runs on `matrix.DOMAIN/sliding-sync` by default, so it can tried easily without having to create new DNS records
This commit is contained in:
69
roles/custom/matrix-sliding-sync/tasks/install.yml
Normal file
69
roles/custom/matrix-sliding-sync/tasks/install.yml
Normal file
@ -0,0 +1,69 @@
|
||||
---
|
||||
|
||||
- name: Ensure matrix-sliding-sync paths exist
|
||||
ansible.builtin.file:
|
||||
path: "{{ item.path }}"
|
||||
state: directory
|
||||
mode: 0750
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
with_items:
|
||||
- path: "{{ matrix_sliding_sync_base_path }}"
|
||||
when: true
|
||||
- path: "{{ matrix_sliding_sync_container_src_path }}"
|
||||
when: "{{ matrix_sliding_sync_container_image_self_build }}"
|
||||
when: item.when | bool
|
||||
|
||||
- name: Ensure matrix-sliding-sync support files installed
|
||||
ansible.builtin.template:
|
||||
src: "{{ role_path }}/templates/{{ item }}.j2"
|
||||
dest: "{{ matrix_sliding_sync_base_path }}/{{ item }}"
|
||||
mode: 0640
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
with_items:
|
||||
- env
|
||||
- labels
|
||||
|
||||
- name: Ensure matrix-sliding-sync container image is pulled
|
||||
community.docker.docker_image:
|
||||
name: "{{ matrix_sliding_sync_container_image }}"
|
||||
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
||||
force_source: "{{ matrix_sliding_sync_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_sliding_sync_container_image_force_pull }}"
|
||||
when: "not matrix_sliding_sync_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_sliding_sync_container_image_self_build | bool
|
||||
block:
|
||||
- name: Ensure matrix-sliding-sync repository is present on self-build
|
||||
ansible.builtin.git:
|
||||
repo: "{{ matrix_sliding_sync_container_image_self_build_repo }}"
|
||||
version: "{{ matrix_sliding_sync_container_image_self_build_repo_version }}"
|
||||
dest: "{{ matrix_sliding_sync_container_src_path }}"
|
||||
force: "yes"
|
||||
become: true
|
||||
become_user: "{{ matrix_user_username }}"
|
||||
register: matrix_sliding_sync_git_pull_results
|
||||
|
||||
- name: Ensure matrix-sliding-sync container image is built
|
||||
ansible.builtin.command:
|
||||
cmd: |-
|
||||
{{ devture_systemd_docker_base_host_command_docker }} buildx build
|
||||
--tag={{ matrix_sliding_sync_container_image }}
|
||||
--file={{ matrix_sliding_sync_container_src_path }}/Dockerfile
|
||||
{{ matrix_sliding_sync_container_src_path }}
|
||||
|
||||
- name: Ensure matrix-sliding-sync container network is created
|
||||
community.general.docker_network:
|
||||
name: "{{ matrix_sliding_sync_container_network }}"
|
||||
driver: bridge
|
||||
|
||||
- name: Ensure matrix-sliding-sync.service installed
|
||||
ansible.builtin.template:
|
||||
src: "{{ role_path }}/templates/systemd/matrix-sliding-sync.service.j2"
|
||||
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-sliding-sync.service"
|
||||
mode: 0644
|
19
roles/custom/matrix-sliding-sync/tasks/main.yml
Normal file
19
roles/custom/matrix-sliding-sync/tasks/main.yml
Normal file
@ -0,0 +1,19 @@
|
||||
---
|
||||
- block:
|
||||
- when: matrix_sliding_sync_enabled | bool
|
||||
ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
|
||||
|
||||
- when: matrix_sliding_sync_enabled | bool
|
||||
ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml"
|
||||
tags:
|
||||
- setup-all
|
||||
- setup-sliding-sync
|
||||
- install-all
|
||||
- install-sliding-sync
|
||||
|
||||
- block:
|
||||
- when: not matrix_sliding_sync_enabled | bool
|
||||
ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml"
|
||||
tags:
|
||||
- setup-all
|
||||
- setup-sliding-sync
|
25
roles/custom/matrix-sliding-sync/tasks/uninstall.yml
Normal file
25
roles/custom/matrix-sliding-sync/tasks/uninstall.yml
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
|
||||
- name: Check existence of matrix-sliding-sync service
|
||||
ansible.builtin.stat:
|
||||
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-sliding-sync.service"
|
||||
register: matrix_sliding_sync_service_stat
|
||||
|
||||
- when: matrix_sliding_sync_service_stat.stat.exists | bool
|
||||
block:
|
||||
- name: Ensure matrix-sliding-sync is stopped
|
||||
ansible.builtin.service:
|
||||
name: matrix-sliding-sync
|
||||
state: stopped
|
||||
enabled: false
|
||||
daemon_reload: true
|
||||
|
||||
- name: Ensure matrix-sliding-sync.service doesn't exist
|
||||
ansible.builtin.file:
|
||||
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-sliding-sync.service"
|
||||
state: absent
|
||||
|
||||
- name: Ensure matrix-sliding-sync paths don't exist
|
||||
ansible.builtin.file:
|
||||
path: "{{ matrix_sliding_sync_base_path }}"
|
||||
state: absent
|
11
roles/custom/matrix-sliding-sync/tasks/validate_config.yml
Normal file
11
roles/custom/matrix-sliding-sync/tasks/validate_config.yml
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
- name: Fail if required matrix-sliding-sync settings not defined
|
||||
ansible.builtin.fail:
|
||||
msg: >
|
||||
You need to define a required configuration setting (`{{ item.name }}`).
|
||||
when: "vars[item] == ''"
|
||||
with_items:
|
||||
- matrix_sliding_sync_hostname
|
||||
- matrix_sliding_sync_path_prefix
|
||||
- matrix_sliding_sync_database_hostname
|
||||
- matrix_sliding_sync_environment_variable_syncv3_secret
|
Reference in New Issue
Block a user