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