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