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