2018-08-13 00:00:23 +02:00
|
|
|
# Homeserver details.
|
|
|
|
homeserver:
|
2019-03-13 23:38:11 +01:00
|
|
|
# The address that this appservice can use to connect to the homeserver.
|
2019-11-10 20:22:11 +01:00
|
|
|
address: https://example.com
|
2019-03-13 23:38:11 +01:00
|
|
|
# The domain of the homeserver (for MXIDs, etc).
|
2019-11-10 20:22:11 +01:00
|
|
|
domain: example.com
|
2018-08-13 00:00:23 +02:00
|
|
|
|
2021-06-01 14:19:47 +02:00
|
|
|
# The URL to push real-time bridge status to.
|
|
|
|
# If set, the bridge will make POST requests to this URL whenever a user's whatsapp connection state changes.
|
2021-06-01 14:28:15 +02:00
|
|
|
# The bridge will use the appservice as_token to authorize requests.
|
2021-06-01 14:19:47 +02:00
|
|
|
status_endpoint: null
|
|
|
|
|
2018-08-13 00:00:23 +02:00
|
|
|
# Application service host/registration related details.
|
|
|
|
# Changing these values requires regeneration of the registration.
|
|
|
|
appservice:
|
2019-03-13 23:38:11 +01:00
|
|
|
# The address that the homeserver can use to connect to this appservice.
|
2019-07-28 17:29:30 +02:00
|
|
|
address: http://localhost:29318
|
2018-08-13 00:00:23 +02:00
|
|
|
|
2019-03-13 23:38:11 +01:00
|
|
|
# The hostname and port where this appservice should listen.
|
|
|
|
hostname: 0.0.0.0
|
2019-07-28 17:29:30 +02:00
|
|
|
port: 29318
|
2018-08-13 00:00:23 +02:00
|
|
|
|
2019-03-13 23:38:11 +01:00
|
|
|
# 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
|
2020-04-12 09:41:53 +02:00
|
|
|
# Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
|
2021-10-25 15:08:49 +02:00
|
|
|
# To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
|
2019-03-13 23:38:11 +01:00
|
|
|
uri: mautrix-whatsapp.db
|
2019-05-17 22:33:27 +02:00
|
|
|
# Maximum number of connections. Mostly relevant for Postgres.
|
|
|
|
max_open_conns: 20
|
|
|
|
max_idle_conns: 2
|
|
|
|
|
2020-02-09 19:32:14 +01:00
|
|
|
# Settings for provisioning API
|
|
|
|
provisioning:
|
|
|
|
# Prefix for the provisioning API paths.
|
|
|
|
prefix: /_matrix/provision/v1
|
|
|
|
# Shared secret for authentication. If set to "disable", the provisioning API will be disabled.
|
|
|
|
shared_secret: disable
|
|
|
|
|
2019-03-13 23:38:11 +01:00
|
|
|
# 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
|
2018-08-13 00:00:23 +02:00
|
|
|
|
2019-03-13 23:38:11 +01:00
|
|
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
|
|
|
as_token: "This value is generated when generating the registration"
|
|
|
|
hs_token: "This value is generated when generating the registration"
|
2018-08-13 00:00:23 +02:00
|
|
|
|
2020-06-17 16:50:06 +02:00
|
|
|
metrics:
|
2021-10-30 22:25:23 +02:00
|
|
|
# Enable prometheus metrics?
|
2020-06-17 16:50:06 +02:00
|
|
|
enabled: false
|
|
|
|
# IP and port where the metrics listener should be. The path is always /metrics
|
|
|
|
listen: 127.0.0.1:8001
|
|
|
|
|
2020-06-25 16:59:44 +02:00
|
|
|
whatsapp:
|
2020-08-27 00:14:54 +02:00
|
|
|
# Device name that's shown in the "WhatsApp Web" section in the mobile app.
|
|
|
|
os_name: Mautrix-WhatsApp bridge
|
2021-10-28 14:04:27 +02:00
|
|
|
# Browser name that determines the logo shown in the mobile app.
|
|
|
|
# Must be "unknown" for a generic icon or a valid browser name if you want a specific icon.
|
|
|
|
# List of valid browser names: https://github.com/tulir/whatsmeow/blob/2a72655ef600a7fd7a2e98d53ec6da029759c4b8/binary/proto/def.proto#L1582-L1594
|
|
|
|
browser_name: unknown
|
2020-06-25 16:59:44 +02:00
|
|
|
|
2019-04-06 21:41:25 +02:00
|
|
|
# Bridge config
|
2018-08-13 00:00:23 +02:00
|
|
|
bridge:
|
2019-03-13 23:38:11 +01:00
|
|
|
# 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.
|
2021-10-22 19:14:34 +02:00
|
|
|
# {{.PushName}} - nickname set by the WhatsApp user
|
|
|
|
# {{.BusinessName}} - validated WhatsApp business name
|
|
|
|
# {{.Phone}} - phone number (international format)
|
2019-03-13 23:38:11 +01:00
|
|
|
# The following variables are also available, but will cause problems on multi-user instances:
|
2021-10-22 19:14:34 +02:00
|
|
|
# {{.FullName}} - full name from contact list
|
|
|
|
# {{.FirstName}} - first name from contact list
|
|
|
|
displayname_template: "{{if .PushName}}{{.PushName}}{{else if .BusinessName}}{{.BusinessName}}{{else}}{{.JID}}{{end}} (WA)"
|
2018-08-16 23:11:28 +02:00
|
|
|
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge send a read receipt from the bridge bot when a message has been sent to WhatsApp?
|
2020-05-25 10:17:47 +02:00
|
|
|
delivery_receipts: false
|
2021-10-28 14:04:27 +02:00
|
|
|
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should notices of incoming calls be sent to Matrix?
|
2019-08-24 21:42:03 +02:00
|
|
|
call_notices:
|
|
|
|
start: true
|
|
|
|
end: true
|
|
|
|
|
2021-10-30 22:25:23 +02:00
|
|
|
# Settings for handling history sync payloads. These settings only apply right after login,
|
|
|
|
# because the phone only sends the history sync data once, and there's no way to re-request it
|
|
|
|
# (other than logging out and back in again).
|
2021-10-28 11:59:22 +02:00
|
|
|
history_sync:
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge create portals for chats in the history sync payload?
|
2021-10-28 11:59:22 +02:00
|
|
|
create_portals: true
|
2021-10-30 20:54:35 +02:00
|
|
|
# Maximum age of chats in seconds to create portals for. Set to 0 to create portals for all chats in sync payload.
|
|
|
|
max_age: 604800
|
2021-10-30 22:25:23 +02:00
|
|
|
# Enable backfilling history sync payloads from WhatsApp using batch sending?
|
2021-10-28 11:59:22 +02:00
|
|
|
# This requires a server with MSC2716 support, which is currently an experimental feature in synapse.
|
2021-11-01 15:45:39 +01:00
|
|
|
# It can be enabled by setting experimental_features -> msc2716_enabled to true in homeserver.yaml.
|
|
|
|
# Note that as of Synapse 1.46, there are still some bugs with the implementation, especially if using event persistence workers.
|
2021-10-28 11:59:22 +02:00
|
|
|
backfill: false
|
2021-10-30 22:25:23 +02:00
|
|
|
# Use double puppets for backfilling?
|
|
|
|
# In order to use this, the double puppets must be in the appservice's user ID namespace
|
|
|
|
# (because the bridge can't use the double puppet access token with batch sending).
|
2021-10-28 11:59:22 +02:00
|
|
|
double_puppet_backfill: false
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge request a full sync from the phone when logging in?
|
2021-10-30 22:12:16 +02:00
|
|
|
# This bumps the size of history syncs from 3 months to 1 year.
|
|
|
|
request_full_sync: false
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should puppet avatars be fetched from the server even if an avatar is already set?
|
2021-02-09 22:41:14 +01:00
|
|
|
user_avatar_sync: true
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should Matrix users leaving groups be bridged to WhatsApp?
|
2021-02-10 21:15:23 +01:00
|
|
|
bridge_matrix_leave: true
|
2019-05-22 15:46:18 +02:00
|
|
|
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge sync with double puppeting to receive EDUs that aren't normally sent to appservices.
|
2019-05-24 01:33:26 +02:00
|
|
|
sync_with_custom_puppets: true
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge update the m.direct account data event when double puppeting is enabled.
|
2020-08-22 12:07:55 +02:00
|
|
|
# Note that updating the m.direct event is not atomic (except with mautrix-asmux)
|
|
|
|
# and is therefore prone to race conditions.
|
|
|
|
sync_direct_chat_list: false
|
2021-10-30 22:25:23 +02:00
|
|
|
# When double puppeting is enabled, users can use `!wa toggle` to change whether
|
2020-07-10 15:26:55 +02:00
|
|
|
# presence and read receipts are bridged. These settings set the default values.
|
|
|
|
# Existing users won't be affected when these are changed.
|
|
|
|
default_bridge_receipts: true
|
|
|
|
default_bridge_presence: true
|
2019-12-30 19:21:04 +01:00
|
|
|
# Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
|
|
|
|
#
|
2021-10-30 22:25:23 +02:00
|
|
|
# If set, double puppeting will be enabled automatically for local users
|
2019-12-30 19:21:04 +01:00
|
|
|
# instead of users having to find an access token and run `login-matrix`
|
|
|
|
# manually.
|
|
|
|
login_shared_secret: null
|
2019-05-24 01:33:26 +02:00
|
|
|
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge explicitly set the avatar and room name for private chat portal rooms?
|
2019-06-01 19:03:29 +02:00
|
|
|
private_chat_portal_meta: false
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should Matrix m.notice-type messages be bridged?
|
2021-02-26 15:10:57 +01:00
|
|
|
bridge_notices: true
|
2020-06-15 19:28:04 +02:00
|
|
|
# Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
|
2021-10-28 11:59:22 +02:00
|
|
|
# This field will automatically be changed back to false after it, except if the config file is not writable.
|
2020-06-15 19:28:04 +02:00
|
|
|
resend_bridge_info: false
|
2021-04-19 21:14:32 +02:00
|
|
|
# When using double puppeting, should muted chats be muted in Matrix?
|
|
|
|
mute_bridging: false
|
|
|
|
# When using double puppeting, should archived chats be moved to a specific tag in Matrix?
|
|
|
|
# Note that WhatsApp unarchives chats when a message is received, which will also be mirrored to Matrix.
|
|
|
|
# This can be set to a tag (e.g. m.lowpriority), or null to disable.
|
|
|
|
archive_tag: null
|
2021-04-20 15:32:23 +02:00
|
|
|
# Same as above, but for pinned chats. The favorite tag is called m.favourite
|
|
|
|
pinned_tag: null
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should mute status and tags only be bridged when the portal room is created?
|
2021-04-29 10:57:05 +02:00
|
|
|
tag_only_on_create: true
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should WhatsApp status messages be bridged into a Matrix room?
|
2021-06-01 14:28:15 +02:00
|
|
|
# Disabling this won't affect already created status broadcast rooms.
|
|
|
|
enable_status_broadcast: true
|
2019-06-01 19:03:29 +02:00
|
|
|
|
2021-10-30 22:25:23 +02:00
|
|
|
# Should the bridge use thumbnails from WhatsApp?
|
2020-06-10 14:26:14 +02:00
|
|
|
# They're disabled by default due to very low resolution.
|
|
|
|
whatsapp_thumbnail: false
|
|
|
|
|
2019-08-10 14:24:53 +02:00
|
|
|
# Allow invite permission for user. User can invite any bots to room with whatsapp
|
2019-07-16 11:16:17 +02:00
|
|
|
# users (private chat and groups)
|
|
|
|
allow_user_invite: false
|
|
|
|
|
2019-03-13 23:38:11 +01:00
|
|
|
# The prefix for commands. Only required in non-management rooms.
|
|
|
|
command_prefix: "!wa"
|
2018-08-16 23:11:28 +02:00
|
|
|
|
2021-11-01 10:17:44 +01:00
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
|
|
# If false, created portal rooms will never be federated.
|
|
|
|
federate_rooms: true
|
|
|
|
|
2021-10-28 12:58:20 +02:00
|
|
|
# Messages sent upon joining a management room.
|
|
|
|
# Markdown is supported. The defaults are listed below.
|
|
|
|
management_room_text:
|
|
|
|
# Sent when joining a room.
|
|
|
|
welcome: "Hello, I'm a WhatsApp bridge bot."
|
|
|
|
# Sent when joining a management room and the user is already logged in.
|
|
|
|
welcome_connected: "Use `help` for help."
|
|
|
|
# Sent when joining a management room and the user is not logged in.
|
|
|
|
welcome_unconnected: "Use `help` for help or `login` to log in."
|
|
|
|
# Optional extra text sent when joining a management room.
|
|
|
|
# additional_help: "This would be some additional text in case you need it."
|
|
|
|
|
2021-10-08 18:11:06 +02:00
|
|
|
# End-to-bridge encryption support options.
|
2020-05-09 01:03:59 +02:00
|
|
|
#
|
2021-10-08 18:11:06 +02:00
|
|
|
# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
|
2020-05-09 01:03:59 +02:00
|
|
|
encryption:
|
|
|
|
# Allow encryption, work in group chat rooms with e2ee enabled
|
|
|
|
allow: false
|
|
|
|
# Default to encryption, force-enable encryption in all portals the bridge creates
|
|
|
|
# This will cause the bridge bot to be in private chats for the encryption to work properly.
|
2020-05-12 21:25:55 +02:00
|
|
|
# It is recommended to also set private_chat_portal_meta to true when using this.
|
2020-05-09 01:03:59 +02:00
|
|
|
default: false
|
2020-08-05 13:58:46 +02:00
|
|
|
# Options for automatic key sharing.
|
|
|
|
key_sharing:
|
|
|
|
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
|
|
|
|
# You must use a client that supports requesting keys from other users to use this feature.
|
|
|
|
allow: false
|
|
|
|
# Require the requesting device to have a valid cross-signing signature?
|
|
|
|
# This doesn't require that the bridge has verified the device, only that the user has verified it.
|
|
|
|
# Not yet implemented.
|
|
|
|
require_cross_signing: false
|
|
|
|
# Require devices to be verified by the bridge?
|
|
|
|
# Verification by the bridge is not yet implemented.
|
|
|
|
require_verification: true
|
2020-05-09 01:03:59 +02:00
|
|
|
|
2019-03-13 23:38:11 +01:00
|
|
|
# Permissions for using the bridge.
|
|
|
|
# Permitted values:
|
2021-10-28 13:03:55 +02:00
|
|
|
# relay - Talk through the relaybot (if enabled), no access otherwise
|
2019-03-13 23:38:11 +01:00
|
|
|
# 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:
|
2021-10-28 13:03:55 +02:00
|
|
|
"*": relay
|
2019-03-13 23:38:11 +01:00
|
|
|
"example.com": user
|
|
|
|
"@admin:example.com": admin
|
2018-08-13 00:00:23 +02:00
|
|
|
|
2021-10-28 12:57:15 +02:00
|
|
|
relay:
|
2021-10-30 21:41:18 +02:00
|
|
|
# Whether relay mode should be allowed. If allowed, `!wa set-relay` can be used to turn any
|
2021-10-28 12:57:15 +02:00
|
|
|
# authenticated user into a relaybot for that chat.
|
2019-11-10 20:22:11 +01:00
|
|
|
enabled: false
|
2021-10-28 12:57:15 +02:00
|
|
|
# Should only admins be allowed to set themselves as relay users?
|
|
|
|
admin_only: true
|
2019-11-10 20:22:11 +01:00
|
|
|
# The formats to use when sending messages to WhatsApp via the relaybot.
|
|
|
|
message_formats:
|
|
|
|
m.text: "<b>{{ .Sender.Displayname }}</b>: {{ .Message }}"
|
|
|
|
m.notice: "<b>{{ .Sender.Displayname }}</b>: {{ .Message }}"
|
|
|
|
m.emote: "* <b>{{ .Sender.Displayname }}</b> {{ .Message }}"
|
|
|
|
m.file: "<b>{{ .Sender.Displayname }}</b> sent a file"
|
|
|
|
m.image: "<b>{{ .Sender.Displayname }}</b> sent an image"
|
|
|
|
m.audio: "<b>{{ .Sender.Displayname }}</b> sent an audio file"
|
|
|
|
m.video: "<b>{{ .Sender.Displayname }}</b> sent a video"
|
|
|
|
m.location: "<b>{{ .Sender.Displayname }}</b> sent a location"
|
|
|
|
|
2018-08-13 00:00:23 +02:00
|
|
|
# Logging config.
|
|
|
|
logging:
|
2019-03-13 23:38:11 +01:00
|
|
|
# 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.
|
2021-10-30 22:25:23 +02:00
|
|
|
# Set this to null to disable logging to file.
|
2019-03-13 23:38:11 +01:00
|
|
|
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
|
2021-10-30 22:25:23 +02:00
|
|
|
# Minimum severity for log messages printed to stdout/stderr. This doesn't affect the log file.
|
2019-03-13 23:38:11 +01:00
|
|
|
# Options: debug, info, warn, error, fatal
|
|
|
|
print_level: debug
|