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