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