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