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