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
127
128# Config options that affect the central bridge module.
129bridge:
130 # The prefix for commands. Only required in non-management rooms.
131 command_prefix: '!wa'
132 # Should the bridge create a space for each login containing the rooms that account is in?
133 personal_filtering_spaces: true
134 # Whether the bridge should set names and avatars explicitly for DM portals.
135 # This is only necessary when using clients that don't support MSC4171.
136 private_chat_portal_meta: true
137 # Should events be handled asynchronously within portal rooms?
138 # If true, events may end up being out of order, but slow events won't block other ones.
139 # This is not yet safe to use.
140 async_events: false
141 # Should every user have their own portals rather than sharing them?
142 # By default, users who are in the same group on the remote network will be
143 # in the same Matrix room bridged to that group. If this is set to true,
144 # every user will get their own Matrix room instead.
145 # SETTING THIS IS IRREVERSIBLE AND POTENTIALLY DESTRUCTIVE IF PORTALS ALREADY EXIST.
146 split_portals: false
147 # Should the bridge resend `m.bridge` events to all portals on startup?
148 resend_bridge_info: false
149 # Should `m.bridge` events be sent without a state key?
150 # By default, the bridge uses a unique key that won't conflict with other bridges.
151 no_bridge_info_state_key: false
152 # Should bridge connection status be sent to the management room as `m.notice` events?
153 # These contain the same data that can be posted to an external HTTP server using homeserver -> status_endpoint.
154 # Allowed values: none, errors, all
155 bridge_status_notices: errors
156 # How long after an unknown error should the bridge attempt a full reconnect?
157 # Must be at least 1 minute. The bridge will add an extra ±20% jitter to this value.
158 unknown_error_auto_reconnect: null
159 # Maximum number of times to do the auto-reconnect above.
160 # The counter is per login, but is never reset except on logout and restart.
161 unknown_error_max_auto_reconnects: 10
162
163 # Should leaving Matrix rooms be bridged as leaving groups on the remote network?
164 bridge_matrix_leave: false
165 # Should `m.notice` messages be bridged?
166 bridge_notices: false
167 # Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
168 # Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
169 tag_only_on_create: true
170 # List of tags to allow bridging. If empty, no tags will be bridged.
171 only_bridge_tags: [m.favourite, m.lowpriority]
172 # Should room mute status only be synced when creating the portal?
173 # Like tags, mutes can't currently be synced back to the remote network.
174 mute_only_on_create: true
175 # Should the bridge check the db to ensure that incoming events haven't been handled before
176 deduplicate_matrix_messages: false
177 # Should cross-room reply metadata be bridged?
178 # Most Matrix clients don't support this and servers may reject such messages too.
179 cross_room_replies: false
180 # If a state event fails to bridge, should the bridge revert any state changes made by that event?
181 revert_failed_state_changes: false
182 # In portals with no relay set, should Matrix users be kicked if they're
183 # not logged into an account that's in the remote chat?
184 kick_matrix_users: true
185
186 # What should be done to portal rooms when a user logs out or is logged out?
187 # Permitted values:
188 # nothing - Do nothing, let the user stay in the portals
189 # kick - Remove the user from the portal rooms, but don't delete them
190 # unbridge - Remove all ghosts in the room and disassociate it from the remote chat
191 # delete - Remove all ghosts and users from the room (i.e. delete it)
192 cleanup_on_logout:
193 # Should cleanup on logout be enabled at all?
194 enabled: false
195 # Settings for manual logouts (explicitly initiated by the Matrix user)
196 manual:
197 # Action for private portals which will never be shared with other Matrix users.
198 private: nothing
199 # Action for portals with a relay user configured.
200 relayed: nothing
201 # Action for portals which may be shared, but don't currently have any other Matrix users.
202 shared_no_users: nothing
203 # Action for portals which have other logged-in Matrix users.
204 shared_has_users: nothing
205 # Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
206 # Keys have the same meanings as in the manual section.
207 bad_credentials:
208 private: nothing
209 relayed: nothing
210 shared_no_users: nothing
211 shared_has_users: nothing
212
213 # Settings for relay mode
214 relay:
215 # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
216 # authenticated user into a relaybot for that chat.
217 enabled: false
218 # Should only admins be allowed to set themselves as relay users?
219 # If true, non-admins can only set users listed in default_relays as relays in a room.
220 admin_only: true
221 # List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
222 default_relays: []
223 # The formats to use when sending messages via the relaybot.
224 # Available variables:
225 # .Sender.UserID - The Matrix user ID of the sender.
226 # .Sender.Displayname - The display name of the sender (if set).
227 # .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
228 # .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
229 # plus the user ID in parentheses if the displayname is not unique.
230 # If the displayname is not set, this is just the user ID.
231 # .Message - The `formatted_body` field of the message.
232 # .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
233 # .FileName - The name of the file being sent.
234 message_formats:
235 m.text: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
236 m.notice: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
237 m.emote: "* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}"
238 m.file: "<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}"
239 m.image: "<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}"
240 m.audio: "<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}"
241 m.video: "<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}"
242 m.location: "<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}"
243 # For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
244 # This has all the Sender variables available under message_formats (but without the .Sender prefix).
245 # Note that you need to manually remove the displayname from message_formats above.
246 displayname_format: "{{ .DisambiguatedName }}"
247
248 # Permissions for using the bridge.
249 # Permitted values:
250 # relay - Talk through the relaybot (if enabled), no access otherwise
251 # commands - Access to use commands in the bridge, but not login.
252 # user - Access to use the bridge with puppeting.
253 # admin - Full access, user level with some additional administration tools.
254 # Permitted keys:
255 # * - All Matrix users
256 # domain - All users on that homeserver
257 # mxid - Specific user
258 permissions:
259 "*": relay
260 "example.com": user
261 "@admin:example.com": admin
262
263# Config for the bridge's database.
264database:
265 # The database type. "sqlite3-fk-wal" and "postgres" are supported.
266 type: postgres
267 # The database URI.
268 # SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
269 # https://github.com/mattn/go-sqlite3#connection-string
270 # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
271 # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
272 uri: postgres://user:password@host/database?sslmode=disable
273 # Maximum number of connections.
274 max_open_conns: 5
275 max_idle_conns: 1
276 # Maximum connection idle time and lifetime before they're closed. Disabled if null.
277 # Parsed with https://pkg.go.dev/time#ParseDuration
278 max_conn_idle_time: null
279 max_conn_lifetime: null
280
281# Homeserver details.
282homeserver:
283 # The address that this appservice can use to connect to the homeserver.
284 # Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
285 # but https also works if they run on different machines.
286 address: http://example.localhost:8008
287 # The domain of the homeserver (also known as server_name, used for MXIDs, etc).
288 domain: example.com
289
290 # What software is the homeserver running?
291 # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
292 software: standard
293 # The URL to push real-time bridge status to.
294 # If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
295 # The bridge will use the appservice as_token to authorize requests.
296 status_endpoint:
297 # Endpoint for reporting per-message status.
298 # If set, the bridge will make POST requests to this URL when processing a message from Matrix.
299 # It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
300 # (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
301 # The bridge will use the appservice as_token to authorize requests.
302 message_send_checkpoint_endpoint:
303 # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
304 async_media: false
305
306 # Should the bridge use a websocket for connecting to the homeserver?
307 # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
308 # mautrix-asmux (deprecated), and hungryserv (proprietary).
309 websocket: false
310 # How often should the websocket be pinged? Pinging will be disabled if this is zero.
311 ping_interval_seconds: 0
312
313# Application service host/registration related details.
314# Changing these values requires regeneration of the registration (except when noted otherwise)
315appservice:
316 # The address that the homeserver can use to connect to this appservice.
317 # Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
318 # If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
319 # If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
320 address: http://localhost:29318
321 # A public address that external services can use to reach this appservice.
322 # This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
323 # This value doesn't affect the registration file.
324 public_address: https://bridge.example.com
325
326 # The hostname and port where this appservice should listen.
327 # For Docker, you generally have to change the hostname to 0.0.0.0.
328 hostname: 127.0.0.1
329 port: 29318
330
331 # The unique ID of this appservice.
332 id: whatsapp
333 # Appservice bot details.
334 bot:
335 # Username of the appservice bot.
336 username: whatsappbot
337 # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
338 # to leave display name/avatar as-is.
339 displayname: WhatsApp bridge bot
340 avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
341
342 # Whether to receive ephemeral events via appservice transactions.
343 ephemeral_events: true
344 # Should incoming events be handled asynchronously?
345 # This may be necessary for large public instances with lots of messages going through.
346 # However, messages will not be guaranteed to be bridged in the same order they were sent in.
347 # This value doesn't affect the registration file.
348 async_transactions: false
349
350 # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
351 as_token: "This value is generated when generating the registration"
352 hs_token: "This value is generated when generating the registration"
353
354 # Localpart template of MXIDs for remote users.
355 # {{.}} is replaced with the internal ID of the user.
356 username_template: whatsapp_{{.}}
357
358# Config options that affect the Matrix connector of the bridge.
359matrix:
360 # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
361 message_status_events: false
362 # Whether the bridge should send a read receipt after successfully bridging a message.
363 delivery_receipts: false
364 # Whether the bridge should send error notices via m.notice events when a message fails to bridge.
365 message_error_notices: true
366 # Whether the bridge should update the m.direct account data event when double puppeting is enabled.
367 sync_direct_chat_list: true
368 # Whether created rooms should have federation enabled. If false, created portal rooms
369 # will never be federated. Changing this option requires recreating rooms.
370 federate_rooms: true
371 # The threshold as bytes after which the bridge should roundtrip uploads via the disk
372 # rather than keeping the whole file in memory.
373 upload_file_threshold: 5242880
374 # Should the bridge set additional custom profile info for ghosts?
375 # This can make a lot of requests, as there's no batch profile update endpoint.
376 ghost_extra_profile_info: false
377
378# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
379analytics:
380 # API key to send with tracking requests. Tracking is disabled if this is null.
381 token: null
382 # Address to send tracking requests to.
383 url: https://api.segment.io/v1/track
384 # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
385 user_id: null
386
387# Settings for provisioning API
388provisioning:
389 # Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
390 # or if set to "disable", the provisioning API will be disabled. Must be at least 16 characters.
391 shared_secret: generate
392 # Whether to allow provisioning API requests to be authed using Matrix access tokens.
393 # This follows the same rules as double puppeting to determine which server to contact to check the token,
394 # which means that by default, it only works for users on the same server as the bridge.
395 allow_matrix_auth: true
396 # Enable debug API at /debug with provisioning authentication.
397 debug_endpoints: false
398 # Enable session transfers between bridges. Note that this only validates Matrix or shared secret
399 # auth before passing live network client credentials down in the response.
400 enable_session_transfers: false
401
402# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
403# These settings control whether the bridge will provide such public media access.
404public_media:
405 # Should public media be enabled at all?
406 # The public_address field under the appservice section MUST be set when enabling public media.
407 enabled: false
408 # A key for signing public media URLs.
409 # If set to "generate", a random key will be generated.
410 signing_key: generate
411 # Number of seconds that public media URLs are valid for.
412 # If set to 0, URLs will never expire.
413 expiry: 0
414 # Length of hash to use for public media URLs. Must be between 0 and 32.
415 hash_length: 32
416 # The path prefix for generated URLs. Note that this will NOT change the path where media is actually served.
417 # If you change this, you must configure your reverse proxy to rewrite the path accordingly.
418 path_prefix: /_mautrix/publicmedia
419 # Should the bridge store media metadata in the database in order to support encrypted media and generate shorter URLs?
420 # If false, the generated URLs will just have the MXC URI and a HMAC signature.
421 # The hash_length field will be used to decide the length of the generated URL.
422 # This also allows invalidating URLs by deleting the database entry.
423 use_database: false
424
425# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
426# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
427direct_media:
428 # Should custom mxc:// URIs be used instead of reuploading media?
429 enabled: false
430 # The server name to use for the custom mxc:// URIs.
431 # This server name will effectively be a real Matrix server, it just won't implement anything other than media.
432 # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
433 server_name: discord-media.example.com
434 # Optionally a custom .well-known response. This defaults to `server_name:443`
435 well_known_response:
436 # Optionally specify a custom prefix for the media ID part of the MXC URI.
437 media_id_prefix:
438 # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
439 # media download redirects if the requester supports it. Optionally, you can force redirects
440 # and not allow proxying at all by setting this to false.
441 # This option does nothing if the remote network does not support media downloads over HTTP.
442 allow_proxy: true
443 # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
444 # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
445 server_key: generate
446
447# Settings for backfilling messages.
448# Note that the exact way settings are applied depends on the network connector.
449# See https://docs.mau.fi/bridges/general/backfill.html for more details.
450backfill:
451 # Whether to do backfilling at all.
452 enabled: false
453 # Maximum number of messages to backfill in empty rooms.
454 max_initial_messages: 50
455 # Maximum number of missed messages to backfill after bridge restarts.
456 max_catchup_messages: 500
457 # If a backfilled chat is older than this number of hours,
458 # mark it as read even if it's unread on the remote network.
459 unread_hours_threshold: 720
460 # Settings for backfilling threads within other backfills.
461 threads:
462 # Maximum number of messages to backfill in a new thread.
463 max_initial_messages: 50
464 # Settings for the backwards backfill queue. This only applies when connecting to
465 # Beeper as standard Matrix servers don't support inserting messages into history.
466 queue:
467 # Should the backfill queue be enabled?
468 enabled: false
469 # Number of messages to backfill in one batch.
470 batch_size: 100
471 # Delay between batches in seconds.
472 batch_delay: 20
473 # Maximum number of batches to backfill per portal.
474 # If set to -1, all available messages will be backfilled.
475 max_batches: -1
476 # Optional network-specific overrides for max batches.
477 # Interpretation of this field depends on the network connector.
478 max_batches_override: {}
479
480# Settings for enabling double puppeting
481double_puppet:
482 # Servers to always allow double puppeting from.
483 # This is only for other servers and should NOT contain the server the bridge is on.
484 servers:
485 anotherserver.example.org: https://matrix.anotherserver.example.org
486 # Whether to allow client API URL discovery for other servers. When using this option,
487 # users on other servers can use double puppeting even if their server URLs aren't
488 # explicitly added to the servers map above.
489 allow_discovery: false
490 # Shared secrets for automatic double puppeting.
491 # See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
492 secrets:
493 example.com: as_token:foobar
494
495# End-to-bridge encryption support options.
496#
497# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
498encryption:
499 # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
500 allow: false
501 # Whether to force-enable encryption in all bridged rooms.
502 default: false
503 # Whether to require all messages to be encrypted and drop any unencrypted messages.
504 require: false
505 # Whether to use MSC3202/MSC4203 instead of /sync long polling for receiving encryption-related data.
506 # This option is not yet compatible with standard Matrix servers like Synapse and should not be used.
507 # Changing this option requires updating the appservice registration file.
508 appservice: false
509 # Whether to use MSC4190 instead of appservice login to create the bridge bot device.
510 # Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
511 # Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
512 # Changing this option requires updating the appservice registration file.
513 msc4190: false
514 # Whether to encrypt reactions and reply metadata as per MSC4392.
515 msc4392: false
516 # Should the bridge bot generate a recovery key and cross-signing keys and verify itself?
517 # Note that without the latest version of MSC4190, this will fail if you reset the bridge database.
518 # The generated recovery key will be saved in the kv_store table under `recovery_key`.
519 self_sign: false
520 # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
521 # You must use a client that supports requesting keys from other users to use this feature.
522 allow_key_sharing: true
523 # Pickle key for encrypting encryption keys in the bridge database.
524 # If set to generate, a random key will be generated.
525 pickle_key: generate
526 # Options for deleting megolm sessions from the bridge.
527 delete_keys:
528 # Beeper-specific: delete outbound sessions when hungryserv confirms
529 # that the user has uploaded the key to key backup.
530 delete_outbound_on_ack: false
531 # Don't store outbound sessions in the inbound table.
532 dont_store_outbound: false
533 # Ratchet megolm sessions forward after decrypting messages.
534 ratchet_on_decrypt: false
535 # Delete fully used keys (index >= max_messages) after decrypting messages.
536 delete_fully_used_on_decrypt: false
537 # Delete previous megolm sessions from same device when receiving a new one.
538 delete_prev_on_new_session: false
539 # Delete megolm sessions received from a device when the device is deleted.
540 delete_on_device_delete: false
541 # Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
542 periodically_delete_expired: false
543 # Delete inbound megolm sessions that don't have the received_at field used for
544 # automatic ratcheting and expired session deletion. This is meant as a migration
545 # to delete old keys prior to the bridge update.
546 delete_outdated_inbound: false
547 # What level of device verification should be required from users?
548 #
549 # Valid levels:
550 # unverified - Send keys to all device in the room.
551 # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
552 # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
553 # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
554 # Note that creating user signatures from the bridge bot is not currently possible.
555 # verified - Require manual per-device verification
556 # (currently only possible by modifying the `trust` column in the `crypto_device` database table).
557 verification_levels:
558 # Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
559 receive: unverified
560 # Minimum level that the bridge should accept for incoming Matrix messages.
561 send: unverified
562 # Minimum level that the bridge should require for accepting key requests.
563 share: cross-signed-tofu
564 # Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
565 # See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
566 rotation:
567 # Enable custom Megolm room key rotation settings. Note that these
568 # settings will only apply to rooms created after this option is set.
569 enable_custom: false
570 # The maximum number of milliseconds a session should be used
571 # before changing it. The Matrix spec recommends 604800000 (a week)
572 # as the default.
573 milliseconds: 604800000
574 # The maximum number of messages that should be sent with a given a
575 # session before changing it. The Matrix spec recommends 100 as the
576 # default.
577 messages: 100
578 # Disable rotating keys when a user's devices change?
579 # You should not enable this option unless you understand all the implications.
580 disable_device_change_key_rotation: false
581
582# Prefix for environment variables. All variables with this prefix must map to valid config fields.
583# Nesting in variable names is represented with a dot (.).
584# If there are no dots in the name, two underscores (__) are replaced with a dot.
585#
586# e.g. if the prefix is set to `BRIDGE_`, then `BRIDGE_APPSERVICE__AS_TOKEN` will set appservice.as_token.
587# `BRIDGE_appservice.as_token` would work as well, but can't be set in a shell as easily.
588#
589# If this is null, reading config fields from environment will be disabled.
590env_config_prefix: null
591
592# Logging config. See https://github.com/tulir/zeroconfig for details.
593logging:
594 min_level: debug
595 writers:
596 - type: stdout
597 format: pretty-colored
598 - type: file
599 format: json
600 filename: ./logs/bridge.log
601 max_size: 100
602 max_backups: 10
603 compress: false