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