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