# mautrix-telegram is a Matrix <-> Telegram bridge
# See: https://github.com/mautrix/telegram
matrix_mautrix_telegram_enabled : true
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_src_files_path : "{{ matrix_base_data_path }}/lotticonverter/docker-src"
matrix_telegram_lottieconverter_docker_image : "dock.mau.dev/tulir/lottieconverter:alpine-3.14" # needs to be ajusted according to FROM clause of Dockerfile of mautrix-telegram
matrix_mautrix_telegram_container_image_self_build : false
matrix_mautrix_telegram_docker_repo : "https://mau.dev/mautrix/telegram.git"
matrix_mautrix_telegram_docker_src_files_path : "{{ matrix_base_data_path }}/mautrix-telegram/docker-src"
matrix_mautrix_telegram_version : v0.10.2
# See: https://mau.dev/mautrix/telegram/container_registry
matrix_mautrix_telegram_docker_image : "dock.mau.dev/mautrix/telegram:{{ matrix_mautrix_telegram_version }}"
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"
# 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
# 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_homeserver_address : "{{ matrix_homeserver_container_url }}"
matrix_mautrix_telegram_homeserver_domain : '{{ matrix_domain }}'
matrix_mautrix_telegram_appservice_address : 'http://matrix-mautrix-telegram:8080'
matrix_mautrix_telegram_appservice_public_external : 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mautrix_telegram_public_endpoint }}'
matrix_mautrix_telegram_appservice_bot_username : telegrambot
# 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 : ''
# 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 : [ 'docker.service' ]
# 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 : ''
# 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-postgres'
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]
}}"
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
matrix_mautrix_telegram_login_shared_secret : ''
# 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)'