mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-04-25 01:47:35 +00:00
5b7a1c2a6c
Matches the earlier Python -> Go rewrites of the other mautrix-* bridges. Related to: - https://github.com/mautrix/telegram/releases/tag/v0.2604.0 - https://mau.fi/blog/2026-04-mautrix-release/ The bridge is now a Go binary with upstream-handled automatic database and config migration on first start, so in-place upgrades on Postgres should Just Work for users on the defaults. The lottieconverter sidecar container is gone (bundled upstream), and the public web-based login endpoint is gone (login happens inside Matrix now). Upstream v0.2604.0 has a known bug in the legacy SQLite migration that can corrupt data. The role detects legacy Python-bridge SQLite databases (via the `telethon_sessions` table signature) and refuses to upgrade, pointing users to switch to Postgres (playbook-managed pgloader migration) or wait for the next upstream release. The guard is isolated in its own `validate_config_sqlite_legacy_migration_bug.yml` so it can be deleted cleanly once upstream fixes the bug. Removed variables (all caught by the deprecation check in `validate_config.yml` with actionable rename/removal hints): the entire `_hostname` / `_path_prefix` / `_scheme` / `_public_endpoint` / `_appservice_public_*` / `_container_labels_public_endpoint_*` / `_container_http_host_bind_port` family (web login endpoint is gone); `_bot_token` (old-style relaybot is gone, use the common bridgev2 relay mode); `_filter_mode` (dropped upstream); `_bridge_login_shared_secret_map*` (use Appservice Double Puppet); `_username_template`, `_alias_template`, `_displayname_template` (templates moved under `network:`, new Go-template syntax, exposed via `_network_displayname_template`); all `_lottieconverter_*` variables; `_appservice_database` (renamed to `_appservice_database_uri`). Added playbook-time validation that catches legacy permission values (`relaybot`, `puppeting`, `full`) in the fully-merged config (so overrides via `matrix_mautrix_telegram_configuration_extension_yaml` are caught too), with a mapping hint in the error message. Other notes: - The legacy sqlite->postgres relocation of `{base_path}/mautrix-telegram.db` to `{data_path}/mautrix-telegram.db` now happens BEFORE the pgloader migration step, so users who flip to Postgres as part of this upgrade get their data imported correctly. - The Ketesa managed-user regex for the telegram namespace is updated to match both regular IDs and the new `channel-<id>` form used by bridgev2. - `matrix_playbook_migration_expected_version` bumped to v2026.04.24.0, with a new breaking-change entry pointing at the CHANGELOG section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
261 lines
14 KiB
YAML
261 lines
14 KiB
YAML
# SPDX-FileCopyrightText: 2019 - 2024 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2019 - 2026 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2020 Johanna Dorothea Reichmann
|
|
# SPDX-FileCopyrightText: 2020 Marcel Partap
|
|
# SPDX-FileCopyrightText: 2021 Aaron Raimist
|
|
# SPDX-FileCopyrightText: 2021 Panagiotis Georgiadis
|
|
# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi
|
|
# SPDX-FileCopyrightText: 2022 László Várady
|
|
# SPDX-FileCopyrightText: 2022 Marko Weltzer
|
|
# SPDX-FileCopyrightText: 2022 Olivér Falvai
|
|
# SPDX-FileCopyrightText: 2022 Vincent Post
|
|
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
|
|
# SPDX-FileCopyrightText: 2024 Pierre 'McFly' Marty
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
|
|
# mautrix-telegram is a Matrix <-> Telegram bridge
|
|
# Project source code URL: https://github.com/mautrix/telegram
|
|
|
|
matrix_mautrix_telegram_enabled: true
|
|
|
|
matrix_mautrix_telegram_container_image_self_build: false
|
|
matrix_mautrix_telegram_container_image_self_build_repo: "https://mau.dev/mautrix/telegram.git"
|
|
matrix_mautrix_telegram_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_telegram_version == 'latest' else matrix_mautrix_telegram_version }}"
|
|
|
|
# renovate: datasource=docker depName=dock.mau.dev/mautrix/telegram
|
|
matrix_mautrix_telegram_version: v0.2604.0
|
|
|
|
# See: https://mau.dev/mautrix/telegram/container_registry
|
|
matrix_mautrix_telegram_container_image: "{{ matrix_mautrix_telegram_container_image_registry_prefix }}mautrix/telegram:{{ matrix_mautrix_telegram_version }}"
|
|
matrix_mautrix_telegram_container_image_registry_prefix: "{{ 'localhost/' if matrix_mautrix_telegram_container_image_self_build else matrix_mautrix_telegram_container_image_registry_prefix_upstream }}"
|
|
matrix_mautrix_telegram_container_image_registry_prefix_upstream: "{{ matrix_mautrix_telegram_container_image_registry_prefix_upstream_default }}"
|
|
matrix_mautrix_telegram_container_image_registry_prefix_upstream_default: "dock.mau.dev/"
|
|
matrix_mautrix_telegram_container_image_force_pull: "{{ matrix_mautrix_telegram_container_image.endswith(':latest') }}"
|
|
|
|
matrix_mautrix_telegram_base_path: "{{ matrix_base_data_path }}/mautrix-telegram"
|
|
matrix_mautrix_telegram_config_path: "{{ matrix_mautrix_telegram_base_path }}/config"
|
|
matrix_mautrix_telegram_data_path: "{{ matrix_mautrix_telegram_base_path }}/data"
|
|
matrix_mautrix_telegram_container_src_files_path: "{{ matrix_mautrix_telegram_base_path }}/docker-src"
|
|
|
|
matrix_mautrix_telegram_homeserver_address: ""
|
|
matrix_mautrix_telegram_homeserver_domain: '{{ matrix_domain }}'
|
|
# Whether asynchronous uploads via MSC2246 should be enabled for media.
|
|
# Requires a homeserver that supports MSC2246 (https://github.com/matrix-org/matrix-spec-proposals/pull/2246).
|
|
matrix_mautrix_telegram_homeserver_async_media: false
|
|
matrix_mautrix_telegram_appservice_address: 'http://matrix-mautrix-telegram:8080'
|
|
|
|
matrix_mautrix_telegram_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
|
|
matrix_mautrix_telegram_self_sign_enabled: "{{ matrix_bridges_self_sign_enabled }}"
|
|
|
|
matrix_mautrix_telegram_command_prefix: "!tg"
|
|
|
|
# Get your own API keys at https://my.telegram.org/apps
|
|
matrix_mautrix_telegram_api_id: ''
|
|
matrix_mautrix_telegram_api_hash: ''
|
|
|
|
matrix_mautrix_telegram_container_network: ""
|
|
|
|
matrix_mautrix_telegram_container_additional_networks: "{{ matrix_mautrix_telegram_container_additional_networks_auto + matrix_mautrix_telegram_container_additional_networks_custom }}"
|
|
matrix_mautrix_telegram_container_additional_networks_auto: []
|
|
matrix_mautrix_telegram_container_additional_networks_custom: []
|
|
|
|
# matrix_mautrix_telegram_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_mautrix_telegram_container_labels_additional_labels`.
|
|
matrix_mautrix_telegram_container_labels_traefik_enabled: true
|
|
matrix_mautrix_telegram_container_labels_traefik_docker_network: "{{ matrix_mautrix_telegram_container_network }}"
|
|
matrix_mautrix_telegram_container_labels_traefik_entrypoints: web-secure
|
|
matrix_mautrix_telegram_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
# Controls whether labels will be added that expose mautrix-telegram's metrics
|
|
matrix_mautrix_telegram_container_labels_metrics_enabled: "{{ matrix_mautrix_telegram_metrics_enabled and matrix_mautrix_telegram_metrics_proxying_enabled }}"
|
|
matrix_mautrix_telegram_container_labels_metrics_traefik_rule: "Host(`{{ matrix_mautrix_telegram_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_mautrix_telegram_metrics_proxying_path_prefix }}`)"
|
|
matrix_mautrix_telegram_container_labels_metrics_traefik_priority: 0
|
|
matrix_mautrix_telegram_container_labels_metrics_traefik_entrypoints: "{{ matrix_mautrix_telegram_container_labels_traefik_entrypoints }}"
|
|
matrix_mautrix_telegram_container_labels_metrics_traefik_tls: "{{ matrix_mautrix_telegram_container_labels_metrics_traefik_entrypoints != 'web' }}"
|
|
matrix_mautrix_telegram_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_mautrix_telegram_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
matrix_mautrix_telegram_container_labels_metrics_middleware_basic_auth_enabled: false
|
|
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
|
|
matrix_mautrix_telegram_container_labels_metrics_middleware_basic_auth_users: ''
|
|
|
|
# matrix_mautrix_telegram_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_mautrix_telegram_container_labels_additional_labels: |
|
|
# my.label=1
|
|
# another.label="here"
|
|
matrix_mautrix_telegram_container_labels_additional_labels: ''
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_mautrix_telegram_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-mautrix-telegram.service depends on.
|
|
matrix_mautrix_telegram_systemd_required_services_list: "{{ matrix_mautrix_telegram_systemd_required_services_list_default + matrix_mautrix_telegram_systemd_required_services_list_auto + matrix_mautrix_telegram_systemd_required_services_list_custom }}"
|
|
matrix_mautrix_telegram_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
|
matrix_mautrix_telegram_systemd_required_services_list_auto: []
|
|
matrix_mautrix_telegram_systemd_required_services_list_custom: []
|
|
|
|
# List of systemd services that matrix-mautrix-telegram.service wants
|
|
matrix_mautrix_telegram_systemd_wanted_services_list: []
|
|
|
|
matrix_mautrix_telegram_appservice_token: ''
|
|
matrix_mautrix_telegram_homeserver_token: ''
|
|
|
|
matrix_mautrix_telegram_appservice_bot_username: telegrambot
|
|
|
|
# Minimum severity of journal log messages.
|
|
# Valid values: fatal, error, warn, info, debug, trace
|
|
matrix_mautrix_telegram_logging_level: 'warn'
|
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
# If false, created portal rooms will never be federated.
|
|
matrix_mautrix_telegram_federate_rooms: true
|
|
|
|
# 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_mautrix_telegram_metrics_proxying_enabled`.
|
|
matrix_mautrix_telegram_metrics_enabled: false
|
|
|
|
# Controls whether metrics should be proxied (exposed) on a public URL
|
|
matrix_mautrix_telegram_metrics_proxying_enabled: false
|
|
matrix_mautrix_telegram_metrics_proxying_hostname: ''
|
|
matrix_mautrix_telegram_metrics_proxying_path_prefix: ''
|
|
|
|
# Database-related configuration fields.
|
|
#
|
|
# To use SQLite, stick to these defaults.
|
|
#
|
|
# To use Postgres:
|
|
# - change the engine (`matrix_mautrix_telegram_database_engine: 'postgres'`)
|
|
# - adjust your database credentials via the `matrix_mautrix_telegram_database_*` variables
|
|
matrix_mautrix_telegram_database_engine: 'sqlite'
|
|
|
|
matrix_mautrix_telegram_sqlite_database_path_local: "{{ matrix_mautrix_telegram_data_path }}/mautrix-telegram.db"
|
|
matrix_mautrix_telegram_sqlite_database_path_in_container: "/data/mautrix-telegram.db"
|
|
|
|
matrix_mautrix_telegram_database_username: 'matrix_mautrix_telegram'
|
|
matrix_mautrix_telegram_database_password: 'some-password'
|
|
matrix_mautrix_telegram_database_hostname: ''
|
|
matrix_mautrix_telegram_database_port: 5432
|
|
matrix_mautrix_telegram_database_name: 'matrix_mautrix_telegram'
|
|
matrix_mautrix_telegram_database_sslmode: disable
|
|
|
|
matrix_mautrix_telegram_database_connection_string: 'postgresql://{{ matrix_mautrix_telegram_database_username }}:{{ matrix_mautrix_telegram_database_password }}@{{ matrix_mautrix_telegram_database_hostname }}:{{ matrix_mautrix_telegram_database_port }}/{{ matrix_mautrix_telegram_database_name }}?sslmode={{ matrix_mautrix_telegram_database_sslmode }}'
|
|
|
|
matrix_mautrix_telegram_appservice_database_type: "{{
|
|
{
|
|
'sqlite': 'sqlite3-fk-wal',
|
|
'postgres':'postgres',
|
|
}[matrix_mautrix_telegram_database_engine]
|
|
}}"
|
|
|
|
matrix_mautrix_telegram_appservice_database_uri: "{{
|
|
{
|
|
'sqlite': matrix_mautrix_telegram_sqlite_database_path_in_container,
|
|
'postgres': matrix_mautrix_telegram_database_connection_string,
|
|
}[matrix_mautrix_telegram_database_engine]
|
|
}}"
|
|
|
|
matrix_mautrix_telegram_double_puppet_secrets: "{{ matrix_mautrix_telegram_double_puppet_secrets_auto | combine(matrix_mautrix_telegram_double_puppet_secrets_custom) }}"
|
|
matrix_mautrix_telegram_double_puppet_secrets_auto: {}
|
|
matrix_mautrix_telegram_double_puppet_secrets_custom: {}
|
|
|
|
# Displayname template for Telegram users.
|
|
# Available variables:
|
|
# {{ .FullName }} - the full name of the Telegram user
|
|
# {{ .FirstName }} - the first name of the Telegram user
|
|
# {{ .LastName }} - the last name of the Telegram user
|
|
# {{ .Username }} - the primary username of the Telegram user, if the user has one
|
|
# {{ .UserID }} - the internal user ID of the Telegram user
|
|
# {{ .Deleted }} - true if the user has been deleted, false otherwise
|
|
matrix_mautrix_telegram_network_displayname_template: '{% raw %}{{ if .Deleted }}Deleted account {{ .UserID }}{{ else }}{{ .FullName }}{{ end }}{% endraw %}'
|
|
|
|
# Enable End-to-bridge encryption
|
|
matrix_mautrix_telegram_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
|
|
matrix_mautrix_telegram_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
|
|
matrix_mautrix_telegram_bridge_encryption_require: false
|
|
matrix_mautrix_telegram_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_telegram_bridge_encryption_allow }}"
|
|
# This pickle key value is backward-compatible with the legacy (Python) bridge.
|
|
# See: https://mau.dev/mautrix/telegram/-/blob/v0.2604.0/cmd/mautrix-telegram/legacymigrate.go
|
|
matrix_mautrix_telegram_bridge_encryption_pickle_key: mautrix.bridge.e2ee
|
|
|
|
matrix_mautrix_telegram_bridge_personal_filtering_spaces: true
|
|
|
|
matrix_mautrix_telegram_provisioning_shared_secret: ''
|
|
matrix_mautrix_telegram_public_media_signing_key: ''
|
|
|
|
matrix_mautrix_telegram_bridge_permissions: |
|
|
{{
|
|
{'*': 'relay', matrix_mautrix_telegram_homeserver_domain: 'user'}
|
|
| combine({matrix_admin: 'admin'} if matrix_admin else {})
|
|
}}
|
|
|
|
# Enable bridge relay functionality
|
|
matrix_mautrix_telegram_bridge_relay_enabled: "{{ matrix_bridges_relay_enabled }}"
|
|
|
|
# Only allow admins on this home server to set themselves as a relay user
|
|
matrix_mautrix_telegram_bridge_relay_admin_only: true
|
|
|
|
# List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
|
|
matrix_mautrix_telegram_bridge_relay_default_relays: []
|
|
|
|
# Controls whether to do backfilling at all.
|
|
matrix_mautrix_telegram_backfill_enabled: true
|
|
|
|
# Default mautrix-telegram 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_mautrix_telegram_configuration_extension_yaml`)
|
|
# or completely replace this variable with your own template.
|
|
matrix_mautrix_telegram_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_mautrix_telegram_configuration_extension_yaml: |
|
|
# Your custom YAML configuration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_mautrix_telegram_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_mautrix_telegram_configuration_yaml`.
|
|
|
|
matrix_mautrix_telegram_configuration_extension: "{{ matrix_mautrix_telegram_configuration_extension_yaml | from_yaml if matrix_mautrix_telegram_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_mautrix_telegram_configuration_yaml`.
|
|
matrix_mautrix_telegram_configuration: "{{ matrix_mautrix_telegram_configuration_yaml | from_yaml | combine(matrix_mautrix_telegram_configuration_extension, recursive=True) }}"
|
|
|
|
matrix_mautrix_telegram_registration_yaml: |
|
|
id: telegram
|
|
url: {{ matrix_mautrix_telegram_appservice_address }}
|
|
as_token: "{{ matrix_mautrix_telegram_appservice_token }}"
|
|
hs_token: "{{ matrix_mautrix_telegram_homeserver_token }}"
|
|
# See https://github.com/mautrix/signal/issues/43
|
|
sender_localpart: _bot_{{ matrix_mautrix_telegram_appservice_bot_username }}
|
|
rate_limited: false
|
|
namespaces:
|
|
users:
|
|
- exclusive: true
|
|
regex: '^@telegram_.+:{{ matrix_mautrix_telegram_homeserver_domain | regex_escape }}$'
|
|
- exclusive: true
|
|
regex: '^@{{ matrix_mautrix_telegram_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_telegram_homeserver_domain | regex_escape }}$'
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
receive_ephemeral: true
|
|
io.element.msc4190: {{ matrix_mautrix_telegram_msc4190_enabled | to_json }}
|
|
|
|
matrix_mautrix_telegram_registration: "{{ matrix_mautrix_telegram_registration_yaml | from_yaml }}"
|
|
|
|
# matrix_mautrix_telegram_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_mautrix_telegram_restart_necessary: false
|