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