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