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