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
76 # What should be done to portal rooms when a user logs out or is logged out?
77 # Permitted values:
78 # nothing - Do nothing, let the user stay in the portals
79 # kick - Remove the user from the portal rooms, but don't delete them
80 # unbridge - Remove all ghosts in the room and disassociate it from the remote chat
81 # delete - Remove all ghosts and users from the room (i.e. delete it)
82 cleanup_on_logout:
83 # Should cleanup on logout be enabled at all?
84 enabled: false
85 # Settings for manual logouts (explicitly initiated by the Matrix user)
86 manual:
87 # Action for private portals which will never be shared with other Matrix users.
88 private: nothing
89 # Action for portals with a relay user configured.
90 relayed: nothing
91 # Action for portals which may be shared, but don't currently have any other Matrix users.
92 shared_no_users: nothing
93 # Action for portals which have other logged-in Matrix users.
94 shared_has_users: nothing
95 # Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
96 # Keys have the same meanings as in the manual section.
97 bad_credentials:
98 private: nothing
99 relayed: nothing
100 shared_no_users: nothing
101 shared_has_users: nothing
102
103 # Settings for relay mode
104 relay:
105 # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
106 # authenticated user into a relaybot for that chat.
107 enabled: false
108 # Should only admins be allowed to set themselves as relay users?
109 # If true, non-admins can only set users listed in default_relays as relays in a room.
110 admin_only: true
111 # List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
112 default_relays: []
113 # The formats to use when sending messages via the relaybot.
114 # Available variables:
115 # .Sender.UserID - The Matrix user ID of the sender.
116 # .Sender.Displayname - The display name of the sender (if set).
117 # .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
118 # .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
119 # plus the user ID in parentheses if the displayname is not unique.
120 # If the displayname is not set, this is just the user ID.
121 # .Message - The `formatted_body` field of the message.
122 # .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
123 # .FileName - The name of the file being sent.
124 message_formats:
125 m.text: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
126 m.notice: "<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}"
127 m.emote: "* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}"
128 m.file: "<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}"
129 m.image: "<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}"
130 m.audio: "<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}"
131 m.video: "<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}"
132 m.location: "<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}"
133 # For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
134 # This has all the Sender variables available under message_formats (but without the .Sender prefix).
135 # Note that you need to manually remove the displayname from message_formats above.
136 displayname_format: "{{ .DisambiguatedName }}"
137
138 # Permissions for using the bridge.
139 # Permitted values:
140 # relay - Talk through the relaybot (if enabled), no access otherwise
141 # commands - Access to use commands in the bridge, but not login.
142 # user - Access to use the bridge with puppeting.
143 # admin - Full access, user level with some additional administration tools.
144 # Permitted keys:
145 # * - All Matrix users
146 # domain - All users on that homeserver
147 # mxid - Specific user
148 permissions:
149 "*": relay
150 "example.com": user
151 "@admin:example.com": admin
152
153# Config for the bridge's database.
154database:
155 # The database type. "sqlite3-fk-wal" and "postgres" are supported.
156 type: postgres
157 # The database URI.
158 # SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
159 # https://github.com/mattn/go-sqlite3#connection-string
160 # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
161 # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
162 uri: postgres://user:password@host/database?sslmode=disable
163 # Maximum number of connections.
164 max_open_conns: 5
165 max_idle_conns: 1
166 # Maximum connection idle time and lifetime before they're closed. Disabled if null.
167 # Parsed with https://pkg.go.dev/time#ParseDuration
168 max_conn_idle_time: null
169 max_conn_lifetime: null
170
171# Homeserver details.
172homeserver:
173 # The address that this appservice can use to connect to the homeserver.
174 # Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
175 # but https also works if they run on different machines.
176 address: http://example.localhost:8008
177 # The domain of the homeserver (also known as server_name, used for MXIDs, etc).
178 domain: example.com
179
180 # What software is the homeserver running?
181 # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
182 software: standard
183 # The URL to push real-time bridge status to.
184 # If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
185 # The bridge will use the appservice as_token to authorize requests.
186 status_endpoint:
187 # Endpoint for reporting per-message status.
188 # If set, the bridge will make POST requests to this URL when processing a message from Matrix.
189 # It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
190 # (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
191 # The bridge will use the appservice as_token to authorize requests.
192 message_send_checkpoint_endpoint:
193 # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
194 async_media: false
195
196 # Should the bridge use a websocket for connecting to the homeserver?
197 # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
198 # mautrix-asmux (deprecated), and hungryserv (proprietary).
199 websocket: false
200 # How often should the websocket be pinged? Pinging will be disabled if this is zero.
201 ping_interval_seconds: 0
202
203# Application service host/registration related details.
204# Changing these values requires regeneration of the registration (except when noted otherwise)
205appservice:
206 # The address that the homeserver can use to connect to this appservice.
207 # Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
208 # If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
209 # If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
210 address: http://localhost:29336
211 # A public address that external services can use to reach this appservice.
212 # This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
213 # This value doesn't affect the registration file.
214 public_address: https://bridge.example.com
215
216 # The hostname and port where this appservice should listen.
217 # For Docker, you generally have to change the hostname to 0.0.0.0.
218 hostname: 127.0.0.1
219 port: 29336
220
221 # The unique ID of this appservice.
222 id: gmessages
223 # Appservice bot details.
224 bot:
225 # Username of the appservice bot.
226 username: gmessagesbot
227 # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
228 # to leave display name/avatar as-is.
229 displayname: Google Messages bridge bot
230 avatar: mxc://maunium.net/yGOdcrJcwqARZqdzbfuxfhzb
231
232 # Whether to receive ephemeral events via appservice transactions.
233 ephemeral_events: true
234 # Should incoming events be handled asynchronously?
235 # This may be necessary for large public instances with lots of messages going through.
236 # However, messages will not be guaranteed to be bridged in the same order they were sent in.
237 # This value doesn't affect the registration file.
238 async_transactions: false
239
240 # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
241 as_token: "This value is generated when generating the registration"
242 hs_token: "This value is generated when generating the registration"
243
244 # Localpart template of MXIDs for remote users.
245 # {{.}} is replaced with the internal ID of the user.
246 username_template: gmessages_{{.}}
247
248# Config options that affect the Matrix connector of the bridge.
249matrix:
250 # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
251 message_status_events: false
252 # Whether the bridge should send a read receipt after successfully bridging a message.
253 delivery_receipts: false
254 # Whether the bridge should send error notices via m.notice events when a message fails to bridge.
255 message_error_notices: true
256 # Whether the bridge should update the m.direct account data event when double puppeting is enabled.
257 sync_direct_chat_list: true
258 # Whether created rooms should have federation enabled. If false, created portal rooms
259 # will never be federated. Changing this option requires recreating rooms.
260 federate_rooms: true
261 # The threshold as bytes after which the bridge should roundtrip uploads via the disk
262 # rather than keeping the whole file in memory.
263 upload_file_threshold: 5242880
264
265# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
266analytics:
267 # API key to send with tracking requests. Tracking is disabled if this is null.
268 token: null
269 # Address to send tracking requests to.
270 url: https://api.segment.io/v1/track
271 # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
272 user_id: null
273
274# Settings for provisioning API
275provisioning:
276 # Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
277 # or if set to "disable", the provisioning API will be disabled. Must be at least 16 characters.
278 shared_secret: generate
279 # Whether to allow provisioning API requests to be authed using Matrix access tokens.
280 # This follows the same rules as double puppeting to determine which server to contact to check the token,
281 # which means that by default, it only works for users on the same server as the bridge.
282 allow_matrix_auth: true
283 # Enable debug API at /debug with provisioning authentication.
284 debug_endpoints: false
285 # Enable session transfers between bridges. Note that this only validates Matrix or shared secret
286 # auth before passing live network client credentials down in the response.
287 enable_session_transfers: false
288
289# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
290# These settings control whether the bridge will provide such public media access.
291public_media:
292 # Should public media be enabled at all?
293 # The public_address field under the appservice section MUST be set when enabling public media.
294 enabled: false
295 # A key for signing public media URLs.
296 # If set to "generate", a random key will be generated.
297 signing_key: generate
298 # Number of seconds that public media URLs are valid for.
299 # If set to 0, URLs will never expire.
300 expiry: 0
301 # Length of hash to use for public media URLs. Must be between 0 and 32.
302 hash_length: 32
303
304# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
305# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
306direct_media:
307 # Should custom mxc:// URIs be used instead of reuploading media?
308 enabled: false
309 # The server name to use for the custom mxc:// URIs.
310 # This server name will effectively be a real Matrix server, it just won't implement anything other than media.
311 # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
312 server_name: discord-media.example.com
313 # Optionally a custom .well-known response. This defaults to `server_name:443`
314 well_known_response:
315 # Optionally specify a custom prefix for the media ID part of the MXC URI.
316 media_id_prefix:
317 # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
318 # media download redirects if the requester supports it. Optionally, you can force redirects
319 # and not allow proxying at all by setting this to false.
320 # This option does nothing if the remote network does not support media downloads over HTTP.
321 allow_proxy: true
322 # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
323 # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
324 server_key: generate
325
326# Settings for backfilling messages.
327# Note that the exact way settings are applied depends on the network connector.
328# See https://docs.mau.fi/bridges/general/backfill.html for more details.
329backfill:
330 # Whether to do backfilling at all.
331 enabled: false
332 # Maximum number of messages to backfill in empty rooms.
333 max_initial_messages: 50
334 # Maximum number of missed messages to backfill after bridge restarts.
335 max_catchup_messages: 500
336 # If a backfilled chat is older than this number of hours,
337 # mark it as read even if it's unread on the remote network.
338 unread_hours_threshold: 720
339 # Settings for backfilling threads within other backfills.
340 threads:
341 # Maximum number of messages to backfill in a new thread.
342 max_initial_messages: 50
343 # Settings for the backwards backfill queue. This only applies when connecting to
344 # Beeper as standard Matrix servers don't support inserting messages into history.
345 queue:
346 # Should the backfill queue be enabled?
347 enabled: false
348 # Number of messages to backfill in one batch.
349 batch_size: 100
350 # Delay between batches in seconds.
351 batch_delay: 20
352 # Maximum number of batches to backfill per portal.
353 # If set to -1, all available messages will be backfilled.
354 max_batches: -1
355 # Optional network-specific overrides for max batches.
356 # Interpretation of this field depends on the network connector.
357 max_batches_override: {}
358
359# Settings for enabling double puppeting
360double_puppet:
361 # Servers to always allow double puppeting from.
362 # This is only for other servers and should NOT contain the server the bridge is on.
363 servers:
364 anotherserver.example.org: https://matrix.anotherserver.example.org
365 # Whether to allow client API URL discovery for other servers. When using this option,
366 # users on other servers can use double puppeting even if their server URLs aren't
367 # explicitly added to the servers map above.
368 allow_discovery: false
369 # Shared secrets for automatic double puppeting.
370 # See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
371 secrets:
372 example.com: as_token:foobar
373
374# End-to-bridge encryption support options.
375#
376# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
377encryption:
378 # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
379 allow: false
380 # Whether to force-enable encryption in all bridged rooms.
381 default: false
382 # Whether to require all messages to be encrypted and drop any unencrypted messages.
383 require: false
384 # Whether to use MSC3202/MSC4203 instead of /sync long polling for receiving encryption-related data.
385 # This option is not yet compatible with standard Matrix servers like Synapse and should not be used.
386 # Changing this option requires updating the appservice registration file.
387 appservice: false
388 # Whether to use MSC4190 instead of appservice login to create the bridge bot device.
389 # Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
390 # Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
391 # Changing this option requires updating the appservice registration file.
392 msc4190: 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# Logging config. See https://github.com/tulir/zeroconfig for details.
460logging:
461 min_level: debug
462 writers:
463 - type: stdout
464 format: pretty-colored
465 - type: file
466 format: json
467 filename: ./logs/bridge.log
468 max_size: 100
469 max_backups: 10
470 compress: false