mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-10-20 21:34:15 +00:00
Slavi PantaleevandClaude Opus 5.5
bff3f54d53
Containers are created with `--rm`, so Docker removes them asynchronously after they stop. The pre-start `docker rm` returns immediately while that removal is still in progress (its error is suppressed), and the following `docker create --name` can fail with "The container name ... is already in use". This is easy to hit since systemd_service_manager switched its default restart mode to `all-at-once`: many containers stop and start at the same time and Docker falls behind on removals. The playbook then fails at "Restart systemd services needing restart at once", even though the services recover on their own (`Restart=always`) a little later. The external roles (MASH, devture) were hardened against this in 2026-03 (see mother-of-all-self-hosting/ansible-role-valkey@0ba79c0), but the roles in `roles/custom` never were. This ports the same bounded cleanup loop to them: stop, force-remove, and wait until Docker releases the name, failing explicitly after a timeout. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
244 lines
16 KiB
YAML
244 lines
16 KiB
YAML
# SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2021 Aaron Raimist
|
|
# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi
|
|
# SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2022 László Várady
|
|
# SPDX-FileCopyrightText: 2022 Marko Weltzer
|
|
# SPDX-FileCopyrightText: 2022 Ruben Hias
|
|
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
# mautrix-googlechat is a Matrix <-> googlechat bridge
|
|
# Project source code URL: https://github.com/mautrix/googlechat
|
|
|
|
matrix_bridge_mautrix_googlechat_enabled: true
|
|
|
|
matrix_bridge_mautrix_googlechat_container_image_self_build: false
|
|
matrix_bridge_mautrix_googlechat_container_image_self_build_repo: "https://github.com/mautrix/googlechat.git"
|
|
matrix_bridge_mautrix_googlechat_container_image_self_build_repo_version: "{{ 'master' if matrix_bridge_mautrix_googlechat_version == 'latest' else matrix_bridge_mautrix_googlechat_version }}"
|
|
|
|
# renovate: datasource=docker depName=dock.mau.dev/mautrix/googlechat
|
|
matrix_bridge_mautrix_googlechat_version: v0.5.2
|
|
# See: https://mau.dev/mautrix/googlechat/container_registry
|
|
matrix_bridge_mautrix_googlechat_container_image: "{{ matrix_bridge_mautrix_googlechat_container_image_registry_prefix }}mautrix/googlechat:{{ matrix_bridge_mautrix_googlechat_version }}"
|
|
matrix_bridge_mautrix_googlechat_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_mautrix_googlechat_container_image_self_build else matrix_bridge_mautrix_googlechat_container_image_registry_prefix_upstream }}"
|
|
matrix_bridge_mautrix_googlechat_container_image_registry_prefix_upstream: "{{ matrix_bridge_mautrix_googlechat_container_image_registry_prefix_upstream_default }}"
|
|
matrix_bridge_mautrix_googlechat_container_image_registry_prefix_upstream_default: "dock.mau.dev/"
|
|
|
|
matrix_bridge_mautrix_googlechat_base_path: "{{ matrix_base_data_path }}/mautrix-googlechat"
|
|
matrix_bridge_mautrix_googlechat_config_path: "{{ matrix_bridge_mautrix_googlechat_base_path }}/config"
|
|
matrix_bridge_mautrix_googlechat_data_path: "{{ matrix_bridge_mautrix_googlechat_base_path }}/data"
|
|
matrix_bridge_mautrix_googlechat_container_src_files_path: "{{ matrix_bridge_mautrix_googlechat_base_path }}/docker-src"
|
|
|
|
matrix_bridge_mautrix_googlechat_public_endpoint: '/mautrix-googlechat'
|
|
|
|
matrix_bridge_mautrix_googlechat_homeserver_address: ""
|
|
matrix_bridge_mautrix_googlechat_homeserver_domain: '{{ matrix_domain }}'
|
|
matrix_bridge_mautrix_googlechat_appservice_address: 'http://matrix-mautrix-googlechat:8080'
|
|
|
|
matrix_bridge_mautrix_googlechat_command_prefix: "!gc"
|
|
|
|
# Controls whether the matrix-mautrix-googlechat container exposes its HTTP port (tcp/8080 in the container).
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9007"), or empty string to not expose.
|
|
matrix_bridge_mautrix_googlechat_container_http_host_bind_port: ''
|
|
|
|
matrix_bridge_mautrix_googlechat_container_network: ""
|
|
|
|
matrix_bridge_mautrix_googlechat_container_additional_networks: "{{ matrix_bridge_mautrix_googlechat_container_additional_networks_auto + matrix_bridge_mautrix_googlechat_container_additional_networks_custom }}"
|
|
matrix_bridge_mautrix_googlechat_container_additional_networks_auto: []
|
|
matrix_bridge_mautrix_googlechat_container_additional_networks_custom: []
|
|
|
|
# matrix_bridge_mautrix_googlechat_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
|
|
# See `../templates/labels.j2` for details.
|
|
#
|
|
# To inject your own other container labels, see `matrix_bridge_mautrix_googlechat_container_labels_additional_labels`.
|
|
matrix_bridge_mautrix_googlechat_container_labels_traefik_enabled: true
|
|
matrix_bridge_mautrix_googlechat_container_labels_traefik_docker_network: "{{ matrix_bridge_mautrix_googlechat_container_network }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_traefik_entrypoints: web-secure
|
|
matrix_bridge_mautrix_googlechat_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
# Controls whether labels will be added that expose mautrix-googlechat's public endpoint
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_enabled: true
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_hostname: ""
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_path_prefix: "{{ matrix_bridge_mautrix_googlechat_public_endpoint }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_path_prefix }}`)"
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_traefik_priority: 0
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_bridge_mautrix_googlechat_container_labels_traefik_entrypoints }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_traefik_tls: "{{ matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_googlechat_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
|
|
# Controls whether labels will be added that expose mautrix-googlechat's metrics
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_enabled: "{{ matrix_bridge_mautrix_googlechat_metrics_enabled and matrix_bridge_mautrix_googlechat_metrics_proxying_enabled }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_traefik_rule: "Host(`{{ matrix_bridge_mautrix_googlechat_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_googlechat_metrics_proxying_path_prefix }}`)"
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_traefik_priority: 0
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_traefik_entrypoints: "{{ matrix_bridge_mautrix_googlechat_container_labels_traefik_entrypoints }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_traefik_tls: "{{ matrix_bridge_mautrix_googlechat_container_labels_metrics_traefik_entrypoints != 'web' }}"
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_googlechat_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_middleware_basic_auth_enabled: false
|
|
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
|
|
matrix_bridge_mautrix_googlechat_container_labels_metrics_middleware_basic_auth_users: ''
|
|
|
|
# matrix_bridge_mautrix_googlechat_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
|
|
# See `../templates/labels.j2` for details.
|
|
#
|
|
# Example:
|
|
# matrix_bridge_mautrix_googlechat_container_labels_additional_labels: |
|
|
# my.label=1
|
|
# another.label="here"
|
|
matrix_bridge_mautrix_googlechat_container_labels_additional_labels: ''
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_bridge_mautrix_googlechat_container_extra_arguments: []
|
|
|
|
# Controls how long the pre-start cleanup should wait for stale container-name release
|
|
# before failing startup explicitly.
|
|
matrix_bridge_mautrix_googlechat_container_cleanup_timeout_seconds: "{{ devture_systemd_docker_base_container_cleanup_timeout_seconds }}"
|
|
|
|
# Controls the delay between pre-start cleanup retries.
|
|
matrix_bridge_mautrix_googlechat_container_cleanup_retry_delay_seconds: "{{ devture_systemd_docker_base_container_cleanup_retry_delay_seconds }}"
|
|
|
|
# Shell command used in the systemd pre-start phase to deterministically remove a stale
|
|
# container and wait until Docker releases its name.
|
|
matrix_bridge_mautrix_googlechat_container_cleanup_command: |
|
|
i=0;
|
|
while [ "$i" -lt {{ matrix_bridge_mautrix_googlechat_container_cleanup_timeout_seconds }} ]; do
|
|
{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-mautrix-googlechat >/dev/null 2>&1 || true;
|
|
{{ devture_systemd_docker_base_host_command_docker }} rm -f matrix-mautrix-googlechat >/dev/null 2>&1 || true;
|
|
if {{ devture_systemd_docker_base_host_command_docker }} container inspect matrix-mautrix-googlechat >/dev/null 2>&1; then
|
|
i=$((i + 1));
|
|
sleep {{ matrix_bridge_mautrix_googlechat_container_cleanup_retry_delay_seconds }};
|
|
continue;
|
|
fi;
|
|
if {{ devture_systemd_docker_base_host_command_docker }} info >/dev/null 2>&1; then
|
|
exit 0;
|
|
fi;
|
|
echo "Failed to query Docker daemon while cleaning up matrix-mautrix-googlechat" >&2;
|
|
exit 1;
|
|
done;
|
|
echo "Failed to remove stale container matrix-mautrix-googlechat after {{ matrix_bridge_mautrix_googlechat_container_cleanup_timeout_seconds }} attempts" >&2;
|
|
exit 1
|
|
|
|
# List of systemd services that matrix-mautrix-googlechat.service depends on.
|
|
matrix_bridge_mautrix_googlechat_systemd_required_services_list: "{{ matrix_bridge_mautrix_googlechat_systemd_required_services_list_default + matrix_bridge_mautrix_googlechat_systemd_required_services_list_auto + matrix_bridge_mautrix_googlechat_systemd_required_services_list_custom }}"
|
|
matrix_bridge_mautrix_googlechat_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
|
matrix_bridge_mautrix_googlechat_systemd_required_services_list_auto: []
|
|
matrix_bridge_mautrix_googlechat_systemd_required_services_list_custom: []
|
|
|
|
# List of systemd services that matrix-mautrix-googlechat.service wants
|
|
matrix_bridge_mautrix_googlechat_systemd_wanted_services_list: []
|
|
|
|
matrix_bridge_mautrix_googlechat_appservice_token: ''
|
|
matrix_bridge_mautrix_googlechat_homeserver_token: ''
|
|
|
|
# Whether or not metrics endpoint should be enabled.
|
|
# Enabling them is usually enough for a local (in-container) Prometheus to consume them.
|
|
# If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_bridge_mautrix_googlechat_metrics_proxying_enabled`.
|
|
matrix_bridge_mautrix_googlechat_metrics_enabled: false
|
|
|
|
# Controls whether metrics should be proxied (exposed) on a public URL.
|
|
matrix_bridge_mautrix_googlechat_metrics_proxying_enabled: false
|
|
matrix_bridge_mautrix_googlechat_metrics_proxying_hostname: ''
|
|
matrix_bridge_mautrix_googlechat_metrics_proxying_path_prefix: ''
|
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
# If false, created portal rooms will never be federated.
|
|
matrix_bridge_mautrix_googlechat_federate_rooms: true
|
|
|
|
matrix_bridge_mautrix_googlechat_bridge_permissions: |
|
|
{{
|
|
{matrix_bridge_mautrix_googlechat_homeserver_domain: 'user'}
|
|
| combine({matrix_admin: 'admin'} if matrix_admin else {})
|
|
}}
|
|
|
|
# Database-related configuration fields.
|
|
#
|
|
# To use SQLite, stick to these defaults.
|
|
#
|
|
# To use Postgres:
|
|
# - change the engine (`matrix_bridge_mautrix_googlechat_database_engine: 'postgres'`)
|
|
# - adjust your database credentials via the `matrix_bridge_mautrix_googlechat_database_*` variables
|
|
matrix_bridge_mautrix_googlechat_database_engine: 'sqlite'
|
|
|
|
matrix_bridge_mautrix_googlechat_sqlite_database_path_local: "{{ matrix_bridge_mautrix_googlechat_data_path }}/mautrix-googlechat.db"
|
|
matrix_bridge_mautrix_googlechat_sqlite_database_path_in_container: "/data/mautrix-googlechat.db"
|
|
|
|
matrix_bridge_mautrix_googlechat_database_username: 'matrix_mautrix_googlechat'
|
|
matrix_bridge_mautrix_googlechat_database_password: 'some-password'
|
|
matrix_bridge_mautrix_googlechat_database_hostname: ''
|
|
matrix_bridge_mautrix_googlechat_database_port: 5432
|
|
matrix_bridge_mautrix_googlechat_database_name: 'matrix_mautrix_googlechat'
|
|
|
|
matrix_bridge_mautrix_googlechat_database_connection_string: 'postgres://{{ matrix_bridge_mautrix_googlechat_database_username }}:{{ matrix_bridge_mautrix_googlechat_database_password }}@{{ matrix_bridge_mautrix_googlechat_database_hostname }}:{{ matrix_bridge_mautrix_googlechat_database_port }}/{{ matrix_bridge_mautrix_googlechat_database_name }}'
|
|
|
|
matrix_bridge_mautrix_googlechat_appservice_database: "{{ {
|
|
'sqlite': ('sqlite:///' + matrix_bridge_mautrix_googlechat_sqlite_database_path_in_container),
|
|
'postgres': matrix_bridge_mautrix_googlechat_database_connection_string,
|
|
}[matrix_bridge_mautrix_googlechat_database_engine] }}"
|
|
|
|
|
|
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth) or Appservice Double Puppet.
|
|
matrix_bridge_mautrix_googlechat_login_shared_secret: ''
|
|
|
|
matrix_bridge_mautrix_googlechat_appservice_bot_username: googlechatbot
|
|
|
|
# Specifies the default log level for all bridge loggers.
|
|
matrix_bridge_mautrix_googlechat_logging_level: WARNING
|
|
|
|
# Default 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_bridge_mautrix_googlechat_configuration_extension_yaml`)
|
|
# or completely replace this variable with your own template.
|
|
matrix_bridge_mautrix_googlechat_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_bridge_mautrix_googlechat_configuration_extension_yaml: |
|
|
# Your custom YAML configuration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_bridge_mautrix_googlechat_configuration_yaml`).
|
|
#
|
|
# You can override individual variables from the default configuration, or introduce new ones.
|
|
#
|
|
# If you need something more special, you can take full control by
|
|
# completely redefining `matrix_bridge_mautrix_googlechat_configuration_yaml`.
|
|
|
|
matrix_bridge_mautrix_googlechat_configuration_extension: "{{ matrix_bridge_mautrix_googlechat_configuration_extension_yaml | from_yaml if matrix_bridge_mautrix_googlechat_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
|
|
|
# Holds the final configuration (a combination of the default and its extension).
|
|
# You most likely don't need to touch this variable. Instead, see `matrix_bridge_mautrix_googlechat_configuration_yaml`.
|
|
matrix_bridge_mautrix_googlechat_configuration: "{{ matrix_bridge_mautrix_googlechat_configuration_yaml | from_yaml | combine(matrix_bridge_mautrix_googlechat_configuration_extension, recursive=True) }}"
|
|
|
|
matrix_bridge_mautrix_googlechat_registration_yaml: |
|
|
id: googlechat
|
|
as_token: "{{ matrix_bridge_mautrix_googlechat_appservice_token }}"
|
|
hs_token: "{{ matrix_bridge_mautrix_googlechat_homeserver_token }}"
|
|
namespaces:
|
|
users:
|
|
- exclusive: true
|
|
regex: '^@googlechat_.+:{{ matrix_bridge_mautrix_googlechat_homeserver_domain | regex_escape }}$'
|
|
- exclusive: true
|
|
regex: '^@{{ matrix_bridge_mautrix_googlechat_appservice_bot_username | regex_escape }}:{{ matrix_bridge_mautrix_googlechat_homeserver_domain | regex_escape }}$'
|
|
url: {{ matrix_bridge_mautrix_googlechat_appservice_address }}
|
|
# See https://github.com/mautrix/signal/issues/43
|
|
sender_localpart: _bot_{{ matrix_bridge_mautrix_googlechat_appservice_bot_username }}
|
|
rate_limited: false
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
receive_ephemeral: true
|
|
|
|
matrix_bridge_mautrix_googlechat_registration: "{{ matrix_bridge_mautrix_googlechat_registration_yaml | from_yaml }}"
|
|
|
|
# Enable End-to-bridge encryption
|
|
matrix_bridge_mautrix_googlechat_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
|
|
matrix_bridge_mautrix_googlechat_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
|
|
|
|
# matrix_bridge_mautrix_googlechat_restart_necessary controls whether the service
|
|
# will be restarted (when true) or merely started (when false) by the
|
|
# systemd service manager role (when conditional restart is enabled).
|
|
#
|
|
# This value is automatically computed during installation based on whether
|
|
# any configuration files, the systemd service file, or the container image changed.
|
|
# The default of `false` means "no restart needed" — appropriate when the role's
|
|
# installation tasks haven't run (e.g., due to --tags skipping them).
|
|
matrix_bridge_mautrix_googlechat_restart_necessary: false
|