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