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