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