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