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