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