193 lines
9.2 KiB
YAML
193 lines
9.2 KiB
YAML
# mautrix-whatsapp is a Matrix <-> Whatsapp bridge
|
|
# See: https://github.com/tulir/mautrix-whatsapp
|
|
|
|
matrix_mautrix_whatsapp_enabled: true
|
|
|
|
# See: https://mau.dev/tulir/mautrix-whatsapp/container_registry
|
|
matrix_mautrix_whatsapp_docker_image: "dock.mau.dev/tulir/mautrix-whatsapp:latest"
|
|
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_homeserver_address: "http://matrix-synapse:8008"
|
|
matrix_mautrix_whatsapp_homeserver_domain: "{{ matrix_domain }}"
|
|
matrix_mautrix_whatsapp_appservice_address: "http://matrix-mautrix-whatsapp:8080"
|
|
|
|
# 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: ['docker.service']
|
|
|
|
# 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: ''
|
|
|
|
# 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: |
|
|
# Homeserver details.
|
|
homeserver:
|
|
# The address that this appservice can use to connect to the homeserver.
|
|
address: {{ matrix_mautrix_whatsapp_homeserver_address }}
|
|
# The domain of the homeserver (for MXIDs, etc).
|
|
domain: {{ matrix_mautrix_whatsapp_homeserver_domain }}
|
|
# Application service host/registration related details.
|
|
# Changing these values requires regeneration of the registration.
|
|
|
|
appservice:
|
|
# The address that the homeserver can use to connect to this appservice.
|
|
address: {{ matrix_mautrix_whatsapp_appservice_address }}
|
|
|
|
# The hostname and port where this appservice should listen.
|
|
hostname: 0.0.0.0
|
|
port: 8080
|
|
|
|
# Database config.
|
|
database:
|
|
# The database type. "sqlite3" and "postgres" are supported.
|
|
type: sqlite3
|
|
# The database URI.
|
|
# SQLite: File name is enough. https://github.com/mattn/go-sqlite3#connection-string
|
|
# Postgres: Connection string. For example, postgres://user:password@host/database
|
|
uri: mautrix-whatsapp.db
|
|
# Maximum number of connections. Mostly relevant for Postgres.
|
|
max_open_conns: 20
|
|
max_idle_conns: 2
|
|
|
|
# Path to the Matrix room state store.
|
|
state_store_path: ./mx-state.json
|
|
|
|
# The unique ID of this appservice.
|
|
id: whatsapp
|
|
# Appservice bot details.
|
|
bot:
|
|
# Username of the appservice bot.
|
|
username: whatsappbot
|
|
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
|
|
# to leave display name/avatar as-is.
|
|
displayname: WhatsApp bridge bot
|
|
avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
|
|
|
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
|
as_token: "{{ matrix_mautrix_whatsapp_appservice_token }}"
|
|
hs_token: "{{ matrix_mautrix_whatsapp_homeserver_token }}"
|
|
|
|
# Bridge config
|
|
bridge:
|
|
# Localpart template of MXIDs for WhatsApp users.
|
|
# {{ '{{.}}' }} is replaced with the phone number of the WhatsApp user.
|
|
username_template: "{{ 'whatsapp_{{.}}' }}"
|
|
# Displayname template for WhatsApp users.
|
|
# {{ '{{.Notify'}}' }} - nickname set by the WhatsApp user
|
|
# {{ '{{.Jid}}' }} - phone number (international format)
|
|
# The following variables are also available, but will cause problems on multi-user instances:
|
|
# {{ '{{.Name}}' }} - display name from contact list
|
|
# {{ '{{.Short}}' }} - short display name from contact list
|
|
displayname_template: "{{ '{{if .Notify}}{{.Notify}}{{else}}{{.Jid}}{{end}} (WA)' }}"
|
|
# WhatsApp connection timeout in seconds.
|
|
connection_timeout: 20
|
|
# Maximum number of times to retry connecting on connection error.
|
|
max_connection_attempts: 3
|
|
# Number of seconds to wait between connection attempts.
|
|
# Negative numbers are exponential backoff: -connection_retry_delay + 1 + 2^attempts
|
|
connection_retry_delay: -1
|
|
# Whether or not the bridge should send a notice to the user's management room when it retries connecting.
|
|
# If false, it will only report when it stops retrying.
|
|
report_connection_retry: true
|
|
# Number of seconds to wait for contacts and chats to be sent at startup before syncing.
|
|
# If you have lots of chats, it might take more than a second.
|
|
contact_wait_delay: 1
|
|
# Number of chats to sync for new users.
|
|
initial_chat_sync_count: 10
|
|
# Number of old messages to fill when creating new portal rooms.
|
|
initial_history_fill_count: 20
|
|
# Maximum number of chats to sync when recovering from downtime.
|
|
# Set to -1 to sync all new chats during downtime.
|
|
recovery_chat_sync_limit: -1
|
|
# Whether or not to sync history when recovering from downtime.
|
|
recovery_history_backfill: true
|
|
# Maximum number of seconds since last message in chat to skip
|
|
# syncing the chat in any case. This setting will take priority
|
|
# over both recovery_chat_sync_limit and initial_chat_sync_count.
|
|
# Default is 3 days = 259200 seconds
|
|
sync_max_chat_age: 259200
|
|
|
|
# Whether or not to sync with custom puppets to receive EDUs that
|
|
# are not normally sent to appservices.
|
|
sync_with_custom_puppets: true
|
|
# Whether or not to invite own WhatsApp user's Matrix puppet into private
|
|
# chat portals when backfilling if needed.
|
|
# This always uses the default puppet instead of custom puppets due to
|
|
# rate limits and timestamp massaging.
|
|
invite_own_puppet_for_backfilling: true
|
|
# Whether or not to explicitly set the avatar and room name for private
|
|
# chat portal rooms. This can be useful if the previous field works fine,
|
|
# but causes room avatar/name bugs.
|
|
private_chat_portal_meta: false
|
|
|
|
# The prefix for commands. Only required in non-management rooms.
|
|
command_prefix: "!wa"
|
|
|
|
# Permissions for using the bridge.
|
|
# Permitted values:
|
|
# user - Access to use the bridge to chat with a WhatsApp account.
|
|
# admin - User level and some additional administration tools
|
|
# Permitted keys:
|
|
# * - All Matrix users
|
|
# domain - All users on that homeserver
|
|
# mxid - Specific user
|
|
permissions:
|
|
"{{ matrix_mautrix_whatsapp_homeserver_domain }}": user
|
|
# Logging config.
|
|
logging:
|
|
# The directory for log files. Will be created if not found.
|
|
directory: ./logs
|
|
# Available variables: .Date for the file date and .Index for different log files on the same day.
|
|
file_name_format: "{{ '{{.Date}}-{{.Index}}.log' }}"
|
|
# Date format for file names in the Go time format: https://golang.org/pkg/time/#pkg-constants
|
|
file_date_format: "2006-01-02"
|
|
# Log file permissions.
|
|
file_mode: 0600
|
|
# Timestamp format for log entries in the Go time format.
|
|
timestamp_format: "Jan _2, 2006 15:04:05"
|
|
# Minimum severity for log messages.
|
|
# Options: debug, info, warn, error, fatal
|
|
print_level: debug
|
|
|
|
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 }}"
|
|
sender_localpart: whatsappbot
|
|
rate_limited: false
|
|
namespaces:
|
|
users:
|
|
- regex: '^@whatsapp_[0-9]+:{{ matrix_mautrix_whatsapp_homeserver_domain|regex_escape }}$'
|
|
exclusive: true
|
|
|
|
matrix_mautrix_whatsapp_registration: "{{ matrix_mautrix_whatsapp_registration_yaml|from_yaml }}"
|