Replace bridge config with one from upstream

Source: 12f420ab95/mautrix_twitter/example-config.yaml

roles/matrix-bridge-mautrix-twitter/templates/config.yaml.j2

@@ -1,60 +1,72 @@
-#jinja2: lstrip_blocks: "True"
 # Homeserver details
 homeserver:
     # The address that this appservice can use to connect to the homeserver.
-    address: {{ matrix_mautrix_twitter_homeserver_address }}
+    address: https://example.com
     # The domain of the homeserver (for MXIDs, etc).
-    domain: {{ matrix_mautrix_twitter_homeserver_domain }}
+    domain: example.com
     # Whether or not to verify the SSL certificate of the homeserver.
     # Only applies if address starts with https://
     verify_ssl: true
-    # Whether or not the homeserver supports asmux-specific endpoints,
-    # such as /_matrix/client/unstable/net.maunium.asmux/dms for atomically
-    # updating m.direct.
     asmux: false
 
 # Application service host/registration related details
 # Changing these values requires regeneration of the registration.
 appservice:
     # The address that the homeserver can use to connect to this appservice.
-    address: {{ matrix_mautrix_twitter_appservice_address }}
+    address: http://localhost:29327
+    # When using https:// the TLS certificate and key files for the address.
+    tls_cert: false
+    tls_key: false
 
     # The hostname and port where this appservice should listen.
     hostname: 0.0.0.0
-    port: 29319
+    port: 29327
     # The maximum body size of appservice API requests (from the homeserver) in mebibytes
     # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s
     max_body_size: 1
 
     # The full URI to the database. Only Postgres is currently supported.
-    database: {{ matrix_mautrix_twitter_appservice_database|to_json }}
-
-    # Public part of web server for out-of-Matrix interaction with the bridge.
-    public:
-        # Whether or not the public-facing endpoints should be enabled.
-        enabled: false
-        # The prefix to use in the public-facing endpoints.
-        prefix: /public
-        # The base URL where the public-facing endpoints are available. The prefix is not added
-        # implicitly.
-        external: https://example.com/public
-        # Shared secret for integration managers such as mautrix-manager.
-        # If set to "generate", a random string will be generated on the next startup.
-        # If null, integration manager access to the API will not be possible.
+    database: postgres://username:password@hostname/db
+    # Additional arguments for asyncpg.create_pool()
+    # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool
+    database_opts:
+        min_size: 5
+        max_size: 10
+
+    # Provisioning API part of the web server for automated portal creation and fetching information.
+    # Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager).
+    provisioning:
+        # Whether or not the provisioning API should be enabled.
+        enabled: true
+        # The prefix to use in the provisioning API endpoints.
+        prefix: /_matrix/provision/v1
+        # The shared secret to authorize users of the API.
+        # Set to "generate" to generate and save a new token.
         shared_secret: generate
 
     # The unique ID of this appservice.
     id: twitter
     # Username of the appservice bot.
-    bot_username: {{ matrix_mautrix_twitter_appservice_bot_username|to_json }}
+    bot_username: twitterbot
     # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
     # to leave display name/avatar as-is.
     bot_displayname: Twitter bridge bot
-    bot_avatar: mxc://maunium.net/ygtkteZsXnGJLJHRchUwYWak
+    bot_avatar: mxc://maunium.net/HVHcnusJkQcpVcsVGZRELLCn
+
+    # Community ID for bridged users (changes registration file) and rooms.
+    # Must be created manually.
+    #
+    # Example: "+twitter:example.com". Set to false to disable.
+    community_id: false
 
-    # Authentication tokens for AS <-> HS communication.
-    as_token: "{{ matrix_mautrix_twitter_appservice_token }}"
-    hs_token: "{{ matrix_mautrix_twitter_homeserver_token }}"
+    # Whether or not to receive ephemeral events via appservice transactions.
+    # Requires MSC2409 support (i.e. Synapse 1.22+).
+    # You should disable bridge -> sync_with_custom_puppets when this is enabled.
+    ephemeral_events: false
+
+    # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
+    as_token: "This value is generated when generating the registration"
+    hs_token: "This value is generated when generating the registration"
 
 # Prometheus telemetry config. Requires prometheus-client to be installed.
 metrics:
@@ -66,64 +78,59 @@ bridge:
     # Localpart template of MXIDs for Twitter users.
     # {userid} is replaced with the user ID of the Twitter user.
     username_template: "twitter_{userid}"
-    # Localpart template for per-user room grouping community IDs.
-    # The bridge will create these communities and add all of the specific user's portals to the community.
-    # {localpart} is the MXID localpart and {server} is the MXID server part of the user.
-    #
-    # `twitter_{localpart}={server}` is a good value.
-    community_template: null
     # Displayname template for Twitter users.
-    # {displayname} is replaced with the display name of the Twitter user
-    #               as defined below in displayname_preference.
-    # Keys available for displayname_preference are also available here.
-    displayname_template: '{displayname} (Twitter)'
-    # Available keys:
-    # "name" (full name)
-    # "first_name"
-    # "last_name"
-    # "nickname"
-    # "own_nickname" (user-specific!)
-    displayname_preference:
-    - name
-    - first_name
+    # {displayname} is replaced with the display name of the Twitter user.
+    # {username} is replaced with the username of the Twitter user.
+    displayname_template: "{displayname} (Twitter)"
 
-    # The prefix for commands. Only required in non-management rooms.
-    command_prefix: "!twitter"
+    # Maximum length of displayname
+    displayname_max_length: 100
 
-    # Number of chats to sync (and create portals for) on startup/login.
+    # Number of conversations to sync (and create portals for) on login.
     # Set 0 to disable automatic syncing.
-    initial_chat_sync: 10
-    # Whether or not the Twitter users of logged in Matrix users should be
-    # invited to private chats when the user sends a message from another client.
-    invite_own_puppet_to_pm: false
-    # Whether or not to use /sync to get presence, read receipts and typing notifications
+    initial_conversation_sync: 10
+    # Whether or not to use /sync to get read receipts and typing notifications
     # when double puppeting is enabled
     sync_with_custom_puppets: true
     # Whether or not to 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
-    # Servers to always allow double puppeting from
-    double_puppet_server_map: {}
-    #    example.com: https://example.com
     # 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
+    # Servers to allow double puppeting from, even if double_puppet_allow_discovery is false.
+    double_puppet_server_map:
+        example.com: https://example.com
+    # Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
     #
     # If set, custom puppets will be enabled automatically for local users
     # instead of users having to find an access token and run `login-matrix`
     # manually.
     # If using this for other servers than the bridge's server,
     # you must also set the URL in the double_puppet_server_map.
-    login_shared_secret_map: {{ matrix_mautrix_twitter_bridge_login_shared_secret_map|to_json }}
-    presence: {{ matrix_mautrix_twitter_bridge_presence|to_json }}
-    # Whether or not to update avatars when syncing all contacts at startup.
-    update_avatar_initial_sync: true
-    # End-to-bridge encryption support options. These require matrix-nio to be installed with pip
-    # and login_shared_secret to be configured in order to get a device for the bridge bot.
+    login_shared_secret_map:
+        example.com: foo
+    # Whether or not created rooms should have federation enabled.
+    # If false, created portal rooms will never be federated.
+    federate_rooms: true
+    # Settings for backfilling messages from Twitter.
     #
-    # Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal
-    # application service.
+    # Missed message backfilling is currently based on receiving them from the Twitter polling API,
+    # rather than manually asking for messages in each conversation. Due to this, there's no way to
+    # set a limit for missed message backfilling.
+    backfill:
+        # Whether or not the Twitter users of logged in Matrix users should be
+        # invited to private chats when backfilling history from Twitter. This is
+        # usually needed to prevent rate limits and to allow timestamp massaging.
+        invite_own_puppet: true
+        # Maximum number of messages to backfill initially.
+        # Set to 0 to disable backfilling when creating portal.
+        initial_limit: 0
+        # If using double puppeting, should notifications be disabled
+        # while the initial backfill is in progress?
+        disable_notifications: false
+    # End-to-bridge encryption support options. You must install the e2be optional dependency for
+    # this to work. See https://github.com/tulir/mautrix-telegram/wiki/End‐to‐bridge-encryption
     encryption:
         # Allow encryption, work in group chat rooms with e2ee enabled
         allow: false
@@ -142,52 +149,29 @@ bridge:
             # Require devices to be verified by the bridge?
             # Verification by the bridge is not yet implemented.
             require_verification: true
+    # Whether or not to explicitly set the avatar and room name for private
+    # chat portal rooms. This will be implicitly enabled if encryption.default is true.
+    private_chat_portal_meta: false
     # Whether or not the bridge should send a read receipt from the bridge bot when a message has
     # been sent to Twitter.
     delivery_receipts: false
-    # Whether to allow inviting arbitrary mxids to portal rooms
-    allow_invites: false
-    # Settings for backfilling messages from Twitter.
-    backfill:
-        # Whether or not the Twitter users of logged in Matrix users should be
-        # invited to private chats when backfilling history from Twitter. This is
-        # usually needed to prevent rate limits and to allow timestamp massaging.
-        invite_own_puppet: true
-        # Maximum number of messages to backfill initially.
-        # Set to 0 to disable backfilling when creating portal.
-        initial_limit: 0
-        # Maximum number of messages to backfill if messages were missed while
-        # the bridge was disconnected.
-        # Set to 0 to disable backfilling missed messages.
-        missed_limit: 1000
-        # If using double puppeting, should notifications be disabled
-        # while the initial backfill is in progress?
-        disable_notifications: false
-    periodic_reconnect:
-        # Interval in seconds in which to automatically reconnect all users.
-        # This can be used to automatically mitigate the bug where Twitter stops sending messages.
-        # Set to -1 to disable periodic reconnections entirely.
-        interval: -1
-        # What to do in periodic reconnects. Either "refresh" or "reconnect"
-        mode: refresh
-        # Should even disconnected users be reconnected?
-        always: false
-    # The number of seconds that a disconnection can last without triggering an automatic re-sync
-    # and missed message backfilling when reconnecting.
-    # Set to 0 to always re-sync, or -1 to never re-sync automatically.
-    resync_max_disconnected_time: 5
-    # Whether or not temporary disconnections should send notices to the notice room.
-    # If this is false, disconnections will never send messages and connections will only send
-    # messages if it was disconnected for more than resync_max_disconnected_time seconds.
+    # Whether or not delivery errors should be reported as messages in the Matrix room.
+    delivery_error_reports: false
+    # Whether or not non-fatal polling errors should send notices to the notice room.
     temporary_disconnect_notices: true
-    # Whether or not the bridge should try to "refresh" the connection if a normal reconnection
-    # attempt fails.
-    refresh_on_reconnection_fail: false
+    # Number of seconds to sleep more than the previous error when a polling error occurs.
+    # Growth is capped at 15 minutes.
+    error_sleep: 5
+    # Maximum number of polling errors before giving up. Set to -1 to retry forever.
+    max_poll_errors: 12
     # 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
 
+    # The prefix for commands. Only required in non-management rooms.
+    command_prefix: "!tw"
+
     # Permissions for using the bridge.
     # Permitted values:
     #       user - Use the bridge with puppeting.
@@ -197,7 +181,9 @@ bridge:
     #   domain - All users on that homeserver
     #     mxid - Specific user
     permissions:
-      '{{ matrix_mautrix_twitter_homeserver_domain }}': user
+        "example.com": "user"
+        "@admin:example.com": "admin"
+
 
 # Python logging configuration.
 #
@@ -212,16 +198,20 @@ logging:
         normal:
             format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
     handlers:
+        file:
+            class: logging.handlers.RotatingFileHandler
+            formatter: normal
+            filename: ./mautrix-twitter.log
+            maxBytes: 10485760
+            backupCount: 10
         console:
             class: logging.StreamHandler
             formatter: colored
     loggers:
         mau:
             level: DEBUG
-        paho:
-            level: INFO
         aiohttp:
             level: INFO
     root:
         level: DEBUG
-        handlers: [console]
+        handlers: [file, console]