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