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