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