matrix-docker-ansible-deploy/roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml

# SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors
# SPDX-FileCopyrightText: 2021 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2021 Matthew Cengia
# SPDX-FileCopyrightText: 2022 - 2024 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 Aaron Raimist
# SPDX-FileCopyrightText: 2022 László Várady
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2023 Adrien le Maire
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
# SPDX-FileCopyrightText: 2024 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
# mautrix-twitter is a Matrix <-> Twitter bridge
# Project source code URL: https://github.com/mautrix/twitter

matrix_bridge_mautrix_twitter_enabled: true

matrix_bridge_mautrix_twitter_container_image_self_build: false
matrix_bridge_mautrix_twitter_container_image_self_build_repo: "https://github.com/mautrix/twitter.git"
matrix_bridge_mautrix_twitter_container_image_self_build_repo_version: "{{ 'master' if matrix_bridge_mautrix_twitter_version == 'latest' else matrix_bridge_mautrix_twitter_version }}"

# renovate: datasource=docker depName=dock.mau.dev/mautrix/twitter
matrix_bridge_mautrix_twitter_version: v0.2609.0
# See: https://mau.dev/tulir/mautrix-twitter/container_registry
matrix_bridge_mautrix_twitter_container_image: "{{ matrix_bridge_mautrix_twitter_container_image_registry_prefix }}mautrix/twitter:{{ matrix_bridge_mautrix_twitter_version }}"
matrix_bridge_mautrix_twitter_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_mautrix_twitter_container_image_self_build else matrix_bridge_mautrix_twitter_container_image_registry_prefix_upstream }}"
matrix_bridge_mautrix_twitter_container_image_registry_prefix_upstream: "{{ matrix_bridge_mautrix_twitter_container_image_registry_prefix_upstream_default }}"
matrix_bridge_mautrix_twitter_container_image_registry_prefix_upstream_default: "dock.mau.dev/"

matrix_bridge_mautrix_twitter_base_path: "{{ matrix_base_data_path }}/mautrix-twitter"
matrix_bridge_mautrix_twitter_config_path: "{{ matrix_bridge_mautrix_twitter_base_path }}/config"
matrix_bridge_mautrix_twitter_data_path: "{{ matrix_bridge_mautrix_twitter_base_path }}/data"
matrix_bridge_mautrix_twitter_container_src_files_path: "{{ matrix_bridge_mautrix_twitter_base_path }}/docker-src"

matrix_bridge_mautrix_twitter_homeserver_address: ""
# 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_bridge_mautrix_twitter_homeserver_async_media: false
matrix_bridge_mautrix_twitter_homeserver_domain: '{{ matrix_domain }}'
matrix_bridge_mautrix_twitter_appservice_address: 'http://matrix-mautrix-twitter:29327'

matrix_bridge_mautrix_twitter_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
matrix_bridge_mautrix_twitter_self_sign_enabled: "{{ matrix_bridges_self_sign_enabled }}"

# Scheme of the bridge's public address (see `matrix_bridge_mautrix_twitter_appservice_public_address`).
matrix_bridge_mautrix_twitter_scheme: https

# A public address that external services can use to reach this appservice (when exposed).
# Used for the provisioning API's external-server (OpenID) flow and for public media links.
matrix_bridge_mautrix_twitter_appservice_public_address: "{{ (matrix_bridge_mautrix_twitter_scheme + '://' + matrix_bridge_mautrix_twitter_exposure_hostname + matrix_bridge_mautrix_twitter_exposure_path_prefix) if matrix_bridge_mautrix_twitter_exposure_enabled else '' }}"

# Displayname template for Twitter users.
# {{ .DisplayName }} is replaced with the display name of the Twitter user.
# {{ .Username }} is replaced with the username of the Twitter user.
matrix_bridge_mautrix_twitter_network_displayname_template: "{% raw %}{{ .DisplayName }} (Twitter){% endraw %}"

matrix_bridge_mautrix_twitter_bridge_command_prefix: "!tw"

matrix_bridge_mautrix_twitter_bridge_permissions: |
  {{
    {matrix_bridge_mautrix_twitter_homeserver_domain: 'user'}
    | combine({matrix_admin: 'admin'} if matrix_admin else {})
  }}

matrix_bridge_mautrix_twitter_container_network: ""

matrix_bridge_mautrix_twitter_container_additional_networks: "{{ matrix_bridge_mautrix_twitter_container_additional_networks_auto + matrix_bridge_mautrix_twitter_container_additional_networks_custom }}"
matrix_bridge_mautrix_twitter_container_additional_networks_auto: []
matrix_bridge_mautrix_twitter_container_additional_networks_custom: []

# matrix_bridge_mautrix_twitter_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_twitter_container_labels_additional_labels`.
matrix_bridge_mautrix_twitter_container_labels_traefik_enabled: true
matrix_bridge_mautrix_twitter_container_labels_traefik_docker_network: "{{ matrix_bridge_mautrix_twitter_container_network }}"
matrix_bridge_mautrix_twitter_container_labels_traefik_entrypoints: web-secure
matrix_bridge_mautrix_twitter_container_labels_traefik_tls_certResolver: default  # noqa var-naming

# Controls whether labels will be added that expose mautrix-twitter's HTTP API
# (used by tools like mautrix-manager for bridge login) at `https://<hostname><path_prefix>`.
matrix_bridge_mautrix_twitter_container_labels_exposure_enabled: "{{ matrix_bridge_mautrix_twitter_exposure_enabled }}"
matrix_bridge_mautrix_twitter_container_labels_exposure_traefik_rule: "Host(`{{ matrix_bridge_mautrix_twitter_exposure_hostname }}`) && PathPrefix(`{{ matrix_bridge_mautrix_twitter_exposure_path_prefix }}`)"
matrix_bridge_mautrix_twitter_container_labels_exposure_traefik_priority: 0
matrix_bridge_mautrix_twitter_container_labels_exposure_traefik_entrypoints: "{{ matrix_bridge_mautrix_twitter_container_labels_traefik_entrypoints }}"
matrix_bridge_mautrix_twitter_container_labels_exposure_traefik_tls: "{{ matrix_bridge_mautrix_twitter_container_labels_exposure_traefik_entrypoints != 'web' }}"
matrix_bridge_mautrix_twitter_container_labels_exposure_traefik_tls_certResolver: "{{ matrix_bridge_mautrix_twitter_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

# matrix_bridge_mautrix_twitter_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_twitter_container_labels_additional_labels: |
#   my.label=1
#   another.label="here"
matrix_bridge_mautrix_twitter_container_labels_additional_labels: ''

# A list of extra arguments to pass to the container
matrix_bridge_mautrix_twitter_container_extra_arguments: []

# Controls how long the pre-start cleanup should wait for stale container-name release
# before failing startup explicitly.
matrix_bridge_mautrix_twitter_container_cleanup_timeout_seconds: "{{ devture_systemd_docker_base_container_cleanup_timeout_seconds }}"

# Controls the delay between pre-start cleanup retries.
matrix_bridge_mautrix_twitter_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_twitter_container_cleanup_command: |
  i=0;
  while [ "$i" -lt {{ matrix_bridge_mautrix_twitter_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-twitter >/dev/null 2>&1 || true;
  {{ devture_systemd_docker_base_host_command_docker }} rm -f matrix-mautrix-twitter >/dev/null 2>&1 || true;
  if {{ devture_systemd_docker_base_host_command_docker }} container inspect matrix-mautrix-twitter >/dev/null 2>&1; then
  i=$((i + 1));
  sleep {{ matrix_bridge_mautrix_twitter_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-twitter" >&2;
  exit 1;
  done;
  echo "Failed to remove stale container matrix-mautrix-twitter after {{ matrix_bridge_mautrix_twitter_container_cleanup_timeout_seconds }} attempts" >&2;
  exit 1

# List of systemd services that matrix-mautrix-twitter.service depends on.
matrix_bridge_mautrix_twitter_systemd_required_services_list: "{{ matrix_bridge_mautrix_twitter_systemd_required_services_list_default + matrix_bridge_mautrix_twitter_systemd_required_services_list_auto + matrix_bridge_mautrix_twitter_systemd_required_services_list_custom }}"
matrix_bridge_mautrix_twitter_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
matrix_bridge_mautrix_twitter_systemd_required_services_list_auto: []
matrix_bridge_mautrix_twitter_systemd_required_services_list_custom: []

# List of systemd services that matrix-mautrix-twitter.service wants
matrix_bridge_mautrix_twitter_systemd_wanted_services_list: []

matrix_bridge_mautrix_twitter_appservice_token: ''
matrix_bridge_mautrix_twitter_homeserver_token: ''

# Whether or not created rooms should have federation enabled.
# If false, created portal rooms will never be federated.
matrix_bridge_mautrix_twitter_matrix_federate_rooms: true

# Database-related configuration fields.
#
# To use Postgres:
# - adjust your database credentials via the `matrix_bridge_mautrix_twitter_postgres_*` variables
matrix_bridge_mautrix_twitter_database_engine: 'postgres'

matrix_bridge_mautrix_twitter_database_username: 'matrix_mautrix_twitter'
matrix_bridge_mautrix_twitter_database_password: 'some-password'
matrix_bridge_mautrix_twitter_database_hostname: ''
matrix_bridge_mautrix_twitter_database_port: 5432
matrix_bridge_mautrix_twitter_database_name: 'matrix_mautrix_twitter'
matrix_bridge_mautrix_twitter_database_sslmode: disable

matrix_bridge_mautrix_twitter_database_connection_string: 'postgres://{{ matrix_bridge_mautrix_twitter_database_username }}:{{ matrix_bridge_mautrix_twitter_database_password }}@{{ matrix_bridge_mautrix_twitter_database_hostname }}:{{ matrix_bridge_mautrix_twitter_database_port }}/{{ matrix_bridge_mautrix_twitter_database_name }}?sslmode={{ matrix_bridge_mautrix_twitter_database_sslmode }}'

matrix_bridge_mautrix_twitter_database_uri: "{{ {
    'postgres': matrix_bridge_mautrix_twitter_database_connection_string,
}[matrix_bridge_mautrix_twitter_database_engine] }}"

matrix_bridge_mautrix_twitter_double_puppet_secrets: "{{ matrix_bridge_mautrix_twitter_double_puppet_secrets_auto | combine(matrix_bridge_mautrix_twitter_double_puppet_secrets_custom) }}"
matrix_bridge_mautrix_twitter_double_puppet_secrets_auto: {}
matrix_bridge_mautrix_twitter_double_puppet_secrets_custom: {}

matrix_bridge_mautrix_twitter_appservice_bot_username: twitterbot
matrix_bridge_mautrix_twitter_appservice_bot_displayname: Twitter bridge bot
matrix_bridge_mautrix_twitter_appservice_bot_avatar: mxc://maunium.net/HVHcnusJkQcpVcsVGZRELLCn

matrix_bridge_mautrix_twitter_backfill_enabled: true
# Maximum number of messages to backfill in empty rooms
matrix_bridge_mautrix_twitter_backfill_max_initial_messages: 50

# Maximum number of missed messages to backfill after bridge restarts
matrix_bridge_mautrix_twitter_backfill_max_catchup_messages: 500

# Shared secret for authentication of provisioning API requests.
# If set to "disable", the provisioning API will be disabled.
matrix_bridge_mautrix_twitter_provisioning_shared_secret: disable

# Minimum severity of journal log messages.
# Valid values: fatal, error, warn, info, debug, trace
matrix_bridge_mautrix_twitter_logging_level: 'warn'

# Controls whether mautrix-twitter's HTTP API is exposed publicly (used by tools like mautrix-manager for bridge login).
matrix_bridge_mautrix_twitter_exposure_enabled: false
matrix_bridge_mautrix_twitter_exposure_hostname: ''
matrix_bridge_mautrix_twitter_exposure_path_prefix: ''

# 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_twitter_configuration_extension_yaml`)
# or completely replace this variable with your own template.
matrix_bridge_mautrix_twitter_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"

matrix_bridge_mautrix_twitter_configuration_extension_yaml: |
  # Your custom YAML configuration goes here.
  # This configuration extends the default starting configuration (`matrix_bridge_mautrix_twitter_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_twitter_configuration_yaml`.

matrix_bridge_mautrix_twitter_configuration_extension: "{{ matrix_bridge_mautrix_twitter_configuration_extension_yaml | from_yaml if matrix_bridge_mautrix_twitter_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_twitter_configuration_yaml`.
matrix_bridge_mautrix_twitter_configuration: "{{ matrix_bridge_mautrix_twitter_configuration_yaml | from_yaml | combine(matrix_bridge_mautrix_twitter_configuration_extension, recursive=True) }}"

matrix_bridge_mautrix_twitter_registration_yaml: |
  id: twitter
  as_token: "{{ matrix_bridge_mautrix_twitter_appservice_token }}"
  hs_token: "{{ matrix_bridge_mautrix_twitter_homeserver_token }}"
  namespaces:
    users:
    - exclusive: true
      regex: '^@twitter_.+:{{ matrix_bridge_mautrix_twitter_homeserver_domain | regex_escape }}$'
    - exclusive: true
      regex: '^@{{ matrix_bridge_mautrix_twitter_appservice_bot_username | regex_escape }}:{{ matrix_bridge_mautrix_twitter_homeserver_domain | regex_escape }}$'
  url: {{ matrix_bridge_mautrix_twitter_appservice_address }}
  # See https://github.com/tulir/mautrix-twitter/issues/43
  sender_localpart: _bot_{{ matrix_bridge_mautrix_twitter_appservice_bot_username }}
  rate_limited: false
  de.sorunome.msc2409.push_ephemeral: true
  receive_ephemeral: true
  io.element.msc4190: {{ matrix_bridge_mautrix_twitter_msc4190_enabled | to_json }}

matrix_bridge_mautrix_twitter_registration: "{{ matrix_bridge_mautrix_twitter_registration_yaml | from_yaml }}"

# Enable End-to-bridge encryption
matrix_bridge_mautrix_twitter_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
matrix_bridge_mautrix_twitter_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
matrix_bridge_mautrix_twitter_bridge_encryption_require: false
matrix_bridge_mautrix_twitter_bridge_encryption_appservice: false
matrix_bridge_mautrix_twitter_bridge_encryption_key_sharing_allow: "{{ matrix_bridge_mautrix_twitter_bridge_encryption_allow }}"
# This pickle key value is compatible with the old mautrix-twitter bridge (before bridgev2).
matrix_bridge_mautrix_twitter_bridge_encryption_pickle_key: mautrix.bridge.e2ee

# matrix_bridge_mautrix_twitter_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_twitter_restart_necessary: false