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

# SPDX-FileCopyrightText: 2021 - 2022 Toni Spets
# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2022 MDAD project contributors
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
# SPDX-FileCopyrightText: 2024 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
# Heisenbridge is a bouncer-style Matrix IRC bridge
# Project source code URL: https://github.com/hifi/heisenbridge

matrix_bridge_heisenbridge_enabled: true

matrix_bridge_heisenbridge_scheme: https
matrix_bridge_heisenbridge_hostname: "{{ matrix_server_fqn_matrix }}"
matrix_bridge_heisenbridge_path_prefix: "/heisenbridge"

# renovate: datasource=docker depName=hif1/heisenbridge
matrix_bridge_heisenbridge_version: 1.15.4
matrix_bridge_heisenbridge_container_image: "{{ matrix_bridge_heisenbridge_container_image_registry_prefix }}hif1/heisenbridge:{{ matrix_bridge_heisenbridge_version }}"
matrix_bridge_heisenbridge_container_image_registry_prefix: "{{ matrix_bridge_heisenbridge_container_image_registry_prefix_upstream }}"
matrix_bridge_heisenbridge_container_image_registry_prefix_upstream: "{{ matrix_bridge_heisenbridge_container_image_registry_prefix_upstream_default }}"
matrix_bridge_heisenbridge_container_image_registry_prefix_upstream_default: "docker.io/"

# Set this to your Matrix ID if you want to enforce the owner, otherwise first _local_ user becomes one
matrix_bridge_heisenbridge_owner: ""

# Enabling identd will bind to host port 113/TCP
matrix_bridge_heisenbridge_identd_enabled: false

matrix_bridge_heisenbridge_base_path: "{{ matrix_base_data_path }}/heisenbridge"

matrix_bridge_heisenbridge_container_network: ""

matrix_bridge_heisenbridge_container_additional_networks: "{{ matrix_bridge_heisenbridge_container_additional_networks_auto + matrix_bridge_heisenbridge_container_additional_networks_custom }}"
matrix_bridge_heisenbridge_container_additional_networks_auto: []
matrix_bridge_heisenbridge_container_additional_networks_custom: []

# Controls how long to wait for the container to stop gracefully before killing it.
# We use a small value here, because this container does not seem to handle the SIGTERM signal.
matrix_bridge_heisenbridge_container_stop_grace_time_seconds: 1

# matrix_bridge_heisenbridge_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_heisenbridge_container_labels_additional_labels`.
matrix_bridge_heisenbridge_container_labels_traefik_enabled: true
matrix_bridge_heisenbridge_container_labels_traefik_docker_network: "{{ matrix_bridge_heisenbridge_container_network }}"
matrix_bridge_heisenbridge_container_labels_traefik_hostname: "{{ matrix_bridge_heisenbridge_hostname }}"
matrix_bridge_heisenbridge_container_labels_traefik_path_prefix: "{{ matrix_bridge_heisenbridge_path_prefix }}"
matrix_bridge_heisenbridge_container_labels_traefik_entrypoints: web-secure
matrix_bridge_heisenbridge_container_labels_traefik_tls_certResolver: default  # noqa var-naming

# Controls if the media router is enabled
matrix_bridge_heisenbridge_container_labels_traefik_media_enabled: true
matrix_bridge_heisenbridge_container_labels_traefik_media_hostname: "{{ matrix_bridge_heisenbridge_container_labels_traefik_hostname }}"
# The path prefix must either be `/` or not end with a slash (e.g. `/heisenbridge`).
matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix: "{{ '' if matrix_bridge_heisenbridge_container_labels_traefik_path_prefix == '/' else (matrix_bridge_heisenbridge_container_labels_traefik_path_prefix) }}/_heisenbridge/media"
matrix_bridge_heisenbridge_container_labels_traefik_media_rule: "Host(`{{ matrix_bridge_heisenbridge_container_labels_traefik_media_hostname }}`){% if matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix != '/' %} && PathPrefix(`{{ matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix }}`){% endif %}"
matrix_bridge_heisenbridge_container_labels_traefik_media_priority: 0
matrix_bridge_heisenbridge_container_labels_traefik_media_entrypoints: "{{ matrix_bridge_heisenbridge_container_labels_traefik_entrypoints }}"
matrix_bridge_heisenbridge_container_labels_traefik_media_tls: "{{ matrix_bridge_heisenbridge_container_labels_traefik_media_entrypoints != 'web' }}"
matrix_bridge_heisenbridge_container_labels_traefik_media_tls_certResolver: "{{ matrix_bridge_heisenbridge_container_labels_traefik_tls_certResolver }}"  # noqa var-naming

# matrix_bridge_heisenbridge_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_heisenbridge_container_labels_additional_labels: |
#   my.label=1
#   another.label="here"
matrix_bridge_heisenbridge_container_labels_additional_labels: ''

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

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

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

# List of systemd services that service depends on.
matrix_bridge_heisenbridge_systemd_required_services_list: "{{ matrix_bridge_heisenbridge_systemd_required_services_list_default + matrix_bridge_heisenbridge_systemd_required_services_list_auto + matrix_bridge_heisenbridge_systemd_required_services_list_custom }}"
matrix_bridge_heisenbridge_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
matrix_bridge_heisenbridge_systemd_required_services_list_auto: []
matrix_bridge_heisenbridge_systemd_required_services_list_custom: []

# List of systemd services that service wants
matrix_bridge_heisenbridge_systemd_wanted_services_list: []

matrix_bridge_heisenbridge_homeserver_url: ""

matrix_bridge_heisenbridge_appservice_token: ''
matrix_bridge_heisenbridge_homeserver_token: ''

matrix_bridge_heisenbridge_config_media_url: "{{ matrix_bridge_heisenbridge_scheme }}://{{ matrix_bridge_heisenbridge_hostname }}"
# This matches the hardcoded `DEFAULT_MEDIA_PATH` in Heisenbridge, but uses `matrix_bridge_heisenbridge_path_prefix` as the path prefix.
# See: https://github.com/hifi/heisenbridge/blob/7e18a5818f4a8c86cc62e474eee1631d16cb2602/heisenbridge/__main__.py#L66
matrix_bridge_heisenbridge_config_media_path: "{{ matrix_bridge_heisenbridge_container_labels_traefik_media_path_prefix }}/{server}/{media_id}/{checksum}{filename}"
matrix_bridge_heisenbridge_config_media_key: "{{ matrix_bridge_heisenbridge_homeserver_token }}"
matrix_bridge_heisenbridge_config_displayname: "Heisenbridge"

matrix_bridge_heisenbridge_registration_yaml_heisenbridge:
  media_url: "{{ matrix_bridge_heisenbridge_config_media_url }}"
  media_path: "{{ matrix_bridge_heisenbridge_config_media_path }}"
  media_key: "{{ matrix_bridge_heisenbridge_config_media_key }}"
  displayname: "{{ matrix_bridge_heisenbridge_config_displayname }}"

# Default registration file consumed by both the homeserver and Heisenbridge.
# Besides registration information, it contains configuration (see the Heisenbridge key).
matrix_bridge_heisenbridge_registration_yaml:
  id: heisenbridge
  url: http://matrix-heisenbridge:9898
  as_token: "{{ matrix_bridge_heisenbridge_appservice_token }}"
  hs_token: "{{ matrix_bridge_heisenbridge_homeserver_token }}"
  rate_limited: false
  sender_localpart: heisenbridge
  namespaces:
    users:
      - regex: '@hbirc_.*'
        exclusive: true
    aliases: []
    rooms: []
  heisenbridge: "{{ matrix_bridge_heisenbridge_registration_yaml_heisenbridge }}"

matrix_bridge_heisenbridge_registration: "{{ matrix_bridge_heisenbridge_registration_yaml | from_yaml }}"

# matrix_bridge_heisenbridge_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_heisenbridge_restart_necessary: false