Raw YAML - Releases: latest, v26.04, v26.03, v26.02, v26.01, v25.12, v25.11, v25.10
1# Network-specific config options
2network:
3 # Device name that's shown in the "WhatsApp Web" section in the mobile app.
4 os_name: Mautrix-WhatsApp bridge
5 # Browser name that determines the logo shown in the mobile app.
6 # Must be "unknown" for a generic icon or a valid browser name if you want a specific icon.
7 # List of valid browser names: https://github.com/tulir/whatsmeow/blob/efc632c008604016ddde63bfcfca8de4e5304da9/binary/proto/def.proto#L43-L64
8 browser_name: unknown
9
10 # Proxy to use for all WhatsApp connections.
11 proxy: null
12 # Alternative to proxy: an HTTP endpoint that returns the proxy URL to use for WhatsApp connections.
13 get_proxy_url: null
14 # Whether the proxy options should only apply to the login websocket and not to authenticated connections.
15 proxy_only_login: false
16
17 # Displayname template for WhatsApp users.
18 # {{.PushName}} - nickname set by the WhatsApp user
19 # {{.BusinessName}} - validated WhatsApp business name
20 # {{.Phone}} - phone number (international format)
21 # {{.RedactedPhone}} - phone number with middle digits replaced by "∙"
22 # {{.FullName}} - Name you set in the contacts list
23 displayname_template: '{{or .BusinessName .PushName .Phone .RedactedPhone "Unknown user"}} (WA)'
24
25 # Should incoming calls send a message to the Matrix room?
26 call_start_notices: true
27 # Should another user's cryptographic identity changing send a message to Matrix?
28 identity_change_notices: false
29 # Should the bridge mark you as online on WhatsApp when you send typing notifications?
30 # Full presence bridging is not supported.
31 send_presence_on_typing: false
32 # Should WhatsApp status messages be bridged into a Matrix room?
33 enable_status_broadcast: true
34 # Should sending WhatsApp status messages be allowed?
35 # This can cause issues if the user has lots of contacts, so it's disabled by default.
36 disable_status_broadcast_send: true
37 # Should the status broadcast room be muted and moved into low priority by default?
38 # This is only applied when creating the room, the user can unmute it later.
39 mute_status_broadcast: true
40 # Tag to apply to pinned chats on WhatsApp.
41 pinned_tag: m.favourite
42 # Tag to apply to archived chats on WhatsApp.
43 # Set to m.lowpriority to move them to low priority.
44 archive_tag:
45 # Tag to apply to the status broadcast room.
46 status_broadcast_tag: m.lowpriority
47 # Should the bridge use thumbnails from WhatsApp?
48 # They're disabled by default due to very low resolution.
49 whatsapp_thumbnail: false
50 # Should the bridge detect URLs in outgoing messages, ask the homeserver to generate a preview,
51 # and send it to WhatsApp? URL previews can always be sent using the `com.beeper.linkpreviews`
52 # key in the event content even if this is disabled.
53 url_previews: false
54 # Should polls be sent using unstable MSC3381 event types?
55 extev_polls: false
56 # Should view-once messages be disabled entirely?
57 disable_view_once: false
58 # Should the bridge always send "active" delivery receipts (two gray ticks on WhatsApp)
59 # even if the user isn't marked as online (e.g. when presence bridging isn't enabled)?
60 #
61 # By default, the bridge acts like WhatsApp web, which only sends active delivery
62 # receipts when it's in the foreground.
63 force_active_delivery_receipts: false
64 # When direct media is enabled and a piece of media isn't available on the WhatsApp servers,
65 # should it be automatically requested from the phone?
66 direct_media_auto_request: true
67 # Should the bridge automatically reconnect if it fails to connect on startup?
68 initial_auto_reconnect: true
69 # WhatsApp messages are sometimes undecryptable. Should the bridge store messages it sends in the
70 # bridge database in order to accept retry receipts from other WhatsApp users for messages sent via
71 # the bridge? By default, the bridge only stores messages in memory, and therefore can't accept
72 # retry receipts if the bridge is restarted after the message is sent.
73 use_whatsapp_retry_store: false
74
75 # Settings for converting animated stickers.
76 animated_sticker:
77 # Format to which animated stickers should be converted.
78 # disable - No conversion, just unzip and send raw lottie JSON
79 # png - converts to non-animated png (fastest)
80 # gif - converts to animated gif
81 # webm - converts to webm video, requires ffmpeg executable with vp9 codec and webm container support
82 # webp - converts to animated webp, requires ffmpeg executable with webp codec/container support
83 target: webp
84 # Arguments for converter. All converters take width and height.
85 args:
86 width: 320
87 height: 320
88 fps: 25 # only for webm, webp and gif (2, 5, 10, 20 or 25 recommended)
89
90 # Settings for handling history sync payloads.
91 history_sync:
92 # How many conversations should the bridge create after login?
93 # If -1, all conversations received from history sync will be bridged.
94 # Other conversations will be backfilled on demand when receiving a message.
95 max_initial_conversations: -1
96 # Should the bridge request a full sync from the phone when logging in?
97 # This bumps the size of history syncs from 3 months to 1 year.
98 request_full_sync: false
99 # Time to wait for history sync payloads before starting backfill. Each new payload resets the timer.
100 # If this is too low, the backfill may happen with incomplete history
101 # and backfill less messages than what is configured in the backfill section.
102 dispatch_wait: 1m
103 # Configuration parameters that are sent to the phone along with the request full sync flag.
104 # By default, (when the values are null or 0), the config isn't sent at all.
105 full_sync_config:
106 # Number of days of history to request.
107 # The limit seems to be around 3 years, but using higher values doesn't break.
108 days_limit: null
109 # This is presumably the maximum size of the transferred history sync blob, which may affect what the phone includes in the blob.
110 size_mb_limit: null
111 # This is presumably the local storage quota, which may affect what the phone includes in the history sync blob.
112 storage_quota_mb: null
113 # Settings for media requests. If the media expired, then it will not be on the WA servers.
114 # Media can always be requested by reacting with the ♻️ (recycle) emoji.
115 # These settings determine if the media requests should be done automatically during or after backfill.
116 media_requests:
117 # Should the expired media be automatically requested from the server as part of the backfill process?
118 auto_request_media: true
119 # Whether to request the media immediately after the media message is backfilled ("immediate")
120 # or at a specific time of the day ("local_time").
121 request_method: immediate
122 # If request_method is "local_time", what time should the requests be sent (in minutes after midnight)?
123 request_local_time: 120
124 # Maximum number of media request responses to handle in parallel per user.
125 max_async_handle: 2
126 # Use on-demand history sync requests for fetching older messages?
127 # This only applies when using the backfill queue, never for forward backfills.
128 backwards_on_demand: false
129
130
131# Config options that affect the central bridge module.
132bridge:
133 # The prefix for commands. Only required in non-management rooms.
134 command_prefix: '!wa'
135 # Should the bridge create a space for each login containing the rooms that account is in?
136 personal_filtering_spaces: true
137 # Whether the bridge should set names and avatars explicitly for DM portals.
138 # This is only necessary when using clients that don't support MSC4171.
139 private_chat_portal_meta: true
140 # Should events be handled asynchronously within portal rooms?
141 # If true, events may end up being out of order, but slow events won't block other ones.
142 # This is not yet safe to use.
143 async_events: false
144 # Should every user have their own portals rather than sharing them?
145 # By default, users who are in the same group on the remote network will be
146 # in the same Matrix room bridged to that group. If this is set to true,
147 # every user will get their own Matrix room instead.
148 # SETTING THIS IS IRREVERSIBLE AND POTENTIALLY DESTRUCTIVE IF PORTALS ALREADY EXIST.
149 split_portals: false
150 # Should the bridge resend `m.bridge` events to all portals on startup?
151 resend_bridge_info: false
152 # Should `m.bridge` events be sent without a state key?
153 # By default, the bridge uses a unique key that won't conflict with other bridges.
154 no_bridge_info_state_key: false
155 # Should bridge connection status be sent to the management room as `m.notice` events?
156 # These contain the same data that can be posted to an external HTTP server using homeserver -> status_endpoint.
157 # Allowed values: none, errors, all
158 bridge_status_notices: errors
159 # How long after an unknown error should the bridge attempt a full reconnect?
160 # Must be at least 1 minute. The bridge will add an extra ±20% jitter to this value.
161 unknown_error_auto_reconnect: null
162 # Maximum number of times to do the auto-reconnect above.
163 # The counter is per login, but is never reset except on logout and restart.
164 unknown_error_max_auto_reconnects: 10
165
166 # Should leaving Matrix rooms be bridged as leaving groups on the remote network?
167 bridge_matrix_leave: false
168 # Should `m.notice` messages be bridged?
169 bridge_notices: false
170 # Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
171 # Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
172 tag_only_on_create: true
173 # List of tags to allow bridging. If empty, no tags will be bridged.
174 only_bridge_tags: [m.favourite, m.lowpriority]
175 # Should room mute status only be synced when creating the portal?
176 # Like tags, mutes can't currently be synced back to the remote network.
177 mute_only_on_create: true
178 # Should the bridge check the db to ensure that incoming events haven't been handled before
179 deduplicate_matrix_messages: false
180 # Should cross-room reply metadata be bridged?
181 # Most Matrix clients don't support this and servers may reject such messages too.
182 cross_room_replies: false
183 # If a state event fails to bridge, should the bridge revert any state changes made by that event?
184 revert_failed_state_changes: false
185 # In portals with no relay set, should Matrix users be kicked if they're
186 # not logged into an account that's in the remote chat?
187 kick_matrix_users: true
188 # Should the bridge listen to com.beeper.state_request events?
189 # This is not necessary for anything outside of Beeper.
190 enable_send_state_requests: false
191 # Should the com.beeper.bridge.identifiers list in global ghost profiles include phone numbers?
192 phone_numbers_in_profile: false
193
194 # What should be done to portal rooms when a user logs out or is logged out?
195 # Permitted values:
196 # nothing - Do nothing, let the user stay in the portals
197 # kick - Remove the user from the portal rooms, but don't delete them
198 # unbridge - Remove all ghosts in the room and disassociate it from the remote chat
199 # delete - Remove all ghosts and users from the room (i.e. delete it)
200 cleanup_on_logout:
201 # Should cleanup on logout be enabled at all?
202 enabled: false
203 # Settings for manual logouts (explicitly initiated by the Matrix user)
204 manual:
205 # Action for private portals which will never be shared with other Matrix users.
206 private: nothing
207 # Action for portals with a relay user configured.
208 relayed: nothing
209 # Action for portals which may be shared, but don't currently have any other Matrix users.
210 shared_no_users: nothing
211 # Action for portals which have other logged-in Matrix users.
212 shared_has_users: nothing
213 # Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
214 # Keys have the same meanings as in the manual section.
215 bad_credentials:
216 private: nothing
217 relayed: nothing
218 shared_no_users: nothing
219 shared_has_users: nothing
220
221 # Settings for relay mode
222 relay:
223 # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
224 # authenticated user into a relaybot for that chat.
225 enabled: false
226 # Should only admins be allowed to set themselves as relay users?
227 # If true, non-admins can only set users listed in default_relays as relays in a room.
228 admin_only: true
229 # Should default relays be preferred when an explicit login ID isn't specified even if the user is logged in?
230 # This applies to the set-relay and bridge commands sent by any user, including admins.
231 prefer_default: true
232 # Should non-admins be allowed to use the bridge and sync-chat commands via default relays specified below?
233 allow_bridge: true
234 # List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
235 default_relays: []
236 # The formats to use when sending messages via the relaybot.
237 # Available variables:
238 # .Sender.UserID - The Matrix user ID of the sender.
239 # .Sender.Displayname - The display name of the sender (if set).
240 # .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
241 # .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
242 # plus the user ID in parentheses if the displayname is not unique.
243 # If the displayname is not set, this is just the user ID.
244 # .Message - The `formatted_body` field of the message.
245 # .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
246 # .FileName - The name of the file being sent.
247 message_formats:
248 m.text: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
249 m.notice: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
250 m.emote: "* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}"
251 m.file: "<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}"
252 m.image: "<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}"
253 m.audio: "<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}"
254 m.video: "<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}"
255 m.location: "<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}"
256 # For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
257 # This has all the Sender variables available under message_formats (but without the .Sender prefix).
258 # Note that you need to manually remove the displayname from message_formats above.
259 displayname_format: "{{ .DisambiguatedName }}"
260
261 # Filter for automatically creating portals.
262 portal_create_filter:
263 # The mode for filtering, either `deny` or `allow`
264 mode: deny
265 # The list of portal IDs to deny or allow depending on the mode config.
266 # Items here can either be the plain portal ID as a string, or an object with `id` and `receiver` fields.
267 # The receiver field is necessary if you want to target a specific DM portal for example.
268 list: []
269 # A list of user login IDs from which to always deny creating portals.
270 # This is meant to be used with default relays, such that the relay bot
271 # being added to a group wouldn't automatically trigger portal creation.
272 always_deny_from_login: []
273
274 # Permissions for using the bridge.
275 # Permitted values:
276 # relay - Talk through the relaybot (if enabled), no access otherwise
277 # commands - Access to use commands in the bridge, but not login.
278 # user - Access to use the bridge with puppeting.
279 # admin - Full access, user level with some additional administration tools.
280 # Permitted keys:
281 # * - All Matrix users
282 # domain - All users on that homeserver
283 # mxid - Specific user
284 permissions:
285 "*": relay
286 "example.com": user
287 "@admin:example.com": admin
288
289# Config for the bridge's database.
290database:
291 # The database type. "sqlite3-fk-wal" and "postgres" are supported.
292 type: postgres
293 # The database URI.
294 # SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
295 # https://github.com/mattn/go-sqlite3#connection-string
296 # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
297 # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
298 uri: postgres://user:password@host/database?sslmode=disable
299 # Maximum number of connections.
300 max_open_conns: 5
301 max_idle_conns: 1
302 # Maximum connection idle time and lifetime before they're closed. Disabled if null.
303 # Parsed with https://pkg.go.dev/time#ParseDuration
304 max_conn_idle_time: null
305 max_conn_lifetime: null
306
307# Homeserver details.
308homeserver:
309 # The address that this appservice can use to connect to the homeserver.
310 # Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
311 # but https also works if they run on different machines.
312 address: http://example.localhost:8008
313 # The domain of the homeserver (also known as server_name, used for MXIDs, etc).
314 domain: example.com
315
316 # What software is the homeserver running?
317 # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
318 software: standard
319 # The URL to push real-time bridge status to.
320 # If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
321 # The bridge will use the appservice as_token to authorize requests.
322 status_endpoint:
323 # Endpoint for reporting per-message status.
324 # If set, the bridge will make POST requests to this URL when processing a message from Matrix.
325 # It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
326 # (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
327 # The bridge will use the appservice as_token to authorize requests.
328 message_send_checkpoint_endpoint:
329 # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
330 async_media: false
331
332 # Should the bridge use a websocket for connecting to the homeserver?
333 # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
334 # mautrix-asmux (deprecated), and hungryserv (proprietary).
335 websocket: false
336 # How often should the websocket be pinged? Pinging will be disabled if this is zero.
337 ping_interval_seconds: 0
338
339# Application service host/registration related details.
340# Changing these values requires regeneration of the registration (except when noted otherwise)
341appservice:
342 # The address that the homeserver can use to connect to this appservice.
343 # Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
344 # If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
345 # If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
346 address: http://localhost:29318
347 # A public address that external services can use to reach this appservice.
348 # This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
349 # This value doesn't affect the registration file.
350 public_address: https://bridge.example.com
351
352 # The hostname and port where this appservice should listen.
353 # For Docker, you generally have to change the hostname to 0.0.0.0.
354 hostname: 127.0.0.1
355 port: 29318
356
357 # The unique ID of this appservice.
358 id: whatsapp
359 # Appservice bot details.
360 bot:
361 # Username of the appservice bot.
362 username: whatsappbot
363 # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
364 # to leave display name/avatar as-is.
365 displayname: WhatsApp bridge bot
366 avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
367
368 # Whether to receive ephemeral events via appservice transactions.
369 ephemeral_events: true
370 # Should incoming events be handled asynchronously?
371 # This may be necessary for large public instances with lots of messages going through.
372 # However, messages will not be guaranteed to be bridged in the same order they were sent in.
373 # This value doesn't affect the registration file.
374 async_transactions: false
375
376 # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
377 as_token: "This value is generated when generating the registration"
378 hs_token: "This value is generated when generating the registration"
379
380 # Localpart template of MXIDs for remote users.
381 # {{.}} is replaced with the internal ID of the user.
382 username_template: whatsapp_{{.}}
383
384# Config options that affect the Matrix connector of the bridge.
385matrix:
386 # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
387 message_status_events: false
388 # Whether the bridge should send a read receipt after successfully bridging a message.
389 delivery_receipts: false
390 # Whether the bridge should send error notices via m.notice events when a message fails to bridge.
391 message_error_notices: true
392 # Whether the bridge should update the m.direct account data event when double puppeting is enabled.
393 sync_direct_chat_list: true
394 # Whether created rooms should have federation enabled. If false, created portal rooms
395 # will never be federated. Changing this option requires recreating rooms.
396 federate_rooms: true
397 # The threshold as bytes after which the bridge should roundtrip uploads via the disk
398 # rather than keeping the whole file in memory.
399 upload_file_threshold: 5242880
400 # Should the bridge set additional custom profile info for ghosts?
401 # This can make a lot of requests, as there's no batch profile update endpoint.
402 ghost_extra_profile_info: false
403
404# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
405analytics:
406 # API key to send with tracking requests. Tracking is disabled if this is null.
407 token: null
408 # Address to send tracking requests to.
409 url: https://api.segment.io/v1/track
410 # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
411 user_id: null
412
413# Settings for provisioning API
414provisioning:
415 # Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
416 # or if set to "disable", the provisioning API will be disabled. Must be at least 16 characters.
417 shared_secret: generate
418 # Whether to allow provisioning API requests to be authed using Matrix access tokens.
419 # This follows the same rules as double puppeting to determine which server to contact to check the token,
420 # which means that by default, it only works for users on the same server as the bridge.
421 allow_matrix_auth: true
422 # Enable debug API at /debug with provisioning authentication.
423 debug_endpoints: false
424 # Enable session transfers between bridges. Note that this only validates Matrix or shared secret
425 # auth before passing live network client credentials down in the response.
426 enable_session_transfers: false
427
428# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
429# These settings control whether the bridge will provide such public media access.
430public_media:
431 # Should public media be enabled at all?
432 # The public_address field under the appservice section MUST be set when enabling public media.
433 enabled: false
434 # A key for signing public media URLs.
435 # If set to "generate", a random key will be generated.
436 signing_key: generate
437 # Number of seconds that public media URLs are valid for.
438 # If set to 0, URLs will never expire.
439 expiry: 0
440 # Length of hash to use for public media URLs. Must be between 0 and 32.
441 hash_length: 32
442 # The path prefix for generated URLs. Note that this will NOT change the path where media is actually served.
443 # If you change this, you must configure your reverse proxy to rewrite the path accordingly.
444 path_prefix: /_mautrix/publicmedia
445 # Should the bridge store media metadata in the database in order to support encrypted media and generate shorter URLs?
446 # If false, the generated URLs will just have the MXC URI and a HMAC signature.
447 # The hash_length field will be used to decide the length of the generated URL.
448 # This also allows invalidating URLs by deleting the database entry.
449 use_database: false
450
451# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
452# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
453direct_media:
454 # Should custom mxc:// URIs be used instead of reuploading media?
455 enabled: false
456 # The server name to use for the custom mxc:// URIs.
457 # This server name will effectively be a real Matrix server, it just won't implement anything other than media.
458 # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
459 server_name: discord-media.example.com
460 # Optionally a custom .well-known response. This defaults to `server_name:443`
461 well_known_response:
462 # Optionally specify a custom prefix for the media ID part of the MXC URI.
463 media_id_prefix:
464 # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
465 # media download redirects if the requester supports it. Optionally, you can force redirects
466 # and not allow proxying at all by setting this to false.
467 # This option does nothing if the remote network does not support media downloads over HTTP.
468 allow_proxy: true
469 # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
470 # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
471 server_key: generate
472
473# Settings for backfilling messages.
474# Note that the exact way settings are applied depends on the network connector.
475# See https://docs.mau.fi/bridges/general/backfill.html for more details.
476backfill:
477 # Whether to do backfilling at all.
478 enabled: false
479 # Maximum number of messages to backfill in empty rooms.
480 # If this is zero or negative, backfill will be disabled in new rooms.
481 max_initial_messages: 50
482 # Maximum number of missed messages to backfill after bridge restarts.
483 max_catchup_messages: 500
484 # If a backfilled chat is older than this number of hours,
485 # mark it as read even if it's unread on the remote network.
486 unread_hours_threshold: 720
487 # Settings for backfilling threads within other backfills.
488 threads:
489 # Maximum number of messages to backfill in a new thread.
490 max_initial_messages: 50
491 # Settings for the backwards backfill queue. This only applies when connecting to
492 # Beeper as standard Matrix servers don't support inserting messages into history.
493 queue:
494 # Should the backfill queue be enabled?
495 enabled: false
496 # Should manual calls to backfill queue tasks be allowed?
497 manual: false
498 # Number of messages to backfill in one batch.
499 batch_size: 100
500 # Delay between batches in seconds.
501 batch_delay: 20
502 # Maximum number of batches to backfill per portal.
503 # If set to -1, all available messages will be backfilled.
504 max_batches: -1
505 # Optional network-specific overrides for max batches.
506 # Interpretation of this field depends on the network connector.
507 max_batches_override: {}
508
509# Settings for enabling double puppeting
510double_puppet:
511 # Servers to always allow double puppeting from.
512 # This is only for other servers and should NOT contain the server the bridge is on.
513 servers:
514 anotherserver.example.org: https://matrix.anotherserver.example.org
515 # Whether to allow client API URL discovery for other servers. When using this option,
516 # users on other servers can use double puppeting even if their server URLs aren't
517 # explicitly added to the servers map above.
518 allow_discovery: false
519 # Shared secrets for automatic double puppeting.
520 # See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
521 secrets:
522 example.com: as_token:foobar
523
524# End-to-bridge encryption support options.
525#
526# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
527encryption:
528 # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
529 allow: false
530 # Whether to force-enable encryption in all bridged rooms.
531 default: false
532 # Whether to require all messages to be encrypted and drop any unencrypted messages.
533 require: false
534 # Whether to use MSC3202/MSC4203 instead of /sync long polling for receiving encryption-related data.
535 # This is an experimental option, see the docs for more info.
536 # Changing this option requires updating the appservice registration file.
537 appservice: false
538 # Whether to use MSC4190 instead of appservice login to create the bridge bot device.
539 # Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
540 # Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
541 msc4190: false
542 # Whether to encrypt reactions and reply metadata as per MSC4392.
543 # This is not supported by most clients.
544 msc4392: false
545 # Should the bridge bot generate a recovery key and cross-signing keys and verify itself?
546 # Note that without the latest version of MSC4190, this will fail if you reset the bridge database.
547 # The generated recovery key will be saved in the kv_store table under `recovery_key`.
548 self_sign: false
549 # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
550 # You must use a client that supports requesting keys from other users to use this feature.
551 allow_key_sharing: true
552 # Pickle key for encrypting encryption keys in the bridge database.
553 # If set to generate, a random key will be generated.
554 pickle_key: generate
555 # Options for deleting megolm sessions from the bridge.
556 delete_keys:
557 # Beeper-specific: delete outbound sessions when hungryserv confirms
558 # that the user has uploaded the key to key backup.
559 delete_outbound_on_ack: false
560 # Don't store outbound sessions in the inbound table.
561 dont_store_outbound: false
562 # Ratchet megolm sessions forward after decrypting messages.
563 ratchet_on_decrypt: false
564 # Delete fully used keys (index >= max_messages) after decrypting messages.
565 delete_fully_used_on_decrypt: false
566 # Delete previous megolm sessions from same device when receiving a new one.
567 delete_prev_on_new_session: false
568 # Delete megolm sessions received from a device when the device is deleted.
569 delete_on_device_delete: false
570 # Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
571 periodically_delete_expired: false
572 # Delete inbound megolm sessions that don't have the received_at field used for
573 # automatic ratcheting and expired session deletion. This is meant as a migration
574 # to delete old keys prior to the bridge update.
575 delete_outdated_inbound: false
576 # What level of device verification should be required from users?
577 #
578 # Valid levels:
579 # unverified - Send keys to all device in the room.
580 # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
581 # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
582 # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
583 # Note that creating user signatures from the bridge bot is not currently possible.
584 # verified - Require manual per-device verification
585 # (currently only possible by modifying the `trust` column in the `crypto_device` database table).
586 verification_levels:
587 # Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
588 receive: unverified
589 # Minimum level that the bridge should accept for incoming Matrix messages.
590 send: unverified
591 # Minimum level that the bridge should require for accepting key requests.
592 share: cross-signed-tofu
593 # Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
594 # See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
595 rotation:
596 # Enable custom Megolm room key rotation settings. Note that these
597 # settings will only apply to rooms created after this option is set.
598 enable_custom: false
599 # The maximum number of milliseconds a session should be used
600 # before changing it. The Matrix spec recommends 604800000 (a week)
601 # as the default.
602 milliseconds: 604800000
603 # The maximum number of messages that should be sent with a given a
604 # session before changing it. The Matrix spec recommends 100 as the
605 # default.
606 messages: 100
607 # Disable rotating keys when a user's devices change?
608 # You should not enable this option unless you understand all the implications.
609 disable_device_change_key_rotation: false
610
611# Prefix for environment variables. All variables with this prefix must map to valid config fields.
612# Nesting in variable names is represented with a dot (.).
613# If there are no dots in the name, two underscores (__) are replaced with a dot.
614#
615# e.g. if the prefix is set to `BRIDGE_`, then `BRIDGE_APPSERVICE__AS_TOKEN` will set appservice.as_token.
616# `BRIDGE_appservice.as_token` would work as well, but can't be set in a shell as easily.
617#
618# If this is null, reading config fields from environment will be disabled.
619env_config_prefix: null
620
621# Logging config. See https://github.com/tulir/zeroconfig for details.
622logging:
623 min_level: debug
624 writers:
625 - type: stdout
626 format: pretty-colored
627 - type: file
628 format: json
629 filename: ./logs/bridge.log
630 max_size: 100
631 max_backups: 10
632 compress: false