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