Raw YAML

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