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