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