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