Upgrade mautrix-gmessages (v0.4.3 -> v0.5.0) and adapt configuration

Related to:
- https://github.com/mautrix/gmessages/releases/tag/v0.5.0
- https://mau.fi/blog/2024-09-mautrix-release/

It seems like the new version does not support a `/metrics` endpoint.
We skip keep the Ansible variables, but they're not doing anything.

docs/configuring-playbook-bridge-mautrix-gmessages.md

@@ -14,14 +14,12 @@ matrix_mautrix_gmessages_enabled: true
 
 If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it.
 
-### Method 1: automatically, by enabling Appservice Double Puppet or Shared Secret Auth
+### Method 1: automatically, by enabling Appservice Double Puppet
 
-The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service or the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook.
+The bridge will automatically perform Double Puppeting if you enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook.
 
 Enabling [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future.
 
-Enabling double puppeting by enabling the [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service works at the time of writing, but is deprecated and will stop working in the future.
-
 ### Method 2: manually, by asking each user to provide a working access token
 
 **Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)).

group_vars/matrix_servers

@@ -1798,15 +1798,13 @@ matrix_mautrix_gmessages_appservice_token: "{{ '%s' | format(matrix_homeserver_g
 matrix_mautrix_gmessages_homeserver_address: "{{ matrix_addons_homeserver_client_api_url }}"
 matrix_mautrix_gmessages_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'gmessa.hs.token', rounds=655555) | to_uuid }}"
 
-matrix_mautrix_gmessages_login_shared_secret: |-
+matrix_mautrix_gmessages_double_puppet_secrets_auto: |-
   {{
-    ("as_token:" + matrix_appservice_double_puppet_registration_as_token)
+    {
+      matrix_mautrix_gmessages_homeserver_domain: ("as_token:" + matrix_appservice_double_puppet_registration_as_token)
+    }
     if matrix_appservice_double_puppet_enabled
-    else (
+    else {}
-      matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled
-      if matrix_synapse_ext_password_provider_shared_secret_auth_enabled
-      else ""
-    )
   }}
 
 matrix_mautrix_gmessages_metrics_enabled: "{{ prometheus_enabled or matrix_metrics_exposure_enabled }}"

roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml

@@ -9,7 +9,7 @@ matrix_mautrix_gmessages_container_image_self_build_repo: "https://github.com/ma
 matrix_mautrix_gmessages_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_gmessages_version == 'latest' else matrix_mautrix_gmessages_version }}"
 
 # renovate: datasource=docker depName=dock.mau.dev/mautrix/gmessages
-matrix_mautrix_gmessages_version: v0.4.3
+matrix_mautrix_gmessages_version: v0.5.0
 
 # See: https://mau.dev/mautrix/gmessages/container_registry
 matrix_mautrix_gmessages_docker_image: "{{ matrix_mautrix_gmessages_docker_image_name_prefix }}mautrix/gmessages:{{ matrix_mautrix_gmessages_version }}"
@@ -25,6 +25,12 @@ matrix_mautrix_gmessages_homeserver_address: ""
 matrix_mautrix_gmessages_homeserver_domain: "{{ matrix_domain }}"
 matrix_mautrix_gmessages_appservice_address: "http://matrix-mautrix-gmessages:8080"
 
+matrix_mautrix_gmessages_backfill_enabled: false
+matrix_mautrix_gmessages_backfill_max_initial_messages: 50
+matrix_mautrix_gmessages_backfill_max_catchup_messages: 500
+matrix_mautrix_gmessages_backfill_unread_hours_threshold: 720
+matrix_mautrix_gmessages_backfill_threads_max_initial_messages: 50
+
 matrix_mautrix_gmessages_command_prefix: "!gm"
 
 matrix_mautrix_gmessages_container_network: ""
@@ -132,18 +138,23 @@ matrix_mautrix_gmessages_appservice_database_uri: "{{
 	}[matrix_mautrix_gmessages_database_engine]
 }}"
 
-# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth) or Appservice Double Puppet.
+matrix_mautrix_gmessages_double_puppet_secrets: "{{ matrix_mautrix_gmessages_double_puppet_secrets_auto | combine(matrix_mautrix_gmessages_double_puppet_secrets_custom) }}"
-matrix_mautrix_gmessages_login_shared_secret: ''
+matrix_mautrix_gmessages_double_puppet_secrets_auto: {}
-matrix_mautrix_gmessages_bridge_login_shared_secret_map:
+matrix_mautrix_gmessages_double_puppet_secrets_custom: {}
-  "{{ {matrix_mautrix_gmessages_homeserver_domain: matrix_mautrix_gmessages_login_shared_secret} if matrix_mautrix_gmessages_login_shared_secret else {} }}"
 
 # Enable End-to-bridge encryption
 matrix_mautrix_gmessages_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
 matrix_mautrix_gmessages_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
+matrix_mautrix_gmessages_bridge_encryption_require: false
+matrix_mautrix_gmessages_bridge_encryption_appservice: false
 matrix_mautrix_gmessages_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_gmessages_bridge_encryption_allow }}"
 
+matrix_mautrix_gmessages_network_displayname_template: "{% raw %}{{or .FullName .PhoneNumber}}{% endraw %}"
+matrix_mautrix_gmessages_appservice_username_template: "{% raw %}gmessages_{{.}}{% endraw %}"
+
+matrix_mautrix_gmessages_public_media_signing_key: ''
+
 matrix_mautrix_gmessages_bridge_personal_filtering_spaces: true
-matrix_mautrix_gmessages_bridge_mute_bridging: true
 
 matrix_mautrix_gmessages_bridge_permissions: |
   {{

roles/custom/matrix-bridge-mautrix-gmessages/tasks/validate_config.yml

@@ -22,3 +22,6 @@
   when: "item.old in vars"
   with_items:
     - {'old': 'matrix_mautrix_gmessages_log_level', 'new': 'matrix_mautrix_gmessages_logging_level'}
+    - {'old': 'matrix_mautrix_gmessages_bridge_mute_bridging', 'new': '<removed>'}
+    - {'old': 'matrix_mautrix_gmessages_login_shared_secret', 'new': '<removed>'}
+    - {'old': 'matrix_mautrix_gmessages_bridge_login_shared_secret_map', 'new': 'matrix_mautrix_gmessages_double_puppet_secrets_custom'}

roles/custom/matrix-bridge-mautrix-gmessages/templates/config.yaml.j2

@@ -1,20 +1,172 @@
 #jinja2: lstrip_blocks: "True"
+# Network-specific config options
+network:
+    # Displayname template for SMS users.
+    # {% raw %}{{.FullName}}{% endraw %} - Full name provided by the phone
+    # {% raw %}{{.FirstName}}{% endraw %} - First name provided by the phone
+    # {% raw %}{{.PhoneNumber}}{% endraw %} - Formatted phone number provided by the phone
+    displayname_template: {{ matrix_mautrix_gmessages_network_displayname_template | to_json }}
+    # Settings for how the bridge appears to the phone.
+    device_meta:
+        # OS name to tell the phone. This is the name that shows up in the paired devices list.
+        os: mautrix-gmessages
+        # Browser type to tell the phone. This decides which icon is shown.
+        # Valid types: OTHER, CHROME, FIREFOX, SAFARI, OPERA, IE, EDGE
+        browser: OTHER
+        # Device type to tell the phone. This also affects the icon, as well as how many sessions are allowed simultaneously.
+        # One web, two tablets and one PWA should be able to connect at the same time.
+        # Valid types: WEB, TABLET, PWA
+        type: TABLET
+    # Should the bridge aggressively set itself as the active device if the user opens Google Messages in a browser?
+    # If this is disabled, the user must manually use the `set-active` command to reactivate the bridge.
+    aggressive_reconnect: false
+    # Number of chats to sync when connecting to Google Messages.
+    initial_chat_sync_count: 25
+
+
+# Config options that affect the central bridge module.
+bridge:
+    # The prefix for commands. Only required in non-management rooms.
+    command_prefix: '!gm'
+    # Should the bridge create a space for each login containing the rooms that account is in?
+    personal_filtering_spaces: {{ matrix_mautrix_gmessages_bridge_personal_filtering_spaces | to_json }}
+    # Whether the bridge should set names and avatars explicitly for DM portals.
+    # This is only necessary when using clients that don't support MSC4171.
+    private_chat_portal_meta: false
+    # Should events be handled asynchronously within portal rooms?
+    # If true, events may end up being out of order, but slow events won't block other ones.
+    async_events: false
+    # Should every user have their own portals rather than sharing them?
+    # By default, users who are in the same group on the remote network will be
+    # in the same Matrix room bridged to that group. If this is set to true,
+    # every user will get their own Matrix room instead.
+    split_portals: false
+    # Should the bridge resend `m.bridge` events to all portals on startup?
+    resend_bridge_info: false
+
+    # Should leaving Matrix rooms be bridged as leaving groups on the remote network?
+    bridge_matrix_leave: false
+    # Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
+    # Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
+    tag_only_on_create: true
+    # Should room mute status only be synced when creating the portal?
+    # Like tags, mutes can't currently be synced back to the remote network.
+    mute_only_on_create: true
+
+    # What should be done to portal rooms when a user logs out or is logged out?
+    # Permitted values:
+    #   nothing - Do nothing, let the user stay in the portals
+    #   kick - Remove the user from the portal rooms, but don't delete them
+    #   unbridge - Remove all ghosts in the room and disassociate it from the remote chat
+    #   delete - Remove all ghosts and users from the room (i.e. delete it)
+    cleanup_on_logout:
+        # Should cleanup on logout be enabled at all?
+        enabled: false
+        # Settings for manual logouts (explicitly initiated by the Matrix user)
+        manual:
+            # Action for private portals which will never be shared with other Matrix users.
+            private: nothing
+            # Action for portals with a relay user configured.
+            relayed: nothing
+            # Action for portals which may be shared, but don't currently have any other Matrix users.
+            shared_no_users: nothing
+            # Action for portals which have other logged-in Matrix users.
+            shared_has_users: nothing
+        # Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
+        # Keys have the same meanings as in the manual section.
+        bad_credentials:
+            private: nothing
+            relayed: nothing
+            shared_no_users: nothing
+            shared_has_users: nothing
+
+    # Settings for relay mode
+    relay:
+        # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
+        # authenticated user into a relaybot for that chat.
+        enabled: false
+        # Should only admins be allowed to set themselves as relay users?
+        # If true, non-admins can only set users listed in default_relays as relays in a room.
+        admin_only: true
+        # List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
+        default_relays: []
+        # The formats to use when sending messages via the relaybot.
+        # Available variables:
+        #   .Sender.UserID - The Matrix user ID of the sender.
+        #   .Sender.Displayname - The display name of the sender (if set).
+        #   .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
+        #   .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
+        #                               plus the user ID in parentheses if the displayname is not unique.
+        #                               If the displayname is not set, this is just the user ID.
+        #   .Message - The `formatted_body` field of the message.
+        #   .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
+        #   .FileName - The name of the file being sent.
+        message_formats:
+            m.text: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}{% endraw %}"
+            m.notice: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}{% endraw %}"
+            m.emote: "{% raw %}* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}{% endraw %}"
+            m.file: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
+            m.image: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
+            m.audio: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
+            m.video: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
+            m.location: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
+        # For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
+        # This has all the Sender variables available under message_formats (but without the .Sender prefix).
+        # Note that you need to manually remove the displayname from message_formats above.
+        displayname_format: "{% raw %}{{ .DisambiguatedName }}{% endraw %}"
+
+    # Permissions for using the bridge.
+    # Permitted values:
+    #    relay - Talk through the relaybot (if enabled), no access otherwise
+    # commands - Access to use commands in the bridge, but not login.
+    #     user - Access to use the bridge with puppeting.
+    #    admin - Full access, user level with some additional administration tools.
+    # Permitted keys:
+    #        * - All Matrix users
+    #   domain - All users on that homeserver
+    #     mxid - Specific user
+    permissions: {{ matrix_mautrix_gmessages_bridge_permissions|to_json }}
+
+# Config for the bridge's database.
+database:
+    # The database type. "sqlite3-fk-wal" and "postgres" are supported.
+    type: postgres
+    # The database URI.
+    #   SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
+    #           https://github.com/mattn/go-sqlite3#connection-string
+    #   Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
+    #             To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
+    uri: {{ matrix_mautrix_gmessages_appservice_database_uri|to_json }}
+    # Maximum number of connections.
+    max_open_conns: 5
+    max_idle_conns: 1
+    # Maximum connection idle time and lifetime before they're closed. Disabled if null.
+    # Parsed with https://pkg.go.dev/time#ParseDuration
+    max_conn_idle_time: null
+    max_conn_lifetime: null
+
 # Homeserver details.
 homeserver:
     # The address that this appservice can use to connect to the homeserver.
-    address: {{ matrix_mautrix_gmessages_homeserver_address }}
+    # Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
+    # but https also works if they run on different machines.
+    address: http://example.localhost:8008
     # The domain of the homeserver (also known as server_name, used for MXIDs, etc).
-    domain: {{ matrix_mautrix_gmessages_homeserver_domain }}
+    domain: example.com
 
     # What software is the homeserver running?
     # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
     software: standard
     # The URL to push real-time bridge status to.
-    # If set, the bridge will make POST requests to this URL whenever a user's google messages connection state changes.
+    # If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
     # The bridge will use the appservice as_token to authorize requests.
-    status_endpoint: null
+    status_endpoint:
     # Endpoint for reporting per-message status.
-    message_send_checkpoint_endpoint: null
+    # If set, the bridge will make POST requests to this URL when processing a message from Matrix.
+    # It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
+    # (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
+    # The bridge will use the appservice as_token to authorize requests.
+    message_send_checkpoint_endpoint:
     # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
     async_media: false
 
@@ -26,33 +178,19 @@ homeserver:
     ping_interval_seconds: 0
 
 # Application service host/registration related details.
-# Changing these values requires regeneration of the registration.
+# Changing these values requires regeneration of the registration (except when noted otherwise)
 appservice:
     # The address that the homeserver can use to connect to this appservice.
     address: {{ matrix_mautrix_gmessages_appservice_address }}
+    # A public address that external services can use to reach this appservice.
+    # This value doesn't affect the registration file.
+    public_address: https://bridge.example.com
 
     # The hostname and port where this appservice should listen.
+    # For Docker, you generally have to change the hostname to 0.0.0.0.
     hostname: 0.0.0.0
     port: 8080
 
-    # Database config.
-    database:
-        # The database type. "sqlite3-fk-wal" and "postgres" are supported.
-        type: postgres
-        # The database URI.
-        #   SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
-        #           https://github.com/mattn/go-sqlite3#connection-string
-        #   Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
-        #             To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
-        uri: {{ matrix_mautrix_gmessages_appservice_database_uri|to_json }}
-        # Maximum number of connections. Mostly relevant for Postgres.
-        max_open_conns: 20
-        max_idle_conns: 2
-        # Maximum connection idle time and lifetime before they're closed. Disabled if null.
-        # Parsed with https://pkg.go.dev/time#ParseDuration
-        max_conn_idle_time: null
-        max_conn_lifetime: null
-
     # The unique ID of this appservice.
     id: gmessages
     # Appservice bot details.
@@ -64,148 +202,164 @@ appservice:
         displayname: Google Messages bridge bot
         avatar: mxc://maunium.net/yGOdcrJcwqARZqdzbfuxfhzb
 
-    # Whether or not to receive ephemeral events via appservice transactions.
+    # Whether to receive ephemeral events via appservice transactions.
-    # Requires MSC2409 support (i.e. Synapse 1.22+).
     ephemeral_events: true
-
     # Should incoming events be handled asynchronously?
     # This may be necessary for large public instances with lots of messages going through.
     # However, messages will not be guaranteed to be bridged in the same order they were sent in.
+    # This value doesn't affect the registration file.
     async_transactions: false
 
     # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
-    as_token: "{{ matrix_mautrix_gmessages_appservice_token }}"
+    as_token: {{ matrix_mautrix_gmessages_appservice_token | to_json }}
-    hs_token: "{{ matrix_mautrix_gmessages_homeserver_token }}"
+    hs_token: {{ matrix_mautrix_gmessages_homeserver_token | to_json }}
 
-# Segment API key to track some events, like provisioning API login and encryption errors.
+    # Localpart template of MXIDs for remote users.
-segment_key: null
+    # {% raw %}{{.}}{% endraw %} is replaced with the internal ID of the user.
-# Optional user_id to use when sending Segment events. If null, defaults to using mxID.
+    username_template: {{ matrix_mautrix_gmessages_appservice_username_template | to_json }}
-segment_user_id: null
 
-# Prometheus config.
+# Config options that affect the Matrix connector of the bridge.
-metrics:
+matrix:
-    # Enable prometheus metrics?
-    enabled: {{ matrix_mautrix_gmessages_metrics_enabled | to_json }}
-    # IP and port where the metrics listener should be. The path is always /metrics
-    listen: 0.0.0.0:8001
-
-google_messages:
-    # OS name to tell the phone. This is the name that shows up in the paired devices list.
-    os: mautrix-gmessages
-    # Browser type to tell the phone. This decides which icon is shown.
-    # Valid types: OTHER, CHROME, FIREFOX, SAFARI, OPERA, IE, EDGE
-    browser: OTHER
-
-    # Should the bridge aggressively set itself as the active device if the user opens Google Messages in a browser?
-    # If this is disabled, the user must manually use the `reconnect` command to reactivate the bridge.
-    aggressive_reconnect: false
-
-# Bridge config
-bridge:
-    # Localpart template of MXIDs for SMS users.
-    # {{ '{{.}}' }} is replaced with an identifier of the recipient.
-    username_template: "{{ 'gmessages_{{.}}' }}"
-    # Displayname template for SMS users.
-    # {{ '{{.FullName}}' }} - Full name provided by the phone
-    # {{ '{{.FirstName}}' }} - First name provided by the phone
-    # {{ '{{.PhoneNumber}}' }} - Formatted phone number provided by the phone
-    displayname_template: "{{ '{{or .FullName .PhoneNumber}}' }}"
-    # Should the bridge create a space for each logged-in user and add bridged rooms to it?
-    personal_filtering_spaces: {{ matrix_mautrix_gmessages_bridge_personal_filtering_spaces | to_json }}
-    # Should the bridge send a read receipt from the bridge bot when a message has been sent to the phone?
-    delivery_receipts: false
     # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
     message_status_events: false
+    # Whether the bridge should send a read receipt after successfully bridging a message.
+    delivery_receipts: false
     # Whether the bridge should send error notices via m.notice events when a message fails to bridge.
     message_error_notices: true
-
+    # Whether the bridge should update the m.direct account data event when double puppeting is enabled.
-    portal_message_buffer: 128
-
-    # Should the bridge update the m.direct account data event when double puppeting is enabled.
-    # Note that updating the m.direct event is not atomic (except with mautrix-asmux)
-    # and is therefore prone to race conditions.
     sync_direct_chat_list: false
-    # Number of chats to sync when connecting to Google Messages.
+    # Whether created rooms should have federation enabled. If false, created portal rooms
-    initial_chat_sync_count: 25
+    # will never be federated. Changing this option requires recreating rooms.
-    # Backfill settings
-    backfill:
-        # Number of messages to backfill in new chats.
-        initial_limit: 50
-        # Number of messages to backfill on startup if the last message ID in the chat sync doesn't match the last bridged message.
-        missed_limit: 100
-
-    # Servers to always allow double puppeting from
-    double_puppet_server_map:
-        "{{ matrix_mautrix_gmessages_homeserver_domain }}": {{ matrix_mautrix_gmessages_homeserver_address }}
-    # Allow using double puppeting from any server with a valid client .well-known file.
-    double_puppet_allow_discovery: false
-    # Shared secrets for https://github.com/devture/matrix-synapse-shared-secret-auth
-    #
-    # If set, double puppeting will be enabled automatically for local users
-    # instead of users having to find an access token and run `login-matrix`
-    # manually.
-    login_shared_secret_map: {{ matrix_mautrix_gmessages_bridge_login_shared_secret_map|to_json }}
-
-    # Whether to explicitly set the avatar and room name for private chat portal rooms.
-    # If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms.
-    # If set to `always`, all DM rooms will have explicit names and avatars set.
-    # If set to `never`, DM rooms will never have names and avatars set.
-    private_chat_portal_meta: default
-    # Should Matrix m.notice-type messages be bridged?
-    bridge_notices: true
-    # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
-    # This field will automatically be changed back to false after it, except if the config file is not writable.
-    resend_bridge_info: false
-    # When using double puppeting, should muted chats be muted in Matrix?
-    mute_bridging: {{ matrix_mautrix_gmessages_bridge_mute_bridging | to_json }}
-    # When using double puppeting, should archived chats be moved to a specific tag in Matrix?
-    # This can be set to a tag (e.g. m.lowpriority), or null to disable.
-    archive_tag: null
-    # Same as above, but for pinned chats. The favorite tag is called m.favourite
-    pinned_tag: null
-    # Should mute status and tags only be bridged when the portal room is created?
-    tag_only_on_create: true
-    # Whether or not created rooms should have federation enabled.
-    # If false, created portal rooms will never be federated.
     federate_rooms: {{ matrix_mautrix_gmessages_federate_rooms | to_json }}
-    # Should the bridge never send alerts to the bridge management room?
+    # The threshold as bytes after which the bridge should roundtrip uploads via the disk
-    # These are mostly things like the user being logged out.
+    # rather than keeping the whole file in memory.
-    disable_bridge_alerts: false
+    upload_file_threshold: 5242880
-    # Send captions in the same message as images. This will send data compatible with both MSC2530 and MSC3552.
-    # This is currently not supported in most clients.
-    caption_in_message: false
 
-    # The prefix for commands. Only required in non-management rooms.
+# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
-    command_prefix: "!gm"
+analytics:
+    # API key to send with tracking requests. Tracking is disabled if this is null.
+    token: null
+    # Address to send tracking requests to.
+    url: https://api.segment.io/v1/track
+    # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
+    user_id: null
 
-    # Messages sent upon joining a management room.
+# Settings for provisioning API
-    # Markdown is supported. The defaults are listed below.
+provisioning:
-    management_room_text:
+    # Prefix for the provisioning API paths.
-        # Sent when joining a room.
+    prefix: /_matrix/provision
-        welcome: "Hello, I'm a Google Messages bridge bot."
+    # Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
-        # Sent when joining a management room and the user is already logged in.
+    # or if set to "disable", the provisioning API will be disabled.
-        welcome_connected: "Use `help` for help."
+    shared_secret: disable
-        # Sent when joining a management room and the user is not logged in.
+    # Whether to allow provisioning API requests to be authed using Matrix access tokens.
-        welcome_unconnected: "Use `help` for help or `login` to log in."
+    # This follows the same rules as double puppeting to determine which server to contact to check the token,
-        # Optional extra text sent when joining a management room.
+    # which means that by default, it only works for users on the same server as the bridge.
-        additional_help: ""
+    allow_matrix_auth: true
+    # Enable debug API at /debug with provisioning authentication.
+    debug_endpoints: false
+
+# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
+# These settings control whether the bridge will provide such public media access.
+public_media:
+    # Should public media be enabled at all?
+    # The public_address field under the appservice section MUST be set when enabling public media.
+    enabled: false
+    # A key for signing public media URLs.
+    # If set to "generate", a random key will be generated.
+    signing_key: {{ matrix_mautrix_gmessages_public_media_signing_key | to_json }}
+    # Number of seconds that public media URLs are valid for.
+    # If set to 0, URLs will never expire.
+    expiry: 0
+    # Length of hash to use for public media URLs. Must be between 0 and 32.
+    hash_length: 32
+
+# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
+# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
+direct_media:
+    # Should custom mxc:// URIs be used instead of reuploading media?
+    enabled: false
+    # The server name to use for the custom mxc:// URIs.
+    # This server name will effectively be a real Matrix server, it just won't implement anything other than media.
+    # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
+    server_name: media.example.com
+    # Optionally a custom .well-known response. This defaults to `server_name:443`
+    well_known_response:
+    # Optionally specify a custom prefix for the media ID part of the MXC URI.
+    media_id_prefix:
+    # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
+    # media download redirects if the requester supports it. Optionally, you can force redirects
+    # and not allow proxying at all by setting this to false.
+    # This option does nothing if the remote network does not support media downloads over HTTP.
+    allow_proxy: true
+    # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
+    # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
+    server_key: ""
+
+# Settings for backfilling messages.
+# Note that the exact way settings are applied depends on the network connector.
+# See https://docs.mau.fi/bridges/general/backfill.html for more details.
+backfill:
+    # Whether to do backfilling at all.
+    enabled: {{ matrix_mautrix_gmessages_backfill_enabled | to_json }}
+    # Maximum number of messages to backfill in empty rooms.
+    max_initial_messages: {{ matrix_mautrix_gmessages_backfill_max_initial_messages | to_json }}
+    # Maximum number of missed messages to backfill after bridge restarts.
+    max_catchup_messages: {{ matrix_mautrix_gmessages_backfill_max_catchup_messages | to_json }}
+    # If a backfilled chat is older than this number of hours,
+    # mark it as read even if it's unread on the remote network.
+    unread_hours_threshold: {{ matrix_mautrix_gmessages_backfill_unread_hours_threshold | to_json }}
+    # Settings for backfilling threads within other backfills.
+    threads:
+        # Maximum number of messages to backfill in a new thread.
+        max_initial_messages: {{ matrix_mautrix_gmessages_backfill_threads_max_initial_messages | to_json }}
+    # Settings for the backwards backfill queue. This only applies when connecting to
+    # Beeper as standard Matrix servers don't support inserting messages into history.
+    queue:
+        # Should the backfill queue be enabled?
+        enabled: false
+        # Number of messages to backfill in one batch.
+        batch_size: 100
+        # Delay between batches in seconds.
+        batch_delay: 20
+        # Maximum number of batches to backfill per portal.
+        # If set to -1, all available messages will be backfilled.
+        max_batches: -1
+        # Optional network-specific overrides for max batches.
+        # Interpretation of this field depends on the network connector.
+        max_batches_override: {}
+
+# Settings for enabling double puppeting
+double_puppet:
+    # Servers to always allow double puppeting from.
+    # This is only for other servers and should NOT contain the server the bridge is on.
+    servers: {}
+    # Whether to allow client API URL discovery for other servers. When using this option,
+    # users on other servers can use double puppeting even if their server URLs aren't
+    # explicitly added to the servers map above.
+    allow_discovery: false
+    # Shared secrets for automatic double puppeting.
+    # See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
+    secrets: {{ matrix_mautrix_gmessages_double_puppet_secrets | to_json }}
 
 # End-to-bridge encryption support options.
 #
 # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
 encryption:
-        # Allow encryption, work in group chat rooms with e2ee enabled
+    # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
     allow: {{ matrix_mautrix_gmessages_bridge_encryption_allow | to_json }}
-        # Default to encryption, force-enable encryption in all portals the bridge creates
+    # Whether to force-enable encryption in all bridged rooms.
-        # This will cause the bridge bot to be in private chats for the encryption to work properly.
     default: {{ matrix_mautrix_gmessages_bridge_encryption_default | to_json }}
+    # Whether to require all messages to be encrypted and drop any unencrypted messages.
+    require: {{ matrix_mautrix_gmessages_bridge_encryption_require | to_json }}
     # Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data.
-        appservice: false
+    # This option is not yet compatible with standard Matrix servers like Synapse and should not be used.
-        # Require encryption, drop any unencrypted messages.
+    appservice: {{ matrix_mautrix_gmessages_bridge_encryption_appservice | to_json }}
-        require: false
     # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
     # You must use a client that supports requesting keys from other users to use this feature.
     allow_key_sharing: {{ matrix_mautrix_gmessages_bridge_encryption_key_sharing_allow | to_json }}
+    # Pickle key for encrypting encryption keys in the bridge database.
+    # If set to generate, a random key will be generated.
+    pickle_key: mautrix.bridge.e2ee
     # Options for deleting megolm sessions from the bridge.
     delete_keys:
         # Beeper-specific: delete outbound sessions when hungryserv confirms
@@ -238,20 +392,17 @@ bridge:
     #   verified - Require manual per-device verification
     #              (currently only possible by modifying the `trust` column in the `crypto_device` database table).
     verification_levels:
-            # Minimum level for which the bridge should send keys to when bridging messages from SMS to Matrix.
+        # Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
         receive: unverified
         # Minimum level that the bridge should accept for incoming Matrix messages.
         send: unverified
         # Minimum level that the bridge should require for accepting key requests.
         share: cross-signed-tofu
-        # Options for Megolm room key rotation. These options allow you to
+    # Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
-        # configure the m.room.encryption event content. See:
+    # See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
-        # https://spec.matrix.org/v1.3/client-server-api/#mroomencryption for
-        # more information about that event.
     rotation:
         # Enable custom Megolm room key rotation settings. Note that these
-            # settings will only apply to rooms created after this option is
+        # settings will only apply to rooms created after this option is set.
-            # set.
         enable_custom: false
         # The maximum number of milliseconds a session should be used
         # before changing it. The Matrix spec recommends 604800000 (a week)
@@ -261,32 +412,13 @@ bridge:
         # session before changing it. The Matrix spec recommends 100 as the
         # default.
         messages: 100
-
         # Disable rotating keys when a user's devices change?
         # You should not enable this option unless you understand all the implications.
         disable_device_change_key_rotation: false
 
-    # Settings for provisioning API
-    provisioning:
-        # Prefix for the provisioning API paths.
-        prefix: /_matrix/provision
-        # Shared secret for authentication. If set to "generate", a random secret will be generated,
-        # or if set to "disable", the provisioning API will be disabled.
-        shared_secret: generate
-
-    # Permissions for using the bridge.
-    # Permitted values:
-    #     user - Access to use the bridge to link their own Google Messages on android.
-    #    admin - User level and some additional administration tools
-    # Permitted keys:
-    #        * - All Matrix users
-    #   domain - All users on that homeserver
-    #     mxid - Specific user
-    permissions: {{ matrix_mautrix_gmessages_bridge_permissions|to_json }}
-
 # Logging config. See https://github.com/tulir/zeroconfig for details.
 logging:
     min_level: {{ matrix_mautrix_gmessages_logging_level }}
     writers:
         - type: stdout
-          format: pretty-colored
+          format: pretty