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