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

# SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---

# WeChat Bridge is a Matrix <-> WeChat bridge
# Project source code URL: https://github.com/duo/matrix-wechat

matrix_bridge_wechat_enabled: true

# renovate: datasource=docker depName=lxduo/matrix-wechat
matrix_bridge_wechat_version: 0.2.4
matrix_bridge_wechat_container_image: "{{ matrix_bridge_wechat_container_image_registry_prefix }}lxduo/matrix-wechat:{{ matrix_bridge_wechat_version }}"
matrix_bridge_wechat_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_wechat_container_image_self_build else matrix_bridge_wechat_container_image_registry_prefix_upstream }}"
matrix_bridge_wechat_container_image_registry_prefix_upstream: "{{ matrix_bridge_wechat_container_image_registry_prefix_upstream_default }}"
matrix_bridge_wechat_container_image_registry_prefix_upstream_default: "docker.io/"

matrix_bridge_wechat_container_image_self_build: false
matrix_bridge_wechat_container_image_self_build_repo: "https://github.com/duo/matrix-wechat.git"
matrix_bridge_wechat_container_image_self_build_branch: "{{ 'master' if matrix_bridge_wechat_version == 'latest' else matrix_bridge_wechat_version }}"

# renovate: datasource=docker depName=lxduo/matrix-wechat-agent
matrix_bridge_wechat_agent_version: 0.0.1
matrix_bridge_wechat_agent_container_image: "{{ matrix_bridge_wechat_agent_container_image_registry_prefix }}lxduo/matrix-wechat-agent:{{ matrix_bridge_wechat_agent_version }}"
matrix_bridge_wechat_agent_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_wechat_agent_container_image_self_build else matrix_bridge_wechat_agent_container_image_registry_prefix_upstream }}"
matrix_bridge_wechat_agent_container_image_registry_prefix_upstream: "{{ matrix_bridge_wechat_agent_container_image_registry_prefix_upstream_default }}"
matrix_bridge_wechat_agent_container_image_registry_prefix_upstream_default: "docker.io/"

# The agent needs to write to /home/user/.vnc.
# `/home/user` is owned by `user:group` (`1000:1000`), so it needs to run with that user/group.
matrix_bridge_wechat_agent_container_user_uid: 1000
matrix_bridge_wechat_agent_container_user_gid: 1000

matrix_bridge_wechat_agent_container_image_self_build: false
matrix_bridge_wechat_agent_container_image_self_build_repo: "https://github.com/duo/matrix-wechat-agent.git"
matrix_bridge_wechat_agent_container_image_self_build_branch: "{{ 'master' if matrix_bridge_wechat_agent_version == 'latest' else matrix_bridge_wechat_agent_version }}"

matrix_bridge_wechat_base_path: "{{ matrix_base_data_path }}/wechat"
matrix_bridge_wechat_config_path: "{{ matrix_bridge_wechat_base_path }}/config"
matrix_bridge_wechat_data_path: "{{ matrix_bridge_wechat_base_path }}/data"
matrix_bridge_wechat_container_src_files_path: "{{ matrix_bridge_wechat_base_path }}/container-src"
matrix_bridge_wechat_agent_container_src_files_path: "{{ matrix_bridge_wechat_base_path }}/agent-container-src"

matrix_bridge_wechat_homeserver_address: ""
matrix_bridge_wechat_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_bridge_wechat_homeserver_async_media: false
matrix_bridge_wechat_appservice_address: 'http://matrix-wechat:8080'

matrix_bridge_wechat_container_network: ""

matrix_bridge_wechat_container_additional_networks: "{{ matrix_bridge_wechat_container_additional_networks_auto + matrix_bridge_wechat_container_additional_networks_custom }}"
matrix_bridge_wechat_container_additional_networks_auto: []
matrix_bridge_wechat_container_additional_networks_custom: []

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

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

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

# List of systemd services that matrix-wechat.service depends on.
matrix_bridge_wechat_systemd_required_services_list: "{{ matrix_bridge_wechat_systemd_required_services_list_default + matrix_bridge_wechat_systemd_required_services_list_auto + matrix_bridge_wechat_systemd_required_services_list_custom }}"
matrix_bridge_wechat_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
matrix_bridge_wechat_systemd_required_services_list_auto: []
matrix_bridge_wechat_systemd_required_services_list_custom: []

# List of systemd services that matrix-wechat.service wants
matrix_bridge_wechat_systemd_wanted_services_list: []

matrix_bridge_wechat_appservice_token: ''
matrix_bridge_wechat_homeserver_token: ''

matrix_bridge_wechat_appservice_bot_username: wechatbot

matrix_bridge_wechat_command_prefix: "!wechat"

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

# Database-related configuration fields.
matrix_bridge_wechat_database_engine: 'postgres'
matrix_bridge_wechat_database_username: 'matrix_wechat'
matrix_bridge_wechat_database_password: 'some-password'
matrix_bridge_wechat_database_hostname: ''
matrix_bridge_wechat_database_port: 5432
matrix_bridge_wechat_database_name: 'matrix_wechat'
matrix_bridge_wechat_database_sslmode: disable
matrix_bridge_wechat_database_connection_string: 'postgresql://{{ matrix_bridge_wechat_database_username }}:{{ matrix_bridge_wechat_database_password }}@{{ matrix_bridge_wechat_database_hostname }}:{{ matrix_bridge_wechat_database_port }}/{{ matrix_bridge_wechat_database_name }}?sslmode={{ matrix_bridge_wechat_database_sslmode }}'

matrix_bridge_wechat_bridge_listen_secret: ''

# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
matrix_bridge_wechat_login_shared_secret: ''
matrix_bridge_wechat_login_shared_secret_map:
  "{{ {matrix_bridge_wechat_homeserver_domain: matrix_bridge_wechat_login_shared_secret} if matrix_bridge_wechat_login_shared_secret else {} }}"

# Servers to always allow double puppeting from
matrix_bridge_wechat_double_puppet_server_map:
  "{{ matrix_bridge_wechat_homeserver_domain: matrix_bridge_wechat_homeserver_address }}"

# Enable End-to-bridge encryption
matrix_bridge_wechat_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
matrix_bridge_wechat_encryption_default: "{{ matrix_bridge_wechat_encryption_allow }}"

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

matrix_bridge_wechat_permissions: |
  {{
    {matrix_bridge_wechat_homeserver_domain: 'user'}
    | combine({matrix_admin: 'admin'} if matrix_admin else {})
  }}

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

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

matrix_bridge_wechat_configuration_extension: "{{ matrix_bridge_wechat_configuration_extension_yaml | from_yaml if matrix_bridge_wechat_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_wechat_configuration_yaml`.
matrix_bridge_wechat_configuration: "{{ matrix_bridge_wechat_configuration_yaml | from_yaml | combine(matrix_bridge_wechat_configuration_extension, recursive=True) }}"

matrix_bridge_wechat_registration_yaml: |
  id: wechat
  url: {{ matrix_bridge_wechat_appservice_address }}
  as_token: "{{ matrix_bridge_wechat_appservice_token }}"
  hs_token: "{{ matrix_bridge_wechat_homeserver_token }}"
  # See https://github.com/mautrix/signal/issues/43
  sender_localpart: _bot_{{ matrix_bridge_wechat_appservice_bot_username }}
  rate_limited: false
  namespaces:
      users:
      - regex: '^@_wechat_(.*):{{ matrix_bridge_wechat_homeserver_domain | regex_escape }}$'
        exclusive: true
      - exclusive: true
        regex: '^@{{ matrix_bridge_wechat_appservice_bot_username | regex_escape }}:{{ matrix_bridge_wechat_homeserver_domain | regex_escape }}$'
  de.sorunome.msc2409.push_ephemeral: true
  receive_ephemeral: true

matrix_bridge_wechat_registration: "{{ matrix_bridge_wechat_registration_yaml | from_yaml }}"


matrix_bridge_wechat_agent_service_secret: "{{ matrix_bridge_wechat_bridge_listen_secret }}"

matrix_bridge_wechat_agent_configuration_yaml: "{{ lookup('template', 'templates/agent-config.yaml.j2') }}"

matrix_bridge_wechat_agent_configuration: "{{ matrix_bridge_wechat_agent_configuration_yaml | from_yaml }}"

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

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

# matrix_bridge_wechat_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_wechat_restart_necessary: false