Files
matrix-docker-ansible-deploy/roles/custom/matrix-bot-maubot/tasks/setup_install.yml
T
Slavi Pantaleev e5b8de8c2b Heal git checkout ownership in all roles cloning repositories on the server
6b4b7647e fixed this for synapse-usage-exporter only. A checkout owned by
a different user makes the git task fail from then on, either with a
permission error or with git's dubious-ownership protection, until
someone removes the directory on the host by hand. It gets into that
state when the matrix user's uid changes (a server migration or a restore
onto a differently numbered user), when an earlier clone ran as another
user, or when someone runs git as root inside the checkout.

Every other role cloning a repository onto the server was open to the
same failure, so ensure the checkout's ownership recursively before
updating it at the remaining 54 sites.

The three matrix-synapse ext clones also gain force=yes. They were the
only on-server clones without it, which left a checkout that an
interrupted run had half-written wedged, instead of repaired on the next
run.

matrix-matrixto used to clone as root into a directory that nothing ever
chowned, unlike every other role. It now becomes the matrix user too.

The Element Web and SchildiChat Web theme checkouts live on the Ansible
controller, where correcting ownership is not ours to do, so they merely
mark the checkout as a safe directory for git.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-31 19:01:52 +03:00

134 lines
5.9 KiB
YAML

# SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
# SPDX-FileCopyrightText: 2022 Julian-Samuel Gebühr
# SPDX-FileCopyrightText: 2022 Sebastian Gumprich
# SPDX-FileCopyrightText: 2022 Stuart Mumford
# SPDX-FileCopyrightText: 2024 David Mehren
# SPDX-FileCopyrightText: 2025 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
- name: Ensure maubot paths exist
ansible.builtin.file:
path: "{{ item.path }}"
state: directory
mode: '0755'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
with_items:
- {path: "{{ matrix_bot_maubot_base_path }}", when: true}
- {path: "{{ matrix_bot_maubot_config_path }}", when: true}
- {path: "{{ matrix_bot_maubot_data_path }}", when: true}
- {path: "{{ matrix_bot_maubot_data_path }}/plugins", when: true}
- {path: "{{ matrix_bot_maubot_data_path }}/dbs", when: true}
- {path: "{{ matrix_bot_maubot_data_path }}/trash", when: true}
- {path: "{{ matrix_bot_maubot_container_src_files_path }}", when: "{{ matrix_bot_maubot_container_image_self_build }}"}
- {path: "{{ matrix_bot_maubot_customized_container_src_files_path }}", when: "{{ matrix_bot_maubot_container_image_customizations_enabled }}"}
when: "item.when|bool"
- name: Ensure maubot configuration file created
ansible.builtin.template:
src: "{{ role_path }}/templates/config.yaml.j2"
dest: "{{ matrix_bot_maubot_config_path }}/config.yaml"
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
mode: "u=rwx"
register: matrix_bot_maubot_config_result
- name: Ensure maubot image is pulled
community.docker.docker_image_pull:
name: "{{ matrix_bot_maubot_container_image }}"
pull: always
when: "not matrix_bot_maubot_container_image_self_build|bool"
register: matrix_bot_maubot_container_image_pull_result
retries: "{{ devture_playbook_help_container_retries_count }}"
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: matrix_bot_maubot_container_image_pull_result is not failed
- when: matrix_bot_maubot_container_image_self_build | bool
block:
# A checkout owned by a different user (a uid change, an earlier clone by another user, etc.) would make the git task below fail on ownership or permissions.
- name: Ensure maubot repository ownership is correct on self-build
ansible.builtin.file:
path: "{{ matrix_bot_maubot_container_src_files_path }}"
state: directory
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
recurse: true
- name: Ensure maubot repository is present on self-build
ansible.builtin.git:
repo: "{{ matrix_bot_maubot_container_repo }}"
version: "{{ matrix_bot_maubot_container_repo_version }}"
dest: "{{ matrix_bot_maubot_container_src_files_path }}"
force: "yes"
become: true
become_user: "{{ matrix_user_name }}"
register: matrix_bot_maubot_git_pull_results
- name: Ensure maubot image is built
community.docker.docker_image_build:
name: "{{ matrix_bot_maubot_container_image }}"
dockerfile: Dockerfile
path: "{{ matrix_bot_maubot_container_src_files_path }}"
pull: true
rebuild: "{{ 'always' if matrix_bot_maubot_git_pull_results.changed | bool else 'never' }}"
register: matrix_bot_maubot_container_image_build_result
- when: "matrix_bot_maubot_container_image_customizations_enabled | bool"
block:
- name: Ensure customizations Dockerfile is created
ansible.builtin.template:
src: "{{ role_path }}/templates/customizations/Dockerfile.j2"
dest: "{{ matrix_bot_maubot_customized_container_src_files_path }}/Dockerfile"
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
mode: '0640'
register: matrix_bot_maubot_container_image_customizations_dockerfile_result
- name: Ensure customized Docker image for maubot is built
community.docker.docker_image_build:
name: "{{ matrix_bot_maubot_container_image_customized }}"
dockerfile: Dockerfile
path: "{{ matrix_bot_maubot_customized_container_src_files_path }}"
nocache: "{{ matrix_bot_maubot_container_image_customized_build_nocache }}"
rebuild: "{{ 'always' if (matrix_bot_maubot_container_image_customizations_dockerfile_result.changed or matrix_bot_maubot_container_image_customized_force_source) | bool else 'never' }}"
- name: Ensure maubot support files installed
ansible.builtin.template:
src: "{{ role_path }}/templates/{{ item }}.j2"
dest: "{{ matrix_bot_maubot_base_path }}/{{ item }}"
mode: '0640'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
with_items:
- labels
register: matrix_bot_maubot_support_files_result
- name: Ensure maubot container network is created
when: matrix_bot_maubot_container_network != 'host'
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_bot_maubot_container_network }}"
driver: bridge
driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
- name: Ensure matrix-bot-maubot.service installed
ansible.builtin.template:
src: "{{ role_path }}/templates/systemd/matrix-bot-maubot.service.j2"
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-maubot.service"
mode: '0644'
register: matrix_bot_maubot_systemd_service_result
- name: Determine whether maubot needs a restart
ansible.builtin.set_fact:
matrix_bot_maubot_restart_necessary: >-
{{
matrix_bot_maubot_config_result.changed | default(false)
or matrix_bot_maubot_support_files_result.changed | default(false)
or matrix_bot_maubot_systemd_service_result.changed | default(false)
or matrix_bot_maubot_container_image_pull_result.changed | default(false)
or matrix_bot_maubot_container_image_build_result.changed | default(false)
}}