98e4f369b7
Ref: -33f3ccd6ae/CHANGELOG.md (L134-L136)-7165d3fa58/appservice/registration.go (L30)Intentionally not removing the old configuration setting yet, as some bridges may/do not support the new setting name. It's likely just bridgev2 mautrix bridges that have been updated and support both right now.
238 lines
13 KiB
YAML
238 lines
13 KiB
YAML
# SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2019 Julian Foad
|
|
# SPDX-FileCopyrightText: 2019 Thomas Kuehne
|
|
# SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2021 Sebastian Gumprich
|
|
# SPDX-FileCopyrightText: 2022 - 2024 Nikita Chernyi
|
|
# SPDX-FileCopyrightText: 2022 Arthur Brugière
|
|
# SPDX-FileCopyrightText: 2022 László Várady
|
|
# SPDX-FileCopyrightText: 2022 Marko Weltzer
|
|
# SPDX-FileCopyrightText: 2022 Petteri Pucilowski
|
|
# SPDX-FileCopyrightText: 2023 Adrien le Maire
|
|
# SPDX-FileCopyrightText: 2023 James Collier
|
|
# SPDX-FileCopyrightText: 2023 Samuel Meenzen
|
|
# SPDX-FileCopyrightText: 2023 Shreyas Ajjarapu
|
|
# SPDX-FileCopyrightText: 2024 Nikolai Raitsev
|
|
# SPDX-FileCopyrightText: 2025 Suguru Hirahara
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
# mautrix-whatsapp is a Matrix <-> Whatsapp bridge
|
|
# Project source code URL: https://github.com/mautrix/whatsapp
|
|
|
|
matrix_mautrix_whatsapp_enabled: true
|
|
|
|
matrix_mautrix_whatsapp_container_image_self_build: false
|
|
matrix_mautrix_whatsapp_container_image_self_build_repo: "https://mau.dev/mautrix/whatsapp.git"
|
|
matrix_mautrix_whatsapp_container_image_self_build_branch: "{{ 'master' if matrix_mautrix_whatsapp_version == 'latest' else matrix_mautrix_whatsapp_version }}"
|
|
|
|
# renovate: datasource=docker depName=dock.mau.dev/mautrix/whatsapp
|
|
matrix_mautrix_whatsapp_version: v0.12.0
|
|
|
|
# See: https://mau.dev/mautrix/whatsapp/container_registry
|
|
matrix_mautrix_whatsapp_docker_image: "{{ matrix_mautrix_whatsapp_docker_image_registry_prefix }}mautrix/whatsapp:{{ matrix_mautrix_whatsapp_version }}"
|
|
matrix_mautrix_whatsapp_docker_image_registry_prefix: "{{ 'localhost/' if matrix_mautrix_whatsapp_container_image_self_build else matrix_mautrix_whatsapp_docker_image_registry_prefix_upstream }}"
|
|
matrix_mautrix_whatsapp_docker_image_registry_prefix_upstream: "{{ matrix_mautrix_whatsapp_docker_image_registry_prefix_upstream_default }}"
|
|
matrix_mautrix_whatsapp_docker_image_registry_prefix_upstream_default: "dock.mau.dev/"
|
|
matrix_mautrix_whatsapp_docker_image_force_pull: "{{ matrix_mautrix_whatsapp_docker_image.endswith(':latest') }}"
|
|
|
|
matrix_mautrix_whatsapp_base_path: "{{ matrix_base_data_path }}/mautrix-whatsapp"
|
|
matrix_mautrix_whatsapp_config_path: "{{ matrix_mautrix_whatsapp_base_path }}/config"
|
|
matrix_mautrix_whatsapp_data_path: "{{ matrix_mautrix_whatsapp_base_path }}/data"
|
|
matrix_mautrix_whatsapp_docker_src_files_path: "{{ matrix_mautrix_whatsapp_base_path }}/docker-src"
|
|
|
|
matrix_mautrix_whatsapp_homeserver_address: ""
|
|
matrix_mautrix_whatsapp_homeserver_domain: "{{ matrix_domain }}"
|
|
matrix_mautrix_whatsapp_appservice_address: "http://matrix-mautrix-whatsapp:8080"
|
|
|
|
matrix_mautrix_whatsapp_msc4190_enabled: "{{ matrix_bridges_msc4190_enabled }}"
|
|
|
|
matrix_mautrix_whatsapp_extev_polls: false
|
|
|
|
matrix_mautrix_whatsapp_command_prefix: "!wa"
|
|
|
|
matrix_mautrix_whatsapp_container_network: ""
|
|
|
|
matrix_mautrix_whatsapp_container_additional_networks: "{{ matrix_mautrix_whatsapp_container_additional_networks_auto + matrix_mautrix_whatsapp_container_additional_networks_custom }}"
|
|
matrix_mautrix_whatsapp_container_additional_networks_auto: []
|
|
matrix_mautrix_whatsapp_container_additional_networks_custom: []
|
|
|
|
# matrix_mautrix_whatsapp_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_mautrix_whatsapp_container_labels_additional_labels`.
|
|
matrix_mautrix_whatsapp_container_labels_traefik_enabled: true
|
|
matrix_mautrix_whatsapp_container_labels_traefik_docker_network: "{{ matrix_mautrix_whatsapp_container_network }}"
|
|
matrix_mautrix_whatsapp_container_labels_traefik_entrypoints: web-secure
|
|
matrix_mautrix_whatsapp_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
# Controls whether labels will be added that expose mautrix-whatsapp's metrics
|
|
matrix_mautrix_whatsapp_container_labels_metrics_enabled: "{{ matrix_mautrix_whatsapp_metrics_enabled and matrix_mautrix_whatsapp_metrics_proxying_enabled }}"
|
|
matrix_mautrix_whatsapp_container_labels_metrics_traefik_rule: "Host(`{{ matrix_mautrix_whatsapp_metrics_proxying_hostname }}`) && PathPrefix(`{{ matrix_mautrix_whatsapp_metrics_proxying_path_prefix }}`)"
|
|
matrix_mautrix_whatsapp_container_labels_metrics_traefik_priority: 0
|
|
matrix_mautrix_whatsapp_container_labels_metrics_traefik_entrypoints: "{{ matrix_mautrix_whatsapp_container_labels_traefik_entrypoints }}"
|
|
matrix_mautrix_whatsapp_container_labels_metrics_traefik_tls: "{{ matrix_mautrix_whatsapp_container_labels_metrics_traefik_entrypoints != 'web' }}"
|
|
matrix_mautrix_whatsapp_container_labels_metrics_traefik_tls_certResolver: "{{ matrix_mautrix_whatsapp_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
matrix_mautrix_whatsapp_container_labels_metrics_middleware_basic_auth_enabled: false
|
|
# See: https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
|
|
matrix_mautrix_whatsapp_container_labels_metrics_middleware_basic_auth_users: ''
|
|
|
|
# matrix_mautrix_whatsapp_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_mautrix_whatsapp_container_labels_additional_labels: |
|
|
# my.label=1
|
|
# another.label="here"
|
|
matrix_mautrix_whatsapp_container_labels_additional_labels: ''
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_mautrix_whatsapp_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-mautrix-whatsapp.service depends on.
|
|
matrix_mautrix_whatsapp_systemd_required_services_list: "{{ matrix_mautrix_whatsapp_systemd_required_services_list_default + matrix_mautrix_whatsapp_systemd_required_services_list_auto + matrix_mautrix_whatsapp_systemd_required_services_list_custom }}"
|
|
matrix_mautrix_whatsapp_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
|
matrix_mautrix_whatsapp_systemd_required_services_list_auto: []
|
|
matrix_mautrix_whatsapp_systemd_required_services_list_custom: []
|
|
|
|
# List of systemd services that matrix-mautrix-whatsapp.service wants
|
|
matrix_mautrix_whatsapp_systemd_wanted_services_list: []
|
|
|
|
matrix_mautrix_whatsapp_appservice_token: ''
|
|
matrix_mautrix_whatsapp_homeserver_token: ''
|
|
|
|
matrix_mautrix_whatsapp_appservice_bot_username: whatsappbot
|
|
|
|
# Minimum severity of journal log messages.
|
|
# Valid values: fatal, error, warn, info, debug, trace
|
|
matrix_mautrix_whatsapp_logging_level: 'warn'
|
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
# If false, created portal rooms will never be federated.
|
|
matrix_mautrix_whatsapp_federate_rooms: true
|
|
|
|
# Whether or not metrics endpoint should be enabled.
|
|
# Enabling them is usually enough for a local (in-container) Prometheus to consume them.
|
|
# If metrics need to be consumed by another (external) Prometheus server, consider exposing them via `matrix_mautrix_whatsapp_metrics_proxying_enabled`.
|
|
matrix_mautrix_whatsapp_metrics_enabled: false
|
|
|
|
# Controls whether metrics should be proxied (exposed) on a public URL
|
|
matrix_mautrix_whatsapp_metrics_proxying_enabled: false
|
|
matrix_mautrix_whatsapp_metrics_proxying_hostname: ''
|
|
matrix_mautrix_whatsapp_metrics_proxying_path_prefix: ''
|
|
|
|
# Database-related configuration fields.
|
|
#
|
|
# To use SQLite, stick to these defaults.
|
|
#
|
|
# To use Postgres:
|
|
# - change the engine (`matrix_mautrix_whatsapp_database_engine: 'postgres'`)
|
|
# - adjust your database credentials via the `matrix_mautrix_whatsapp_database_*` variables
|
|
matrix_mautrix_whatsapp_database_engine: 'sqlite'
|
|
|
|
matrix_mautrix_whatsapp_sqlite_database_path_local: "{{ matrix_mautrix_whatsapp_data_path }}/mautrix-whatsapp.db"
|
|
matrix_mautrix_whatsapp_sqlite_database_path_in_container: "/data/mautrix-whatsapp.db"
|
|
|
|
matrix_mautrix_whatsapp_database_username: 'matrix_mautrix_whatsapp'
|
|
matrix_mautrix_whatsapp_database_password: 'some-password'
|
|
matrix_mautrix_whatsapp_database_hostname: ''
|
|
matrix_mautrix_whatsapp_database_port: 5432
|
|
matrix_mautrix_whatsapp_database_name: 'matrix_mautrix_whatsapp'
|
|
matrix_mautrix_whatsapp_database_sslmode: disable
|
|
|
|
matrix_mautrix_whatsapp_database_connection_string: 'postgresql://{{ matrix_mautrix_whatsapp_database_username }}:{{ matrix_mautrix_whatsapp_database_password }}@{{ matrix_mautrix_whatsapp_database_hostname }}:{{ matrix_mautrix_whatsapp_database_port }}/{{ matrix_mautrix_whatsapp_database_name }}?sslmode={{ matrix_mautrix_whatsapp_database_sslmode }}'
|
|
|
|
matrix_mautrix_whatsapp_appservice_database_type: "{{
|
|
{
|
|
'sqlite': 'sqlite3-fk-wal',
|
|
'postgres':'postgres',
|
|
}[matrix_mautrix_whatsapp_database_engine]
|
|
}}"
|
|
|
|
matrix_mautrix_whatsapp_appservice_database_uri: "{{
|
|
{
|
|
'sqlite': matrix_mautrix_whatsapp_sqlite_database_path_in_container,
|
|
'postgres': matrix_mautrix_whatsapp_database_connection_string,
|
|
}[matrix_mautrix_whatsapp_database_engine]
|
|
}}"
|
|
|
|
matrix_mautrix_whatsapp_double_puppet_secrets: "{{ matrix_mautrix_whatsapp_double_puppet_secrets_auto | combine(matrix_mautrix_whatsapp_double_puppet_secrets_custom) }}"
|
|
matrix_mautrix_whatsapp_double_puppet_secrets_auto: {}
|
|
matrix_mautrix_whatsapp_double_puppet_secrets_custom: {}
|
|
|
|
# Enable End-to-bridge encryption
|
|
matrix_mautrix_whatsapp_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
|
|
matrix_mautrix_whatsapp_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
|
|
matrix_mautrix_whatsapp_bridge_encryption_require: false
|
|
matrix_mautrix_whatsapp_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_whatsapp_bridge_encryption_allow }}"
|
|
# This pickle key value is backward-compatible with the old bridge.
|
|
# See: https://github.com/mautrix/whatsapp/blob/v0.11.0/cmd/mautrix-whatsapp/legacymigrate.go#L44
|
|
matrix_mautrix_whatsapp_bridge_encryption_pickle_key: maunium.net/go/mautrix-whatsapp
|
|
|
|
matrix_mautrix_whatsapp_bridge_personal_filtering_spaces: true
|
|
matrix_mautrix_whatsapp_bridge_enable_status_broadcast: true
|
|
|
|
matrix_mautrix_whatsapp_provisioning_shared_secret: ''
|
|
matrix_mautrix_whatsapp_public_media_signing_key: ''
|
|
|
|
matrix_mautrix_whatsapp_bridge_permissions: |
|
|
{{
|
|
{'*': 'relay', matrix_mautrix_whatsapp_homeserver_domain: 'user'}
|
|
| combine({matrix_admin: 'admin'} if matrix_admin else {})
|
|
}}
|
|
|
|
# Enable bridge relay functionality
|
|
matrix_mautrix_whatsapp_bridge_relay_enabled: "{{ matrix_bridges_relay_enabled }}"
|
|
|
|
# Only allow admins on this home server to set themselves as a relay user
|
|
matrix_mautrix_whatsapp_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_whatsapp_bridge_relay_default_relays: []
|
|
|
|
# Controls whether to do backfilling at all.
|
|
matrix_mautrix_whatsapp_backfill_enabled: true
|
|
|
|
# Default mautrix-whatsapp 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_whatsapp_configuration_extension_yaml`)
|
|
# or completely replace this variable with your own template.
|
|
matrix_mautrix_whatsapp_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_mautrix_whatsapp_configuration_extension_yaml: |
|
|
# Your custom YAML configuration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_mautrix_whatsapp_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_whatsapp_configuration_yaml`.
|
|
|
|
matrix_mautrix_whatsapp_configuration_extension: "{{ matrix_mautrix_whatsapp_configuration_extension_yaml | from_yaml if matrix_mautrix_whatsapp_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_whatsapp_configuration_yaml`.
|
|
matrix_mautrix_whatsapp_configuration: "{{ matrix_mautrix_whatsapp_configuration_yaml | from_yaml | combine(matrix_mautrix_whatsapp_configuration_extension, recursive=True) }}"
|
|
|
|
matrix_mautrix_whatsapp_registration_yaml: |
|
|
id: whatsapp
|
|
url: {{ matrix_mautrix_whatsapp_appservice_address }}
|
|
as_token: "{{ matrix_mautrix_whatsapp_appservice_token }}"
|
|
hs_token: "{{ matrix_mautrix_whatsapp_homeserver_token }}"
|
|
# See https://github.com/mautrix/signal/issues/43
|
|
sender_localpart: _bot_{{ matrix_mautrix_whatsapp_appservice_bot_username }}
|
|
rate_limited: false
|
|
namespaces:
|
|
users:
|
|
- regex: '^@whatsapp_.*:{{ matrix_mautrix_whatsapp_homeserver_domain | regex_escape }}$'
|
|
exclusive: true
|
|
- exclusive: true
|
|
regex: '^@{{ matrix_mautrix_whatsapp_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_whatsapp_homeserver_domain | regex_escape }}$'
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
receive_ephemeral: true
|
|
io.element.msc4190: {{ matrix_mautrix_whatsapp_msc4190_enabled | to_json }}
|
|
|
|
matrix_mautrix_whatsapp_registration: "{{ matrix_mautrix_whatsapp_registration_yaml | from_yaml }}"
|