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

# SPDX-FileCopyrightText: 2023 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2023 Cody Wyatt Neiman
# SPDX-FileCopyrightText: 2023 Nikita Chernyi
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
# SPDX-FileCopyrightText: 2024 MDAD project contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later

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

matrix_mautrix_slack_enabled: true

matrix_mautrix_slack_container_image_self_build: false
matrix_mautrix_slack_container_image_self_build_repo: "https://mau.dev/mautrix/slack.git"
matrix_mautrix_slack_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_slack_version == 'latest' else matrix_mautrix_slack_version }}"

# renovate: datasource=docker depName=dock.mau.dev/mautrix/slack
matrix_mautrix_slack_version: v0.2602.0
# See: https://mau.dev/mautrix/slack/container_registry
matrix_mautrix_slack_docker_image: "{{ matrix_mautrix_slack_docker_image_registry_prefix }}mautrix/slack:{{ matrix_mautrix_slack_version }}"
matrix_mautrix_slack_docker_image_registry_prefix: "{{ 'localhost/' if matrix_mautrix_slack_container_image_self_build else matrix_mautrix_slack_docker_image_registry_prefix_upstream }}"
matrix_mautrix_slack_docker_image_registry_prefix_upstream: "{{ matrix_mautrix_slack_docker_image_registry_prefix_upstream_default }}"
matrix_mautrix_slack_docker_image_registry_prefix_upstream_default: "dock.mau.dev/"
matrix_mautrix_slack_docker_image_force_pull: "{{ matrix_mautrix_slack_docker_image.endswith(':latest') }}"

matrix_mautrix_slack_base_path: "{{ matrix_base_data_path }}/mautrix-slack"
matrix_mautrix_slack_config_path: "{{ matrix_mautrix_slack_base_path }}/config"
matrix_mautrix_slack_data_path: "{{ matrix_mautrix_slack_base_path }}/data"
matrix_mautrix_slack_docker_src_files_path: "{{ matrix_mautrix_slack_base_path }}/docker-src"

matrix_mautrix_slack_homeserver_address: ""
matrix_mautrix_slack_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_mautrix_slack_homeserver_async_media: false
matrix_mautrix_slack_appservice_address: "http://matrix-mautrix-slack:8080"

matrix_mautrix_slack_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
matrix_mautrix_slack_self_sign_enabled: "{{ matrix_bridges_self_sign_enabled }}"

# Displayname template for Slack users. Available variables:
#  .Name - The username of the user
#  .Team.Name - The name of the team the channel is in
#  .Team.Domain - The Slack subdomain of the team the channel is in
#  .ID - The internal ID of the user
#  .IsBot - Whether the user is a bot
#  .Profile.DisplayName - The username or real name of the user (depending on settings)
# Variables only available for users (not bots):
#  .TeamID - The internal ID of the workspace the user is in
#  .TZ - The timezone region of the user (e.g. Europe/London)
#  .TZLabel - The label of the timezone of the user (e.g. Greenwich Mean Time)
#  .TZOffset - The UTC offset of the timezone of the user (e.g. 0)
#  .Profile.RealName - The real name of the user
#  .Profile.FirstName - The first name of the user
#  .Profile.LastName - The last name of the user
#  .Profile.Title - The job title of the user
#  .Profile.Pronouns - The pronouns of the user
#  .Profile.Email - The email address of the user
#  .Profile.Phone - The formatted phone number of the user
matrix_mautrix_slack_network_displayname_template: '{% raw %}{{or .Profile.DisplayName .Profile.RealName .Name}}{{if .IsBot}} (bot){{end}}{% endraw %}'

matrix_mautrix_slack_command_prefix: "!slack"

matrix_mautrix_slack_bridge_permissions: |
  {{
    {'*': 'relay', matrix_mautrix_slack_homeserver_domain: 'user'}
    | combine({matrix_admin: 'admin'} if matrix_admin else {})
  }}

matrix_mautrix_slack_container_network: ""

matrix_mautrix_slack_container_additional_networks: "{{ matrix_mautrix_slack_container_additional_networks_auto + matrix_mautrix_slack_container_additional_networks_custom }}"
matrix_mautrix_slack_container_additional_networks_auto: []
matrix_mautrix_slack_container_additional_networks_custom: []

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

# List of systemd services that matrix-mautrix-slack.service depends on.
matrix_mautrix_slack_systemd_required_services_list: "{{ matrix_mautrix_slack_systemd_required_services_list_default + matrix_mautrix_slack_systemd_required_services_list_auto + matrix_mautrix_slack_systemd_required_services_list_custom }}"
matrix_mautrix_slack_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
matrix_mautrix_slack_systemd_required_services_list_auto: []
matrix_mautrix_slack_systemd_required_services_list_custom: []

# List of systemd services that matrix-mautrix-slack.service wants
matrix_mautrix_slack_systemd_wanted_services_list: []

matrix_mautrix_slack_appservice_token: ''
matrix_mautrix_slack_homeserver_token: ''

matrix_mautrix_slack_appservice_bot_username: slackbot

matrix_mautrix_slack_backfill_enabled: true
matrix_mautrix_slack_backfill_max_initial_messages: 50
matrix_mautrix_slack_backfill_max_catchup_messages: 500
matrix_mautrix_slack_backfill_unread_hours_threshold: 720
matrix_mautrix_slack_backfill_threads_max_initial_messages: 50

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

# Database-related configuration fields.
#
# To use SQLite, stick to these defaults.
#
# To use Postgres:
# - change the engine (`matrix_mautrix_slack_database_engine: 'postgres'`)
# - adjust your database credentials via the `matrix_mautrix_slack_database_*` variables
matrix_mautrix_slack_database_engine: 'sqlite'

matrix_mautrix_slack_sqlite_database_path_local: "{{ matrix_mautrix_slack_data_path }}/mautrix-slack.db"
matrix_mautrix_slack_sqlite_database_path_in_container: "/data/mautrix-slack.db"

matrix_mautrix_slack_database_username: 'matrix_mautrix_slack'
matrix_mautrix_slack_database_password: 'some-password'
matrix_mautrix_slack_database_hostname: ''
matrix_mautrix_slack_database_port: 5432
matrix_mautrix_slack_database_name: 'matrix_mautrix_slack'
matrix_mautrix_slack_database_sslmode: disable

matrix_mautrix_slack_database_connection_string: 'postgresql://{{ matrix_mautrix_slack_database_username }}:{{ matrix_mautrix_slack_database_password }}@{{ matrix_mautrix_slack_database_hostname }}:{{ matrix_mautrix_slack_database_port }}/{{ matrix_mautrix_slack_database_name }}?sslmode={{ matrix_mautrix_slack_database_sslmode }}'

matrix_mautrix_slack_appservice_database_type: "{{
	{
		'sqlite': 'sqlite3',
		'postgres':'postgres',
	}[matrix_mautrix_slack_database_engine]
}}"

matrix_mautrix_slack_appservice_database_uri: "{{
	{
		'sqlite': matrix_mautrix_slack_sqlite_database_path_in_container,
		'postgres': matrix_mautrix_slack_database_connection_string,
	}[matrix_mautrix_slack_database_engine]
}}"

matrix_mautrix_slack_double_puppet_secrets: "{{ matrix_mautrix_slack_double_puppet_secrets_auto | combine(matrix_mautrix_slack_double_puppet_secrets_custom) }}"
matrix_mautrix_slack_double_puppet_secrets_auto: {}
matrix_mautrix_slack_double_puppet_secrets_custom: {}

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

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

matrix_mautrix_slack_configuration_extension: "{{ matrix_mautrix_slack_configuration_extension_yaml | from_yaml if matrix_mautrix_slack_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_slack_configuration_yaml`.
matrix_mautrix_slack_configuration: "{{ matrix_mautrix_slack_configuration_yaml | from_yaml | combine(matrix_mautrix_slack_configuration_extension, recursive=True) }}"

matrix_mautrix_slack_registration_yaml: |
  id: slack
  url: {{ matrix_mautrix_slack_appservice_address | to_json }}
  as_token: {{ matrix_mautrix_slack_appservice_token | to_json }}
  hs_token: {{ matrix_mautrix_slack_homeserver_token | to_json }}
  # See https://github.com/mautrix/signal/issues/43
  sender_localpart: _bot_{{ matrix_mautrix_slack_appservice_bot_username }}
  rate_limited: false
  namespaces:
      users:
      - regex: '^@slack_[a-z-A-Z0-9\-]+:{{ matrix_mautrix_slack_homeserver_domain | regex_escape }}$'
        exclusive: true
      - exclusive: true
        regex: '^@{{ matrix_mautrix_slack_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_slack_homeserver_domain | regex_escape }}$'
  de.sorunome.msc2409.push_ephemeral: true
  receive_ephemeral: true
  io.element.msc4190: {{ matrix_mautrix_slack_msc4190_enabled | to_json }}

matrix_mautrix_slack_registration: "{{ matrix_mautrix_slack_registration_yaml | from_yaml }}"

# Enable End-to-bridge encryption
matrix_mautrix_slack_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
matrix_mautrix_slack_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
matrix_mautrix_slack_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_slack_bridge_encryption_allow }}"
# This pickle key value is backward-compatible with the old bridge.
# See: https://github.com/mautrix/slack/releases/tag/v0.1.0
matrix_mautrix_slack_bridge_encryption_pickle_key: maunium.net/go/mautrix-whatsapp

matrix_mautrix_slack_provisioning_shared_secret: ''
matrix_mautrix_slack_public_media_signing_key: ''

# Controls whether relay mode is enabled
matrix_mautrix_slack_bridge_relay_enabled: "{{ matrix_bridges_relay_enabled }}"

# Controls whether only admins can set themselves as relay users
matrix_mautrix_slack_bridge_relay_admin_only: true

# List of user login IDs which anyone can set as a relay, as long as the relay user is in the room
matrix_mautrix_slack_bridge_relay_default_relays: []

# matrix_mautrix_slack_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_mautrix_slack_restart_necessary: false