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