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