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