mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-29 04:17:17 +01:00
beeb8a7933
We do not let bridges update config files, so generation cannot happen. We don't want the bridge to manage the config file anyway.
234 lines
14 KiB
YAML
234 lines
14 KiB
YAML
---
|
|
|
|
# mautrix-telegram is a Matrix <-> Telegram bridge
|
|
# Project source code URL: https://github.com/mautrix/telegram
|
|
|
|
matrix_mautrix_telegram_enabled: true
|
|
|
|
matrix_mautrix_telegram_scheme: https
|
|
matrix_mautrix_telegram_hostname: ''
|
|
matrix_mautrix_telegram_path_prefix: ''
|
|
|
|
matrix_telegram_lottieconverter_container_image_self_build: false
|
|
matrix_telegram_lottieconverter_container_image_self_build_mask_arch: false
|
|
matrix_telegram_lottieconverter_docker_repo: "https://mau.dev/tulir/lottieconverter.git"
|
|
matrix_telegram_lottieconverter_docker_repo_version: "master"
|
|
matrix_telegram_lottieconverter_docker_src_files_path: "{{ matrix_base_data_path }}/lotticonverter/docker-src"
|
|
matrix_telegram_lottieconverter_docker_image: "{{ matrix_telegram_lottieconverter_docker_image_name_prefix }}tulir/lottieconverter:alpine-3.16" # needs to be adjusted according to the FROM clause of Dockerfile of mautrix-telegram
|
|
matrix_telegram_lottieconverter_docker_image_name_prefix: "{{ 'localhost/' if matrix_telegram_lottieconverter_container_image_self_build else 'dock.mau.dev/' }}"
|
|
|
|
matrix_mautrix_telegram_container_image_self_build: false
|
|
matrix_mautrix_telegram_docker_repo: "https://mau.dev/mautrix/telegram.git"
|
|
matrix_mautrix_telegram_docker_repo_version: "{{ 'master' if matrix_mautrix_telegram_version == 'latest' else matrix_mautrix_telegram_version }}"
|
|
matrix_mautrix_telegram_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-telegram/docker-src"
|
|
|
|
# renovate: datasource=docker depName=dock.mau.dev/mautrix/telegram
|
|
matrix_mautrix_telegram_version: v0.15.2
|
|
# See: https://mau.dev/mautrix/telegram/container_registry
|
|
matrix_mautrix_telegram_docker_image: "{{ matrix_mautrix_telegram_docker_image_name_prefix }}mautrix/telegram:{{ matrix_mautrix_telegram_version }}"
|
|
matrix_mautrix_telegram_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_telegram_container_image_self_build else 'dock.mau.dev/' }}"
|
|
matrix_mautrix_telegram_docker_image_force_pull: "{{ matrix_mautrix_telegram_docker_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_command_prefix: "!tg"
|
|
|
|
matrix_mautrix_telegram_bridge_permissions: |
|
|
{{
|
|
{'*': 'relaybot', matrix_mautrix_telegram_homeserver_domain: 'full'}
|
|
| combine({matrix_admin: 'admin'} if matrix_admin else {})
|
|
}}
|
|
|
|
# Get your own API keys at https://my.telegram.org/apps
|
|
matrix_mautrix_telegram_api_id: ''
|
|
matrix_mautrix_telegram_api_hash: ''
|
|
matrix_mautrix_telegram_bot_token: disabled
|
|
|
|
# Define the filter-mode
|
|
matrix_mautrix_telegram_filter_mode: "blacklist"
|
|
|
|
# Whether or not the public-facing endpoints should be enabled (web-based login)
|
|
matrix_mautrix_telegram_appservice_public_enabled: true
|
|
|
|
# Mautrix telegram public endpoint to log in to telegram
|
|
# Use an uuid so it's not easily discoverable.
|
|
# Example: /741a0483-ba17-4682-9900-30bd7269f1cc
|
|
matrix_mautrix_telegram_public_endpoint: "{{ matrix_mautrix_telegram_path_prefix }}"
|
|
|
|
matrix_mautrix_telegram_homeserver_address: ""
|
|
matrix_mautrix_telegram_homeserver_domain: '{{ matrix_domain }}'
|
|
matrix_mautrix_telegram_appservice_address: 'http://matrix-mautrix-telegram:8080'
|
|
matrix_mautrix_telegram_appservice_public_external: '{{ matrix_mautrix_telegram_scheme }}://{{ matrix_mautrix_telegram_hostname }}{{ matrix_mautrix_telegram_public_endpoint }}'
|
|
|
|
matrix_mautrix_telegram_appservice_bot_username: telegrambot
|
|
|
|
# Specifies the default log level for all bridge loggers.
|
|
matrix_mautrix_telegram_logging_level: WARNING
|
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
# If false, created portal rooms will never be federated.
|
|
matrix_mautrix_telegram_federate_rooms: true
|
|
|
|
# Controls whether the matrix-mautrix-telegram container exposes its HTTP port (tcp/8080 in the container).
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9006"), or empty string to not expose.
|
|
matrix_mautrix_telegram_container_http_host_bind_port: ''
|
|
|
|
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 public endpoint
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_enabled: "{{ matrix_mautrix_telegram_appservice_public_enabled }}"
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_hostname: "{{ matrix_mautrix_telegram_hostname }}"
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_path_prefix: "{{ matrix_mautrix_telegram_path_prefix }}"
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_mautrix_telegram_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_mautrix_telegram_container_labels_public_endpoint_path_prefix }}`)"
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_traefik_priority: 0
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_mautrix_telegram_container_labels_traefik_entrypoints }}"
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_traefik_tls: "{{ matrix_mautrix_telegram_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
|
|
matrix_mautrix_telegram_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_mautrix_telegram_container_labels_traefik_tls_certResolver }}" # 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_provisioning_shared_secret: disable
|
|
|
|
# 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 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_connection_string: 'postgres://{{ 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 }}'
|
|
|
|
matrix_mautrix_telegram_appservice_database: "{{
|
|
{
|
|
'sqlite': ('sqlite:///' + matrix_mautrix_telegram_sqlite_database_path_in_container),
|
|
'postgres': matrix_mautrix_telegram_database_connection_string,
|
|
}[matrix_mautrix_telegram_database_engine]
|
|
}}"
|
|
|
|
matrix_mautrix_telegram_bridge_login_shared_secret_map: "{{ matrix_mautrix_telegram_bridge_login_shared_secret_map_auto | combine(matrix_mautrix_telegram_bridge_login_shared_secret_map_custom) }}"
|
|
matrix_mautrix_telegram_bridge_login_shared_secret_map_auto: {}
|
|
matrix_mautrix_telegram_bridge_login_shared_secret_map_custom: {}
|
|
|
|
# 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_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
|
|
as_token: "{{ matrix_mautrix_telegram_appservice_token }}"
|
|
hs_token: "{{ matrix_mautrix_telegram_homeserver_token }}"
|
|
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 }}$'
|
|
aliases:
|
|
- exclusive: true
|
|
regex: '^#telegram_.+:{{ matrix_mautrix_telegram_homeserver_domain | regex_escape }}$'
|
|
# See https://github.com/mautrix/signal/issues/43
|
|
sender_localpart: _bot_{{ matrix_mautrix_telegram_appservice_bot_username }}
|
|
url: {{ matrix_mautrix_telegram_appservice_address }}
|
|
rate_limited: false
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
|
|
matrix_mautrix_telegram_registration: "{{ matrix_mautrix_telegram_registration_yaml | from_yaml }}"
|
|
|
|
# Templates for defining MXID's and displaynames for users and rooms.
|
|
matrix_mautrix_telegram_username_template: 'telegram_{userid}'
|
|
matrix_mautrix_telegram_alias_template: 'telegram_{groupname}'
|
|
matrix_mautrix_telegram_displayname_template: '{displayname} (Telegram)'
|
|
|
|
# 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_key_sharing_allow: "{{ matrix_mautrix_telegram_bridge_encryption_allow }}"
|