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