2022-02-05 20:32:54 +00:00
---
2019-05-14 14:47:22 +00:00
# mautrix-whatsapp is a Matrix <-> Whatsapp bridge
2022-07-16 20:59:21 +00:00
# Project source code URL: https://github.com/mautrix/whatsapp
2019-05-14 14:47:22 +00:00
matrix_mautrix_whatsapp_enabled : true
2021-10-12 07:02:07 +00:00
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 }}"
2023-10-06 12:14:03 +00:00
# renovate: datasource=docker depName=dock.mau.dev/mautrix/whatsapp
2024-11-16 19:08:04 +00:00
matrix_mautrix_whatsapp_version : v0.11.1
2023-10-16 15:15:53 +00:00
2021-08-18 15:21:20 +00:00
# See: https://mau.dev/mautrix/whatsapp/container_registry
2021-10-12 07:02:07 +00:00
matrix_mautrix_whatsapp_docker_image : "{{ matrix_mautrix_whatsapp_docker_image_name_prefix }}mautrix/whatsapp:{{ matrix_mautrix_whatsapp_version }}"
matrix_mautrix_whatsapp_docker_image_name_prefix : "{{ 'localhost/' if matrix_mautrix_whatsapp_container_image_self_build else 'dock.mau.dev/' }}"
2019-06-10 11:23:51 +00:00
matrix_mautrix_whatsapp_docker_image_force_pull : "{{ matrix_mautrix_whatsapp_docker_image.endswith(':latest') }}"
2019-05-14 14:47:22 +00:00
matrix_mautrix_whatsapp_base_path : "{{ matrix_base_data_path }}/mautrix-whatsapp"
2019-06-23 22:16:04 +00:00
matrix_mautrix_whatsapp_config_path : "{{ matrix_mautrix_whatsapp_base_path }}/config"
matrix_mautrix_whatsapp_data_path : "{{ matrix_mautrix_whatsapp_base_path }}/data"
2021-10-12 07:02:07 +00:00
matrix_mautrix_whatsapp_docker_src_files_path : "{{ matrix_mautrix_whatsapp_base_path }}/docker-src"
2019-05-14 14:47:22 +00:00
2024-01-07 15:04:23 +00:00
matrix_mautrix_whatsapp_homeserver_address : ""
2019-05-14 14:47:22 +00:00
matrix_mautrix_whatsapp_homeserver_domain : "{{ matrix_domain }}"
matrix_mautrix_whatsapp_appservice_address : "http://matrix-mautrix-whatsapp:8080"
2024-02-09 13:17:16 +00:00
matrix_mautrix_whatsapp_extev_polls : false
2022-07-04 20:53:43 +00:00
matrix_mautrix_whatsapp_command_prefix : "!wa"
2024-01-02 15:41:36 +00:00
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
2024-01-04 11:00:46 +00:00
matrix_mautrix_whatsapp_container_labels_traefik_tls_certResolver : default # noqa var-naming
2024-01-02 15:41:36 +00:00
# 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 : ''
2019-05-14 14:47:22 +00:00
# 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.
2024-01-02 15:41:36 +00:00
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 }}"
2024-06-04 10:14:34 +00:00
matrix_mautrix_whatsapp_systemd_required_services_list_default : "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
2024-01-02 15:41:36 +00:00
matrix_mautrix_whatsapp_systemd_required_services_list_auto : [ ]
matrix_mautrix_whatsapp_systemd_required_services_list_custom : [ ]
2019-05-14 14:47:22 +00:00
# List of systemd services that matrix-mautrix-whatsapp.service wants
matrix_mautrix_whatsapp_systemd_wanted_services_list : [ ]
2019-06-23 22:16:04 +00:00
matrix_mautrix_whatsapp_appservice_token : ''
matrix_mautrix_whatsapp_homeserver_token : ''
2021-01-27 13:43:33 +00:00
matrix_mautrix_whatsapp_appservice_bot_username : whatsappbot
2022-07-07 04:54:03 +00:00
# Minimum severity of journal log messages.
# Options: debug, info, warn, error, fatal
matrix_mautrix_whatsapp_logging_level : 'warn'
2022-03-05 20:10:24 +00:00
# Whether or not created rooms should have federation enabled.
# If false, created portal rooms will never be federated.
matrix_mautrix_whatsapp_federate_rooms : true
2023-01-29 08:45:52 +00:00
# Whether or not metrics endpoint should be enabled.
2023-01-30 06:50:57 +00:00
# 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`.
2023-01-29 08:45:52 +00:00
matrix_mautrix_whatsapp_metrics_enabled : false
2024-01-02 15:41:36 +00:00
# Controls whether metrics should be proxied (exposed) on a public URL
2023-01-30 06:50:57 +00:00
matrix_mautrix_whatsapp_metrics_proxying_enabled : false
2024-01-02 15:41:36 +00:00
matrix_mautrix_whatsapp_metrics_proxying_hostname : ''
matrix_mautrix_whatsapp_metrics_proxying_path_prefix : ''
2023-01-30 06:50:57 +00:00
2020-12-14 10:24:37 +00:00
# Database-related configuration fields.
#
# To use SQLite, stick to these defaults.
#
# To use Postgres:
# - change the engine (`matrix_mautrix_whatsapp_database_engine: 'postgres'`)
2021-12-08 10:09:09 +00:00
# - adjust your database credentials via the `matrix_mautrix_whatsapp_database_*` variables
2020-12-14 10:24:37 +00:00
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"
2020-12-14 11:02:47 +00:00
matrix_mautrix_whatsapp_database_username : 'matrix_mautrix_whatsapp'
matrix_mautrix_whatsapp_database_password : 'some-password'
2022-11-27 07:16:18 +00:00
matrix_mautrix_whatsapp_database_hostname : ''
2020-12-14 11:02:47 +00:00
matrix_mautrix_whatsapp_database_port : 5432
2020-12-22 15:10:02 +00:00
matrix_mautrix_whatsapp_database_name : 'matrix_mautrix_whatsapp'
2023-08-22 16:38:11 +00:00
matrix_mautrix_whatsapp_database_sslmode : disable
2020-12-14 10:24:37 +00:00
2023-08-22 16:38:11 +00:00
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 }}'
2020-12-14 10:24:37 +00:00
matrix_mautrix_whatsapp_appservice_database_type : "{{
{
2024-10-17 13:19:29 +00:00
'sqlite' : 'sqlite3-fk-wal' ,
2020-12-14 10:24:37 +00:00
'postgres' : 'postgres' ,
}[ matrix_mautrix_whatsapp_database_engine]
}}"
matrix_mautrix_whatsapp_appservice_database_uri : "{{
{
'sqlite' : matrix_mautrix_whatsapp_sqlite_database_path_in_container,
2020-12-14 12:42:18 +00:00
'postgres' : matrix_mautrix_whatsapp_database_connection_string,
2020-12-14 10:24:37 +00:00
}[ matrix_mautrix_whatsapp_database_engine]
}}"
2024-10-17 13:19:29 +00:00
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 : {}
2021-11-16 13:22:06 +00:00
2022-07-25 12:55:16 +00:00
# Enable End-to-bridge encryption
2023-04-05 11:59:48 +00:00
matrix_mautrix_whatsapp_bridge_encryption_allow : "{{ matrix_bridges_encryption_enabled }}"
2024-03-24 02:58:03 +00:00
matrix_mautrix_whatsapp_bridge_encryption_default : "{{ matrix_bridges_encryption_default }}"
2024-10-17 13:19:29 +00:00
matrix_mautrix_whatsapp_bridge_encryption_require : false
2022-07-25 12:55:16 +00:00
matrix_mautrix_whatsapp_bridge_encryption_key_sharing_allow : "{{ matrix_mautrix_whatsapp_bridge_encryption_allow }}"
2024-10-17 13:19:29 +00:00
# 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
2022-07-25 12:55:16 +00:00
2022-08-09 20:45:10 +00:00
matrix_mautrix_whatsapp_bridge_personal_filtering_spaces : true
2024-10-17 13:19:29 +00:00
matrix_mautrix_whatsapp_bridge_enable_status_broadcast : true
matrix_mautrix_whatsapp_provisioning_shared_secret : ''
matrix_mautrix_whatsapp_public_media_signing_key : ''
2022-08-09 20:45:10 +00:00
2022-07-25 12:55:16 +00:00
matrix_mautrix_whatsapp_bridge_permissions : |
{{
2023-11-29 11:32:14 +00:00
{'*': 'relay', matrix_mautrix_whatsapp_homeserver_domain : 'user' }
2022-07-25 12:55:16 +00:00
| combine({matrix_admin: 'admin'} if matrix_admin else {})
}}
2023-01-06 09:09:07 +00:00
# Enable bridge relay functionality
2023-07-21 10:22:05 +00:00
matrix_mautrix_whatsapp_bridge_relay_enabled : "{{ matrix_bridges_relay_enabled }}"
2023-01-06 09:09:07 +00:00
# Only allow admins on this home server to set themselves as a relay user
matrix_mautrix_whatsapp_bridge_relay_admin_only : true
2024-10-17 13:19:29 +00:00
# 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
2019-06-23 22:16:04 +00:00
# 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.
2020-06-03 06:33:28 +00:00
matrix_mautrix_whatsapp_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2019-06-23 22:16:04 +00:00
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`.
2022-07-18 08:22:05 +00:00
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 {} }}"
2019-06-23 22:16:04 +00:00
# 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`.
2022-07-18 09:28:39 +00:00
matrix_mautrix_whatsapp_configuration : "{{ matrix_mautrix_whatsapp_configuration_yaml | from_yaml | combine(matrix_mautrix_whatsapp_configuration_extension, recursive=True) }}"
2019-06-23 22:16:04 +00:00
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 }}"
2021-08-18 15:21:20 +00:00
# See https://github.com/mautrix/signal/issues/43
2021-01-27 13:48:35 +00:00
sender_localpart : _bot_{{ matrix_mautrix_whatsapp_appservice_bot_username }}
2019-06-23 22:16:04 +00:00
rate_limited : false
namespaces :
users :
2022-07-18 09:28:39 +00:00
- regex : '^@whatsapp_[0-9]+:{{ matrix_mautrix_whatsapp_homeserver_domain | regex_escape }}$'
2019-06-23 22:16:04 +00:00
exclusive : true
2021-01-27 13:43:33 +00:00
- exclusive : true
2022-07-18 09:28:39 +00:00
regex : '^@{{ matrix_mautrix_whatsapp_appservice_bot_username | regex_escape }}:{{ matrix_mautrix_whatsapp_homeserver_domain | regex_escape }}$'
2021-03-25 17:49:43 +00:00
de.sorunome.msc2409.push_ephemeral : true
2019-06-23 22:16:04 +00:00
2022-07-18 08:22:05 +00:00
matrix_mautrix_whatsapp_registration : "{{ matrix_mautrix_whatsapp_registration_yaml | from_yaml }}"