272 lines
13 KiB
YAML
272 lines
13 KiB
YAML
# Homeserver details.
|
|
homeserver:
|
|
# The address that this appservice can use to connect to the homeserver.
|
|
address: https://example.com
|
|
# The domain of the homeserver (for MXIDs, etc).
|
|
domain: example.com
|
|
|
|
# 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: http://localhost:29318
|
|
|
|
# The hostname and port where this appservice should listen.
|
|
hostname: 0.0.0.0
|
|
port: 29318
|
|
|
|
# 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?sslmode=disable
|
|
uri: mautrix-whatsapp.db
|
|
# Maximum number of connections. Mostly relevant for Postgres.
|
|
max_open_conns: 20
|
|
max_idle_conns: 2
|
|
|
|
# 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
|
|
|
|
# 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: "This value is generated when generating the registration"
|
|
hs_token: "This value is generated when generating the registration"
|
|
|
|
metrics:
|
|
# Whether or not to enable prometheus metrics
|
|
enabled: false
|
|
# IP and port where the metrics listener should be. The path is always /metrics
|
|
listen: 127.0.0.1:8001
|
|
|
|
whatsapp:
|
|
# Device name that's shown in the "WhatsApp Web" section in the mobile app.
|
|
os_name: Mautrix-WhatsApp bridge
|
|
# Browser name that determines the logo shown in the mobile app. If the name is unrecognized, a generic icon is shown.
|
|
# Use the name of an actual browser (Chrome, Firefox, Safari, IE, Edge, Opera) if you want a specific icon.
|
|
browser_name: mx-wa
|
|
|
|
# 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
|
|
# To use multiple if's, you need to use: {{else if .Name}}, for example:
|
|
# "{{if .Notify}}{{.Notify}}{{else if .Name}}{{.Name}}{{else}}{{.Jid}}{{end}} (WA)"
|
|
displayname_template: "{{if .Notify}}{{.Notify}}{{else}}{{.Jid}}{{end}} (WA)"
|
|
# Localpart template for per-user room grouping community IDs.
|
|
# On startup, the bridge will try to create these communities, add all of the specific user's
|
|
# portals to the community, and invite the Matrix user to it.
|
|
# (Note that, by default, non-admins might not have your homeserver's permission to create
|
|
# communities.)
|
|
# {{.Localpart}} is the MXID localpart and {{.Server}} is the MXID server part of the user.
|
|
# whatsapp_{{.Localpart}}={{.Server}} is a good value that should work for any user.
|
|
community_template: null
|
|
|
|
# WhatsApp connection timeout in seconds.
|
|
connection_timeout: 20
|
|
# If WhatsApp doesn't respond within connection_timeout, should the bridge try to fetch the message
|
|
# to see if it was actually bridged? Use this if you have problems with sends timing out but actually
|
|
# succeeding.
|
|
fetch_message_on_timeout: false
|
|
# Whether or not the bridge should send a read receipt from the bridge bot when a message has been
|
|
# sent to WhatsApp. If fetch_message_on_timeout is enabled, a successful post-timeout fetch will
|
|
# trigger a read receipt too.
|
|
delivery_receipts: false
|
|
# Number of times to regenerate QR code when logging in.
|
|
# The regenerated QR code is sent as an edit and essentially multiplies the login timeout (20 seconds)
|
|
login_qr_regen_count: 2
|
|
# 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
|
|
# Whether or not the bridge should reconnect even if WhatsApp says another web client connected.
|
|
aggressive_reconnect: false
|
|
# Maximum number of seconds to wait for chats to be sent at startup.
|
|
# If this is too low and you have lots of chats, it could cause backfilling to fail.
|
|
chat_list_wait: 30
|
|
# Maximum number of seconds to wait to sync portals before force unlocking message processing.
|
|
# If this is too low and you have lots of chats, it could cause backfilling to fail.
|
|
portal_sync_wait: 600
|
|
user_message_buffer: 1024
|
|
portal_message_buffer: 128
|
|
|
|
# Whether or not to send call start/end notices to Matrix.
|
|
call_notices:
|
|
start: true
|
|
end: true
|
|
|
|
# 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
|
|
# Whether or not notifications should be turned off while filling initial history.
|
|
# Only applicable when using double puppeting.
|
|
initial_history_disable_notifications: false
|
|
# 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
|
|
# Whether or not portal info should be fetched from the server when syncing,
|
|
# instead of relying on finding any changes in the message history.
|
|
# If you get 599 errors often, you should try disabling this.
|
|
chat_meta_sync: true
|
|
# Whether or not puppet avatars should be fetched from the server even if an avatar is already set.
|
|
# If you get 599 errors often, you should try disabling this.
|
|
user_avatar_sync: true
|
|
# Whether or not Matrix users leaving groups should be bridged to WhatsApp
|
|
bridge_matrix_leave: 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 update the m.direct account data event when double puppeting is enabled.
|
|
# 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
|
|
# When double puppeting is enabled, users can use `!wa toggle` to change whether or not
|
|
# 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
|
|
# Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
|
|
#
|
|
# If set, custom puppets will be enabled automatically for local users
|
|
# instead of users having to find an access token and run `login-matrix`
|
|
# manually.
|
|
login_shared_secret: null
|
|
|
|
# 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
|
|
# Whether or not Matrix m.notice-type messages should be bridged.
|
|
bridge_notices: true
|
|
# Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
|
|
# This field will automatically be changed back to false after it,
|
|
# except if the config file is not writable.
|
|
resend_bridge_info: false
|
|
|
|
# Whether or not thumbnails from WhatsApp should be sent.
|
|
# They're disabled by default due to very low resolution.
|
|
whatsapp_thumbnail: false
|
|
|
|
# Allow invite permission for user. User can invite any bots to room with whatsapp
|
|
# users (private chat and groups)
|
|
allow_user_invite: false
|
|
|
|
# The prefix for commands. Only required in non-management rooms.
|
|
command_prefix: "!wa"
|
|
|
|
# End-to-bridge encryption support options. This requires login_shared_secret to be configured
|
|
# in order to get a device for the bridge bot.
|
|
#
|
|
# Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal
|
|
# application service.
|
|
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.
|
|
# It is recommended to also set private_chat_portal_meta to true when using this.
|
|
default: false
|
|
# 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
|
|
|
|
# Permissions for using the bridge.
|
|
# Permitted values:
|
|
# relaybot - Talk through the relaybot (if enabled), no access otherwise
|
|
# 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:
|
|
"*": relaybot
|
|
"example.com": user
|
|
"@admin:example.com": admin
|
|
|
|
relaybot:
|
|
# Whether or not relaybot support is enabled.
|
|
enabled: false
|
|
# The management room for the bot. This is where all status notifications are posted and
|
|
# in this room, you can use `!wa <command>` instead of `!wa relaybot <command>`. Omitting
|
|
# the command prefix completely like in user management rooms is not possible.
|
|
management: "!foo:example.com"
|
|
# List of users to invite to all created rooms that include the relaybot.
|
|
invites: []
|
|
# 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"
|
|
|
|
# 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
|