# Homeserver details. homeserver: # The address that this appservice can use to connect to the homeserver. address: https://example.com # The domain of the homeserver (for MXIDs, etc). 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 GroupMe connection state changes. # The bridge will use the appservice as_token to authorize requests. status_endpoint: null # Endpoint for reporting per-message status. message_send_checkpoint_endpoint: null # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246? async_media: 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: http://localhost:29328 # The hostname and port where this appservice should listen. hostname: 0.0.0.0 port: 29328 # 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:?_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: postgres://user:password@host/database?sslmode=disable # 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: groupme # Appservice bot details. bot: # Username of the appservice bot. username: groupmebot # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty # to leave display name/avatar as-is. displayname: GroupMe bridge bot avatar: mxc://nevarro.space/eoAJPcSuTEvffoNycrXjvsmj # Whether or not to receive ephemeral events via appservice transactions. # Requires MSC2409 support (i.e. Synapse 1.22+). ephemeral_events: true # 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" # Segment API key to track some events, like provisioning API login and encryption errors. segment_key: null # Metrics not yet tested! metrics: # Whether or not to enable prometheus metrics enabled: false # IP and port where the metrics listener should be. The path is always /metrics listen: 127.0.0.1:8001 # GroupMe configuration groupme: # GroupMe connection timeout in seconds. connection_timeout: 20 # If GroupMe doesn't respond within connection_timeout, should the bridge # try to fetch the message to see if it was actually bridged? Use this if # you have problems with sends timing out but actually succeeding. fetch_message_on_timeout: false # Bridge config bridge: # Localpart template of MXIDs for GroupMe users. # {{.}} is replaced with the phone number of the GroupMe user. username_template: groupme_{{.}} # Displayname template for GroupMe users. # {{call .UserID.String}} - the number GroupMe assigns to the user # {{.Nickname}} - the nickname in that room # {{.ImageURL}} - User's avatar URL is available but irrelevant here displayname_template: "{{if .Name}}{{.Name}}{{else}}{{.GMID}}{{end}} (GM)" # Should the bridge create a space for each logged-in user and add bridged rooms to it? # Users who logged in before turning this on should run `!wa sync space` to create and fill the space for the first time. personal_filtering_spaces: false # Should the bridge send a read receipt from the bridge bot when a message has been sent to GroupMe? 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 error notices via m.notice events when a message fails to bridge. message_error_notices: true # Maximum number of times to retry connecting on connection error. max_connection_attempts: 3 # Number of seconds to wait between connection attempts. # Negative numbers are exponential backoff: -connection_retry_delay + 1 + 2^attempts connection_retry_delay: -1 # Whether or not the bridge should send a notice to the user's management room when it retries connecting. # If false, it will only report when it stops retrying. report_connection_retry: true # Maximum number of seconds to wait for chats to be sent at startup. # If this is too low and you have lots of chats, it could cause backfilling to fail. chat_list_wait: 30 # Maximum number of seconds to wait to sync portals before force unlocking message processing. # If this is too low and you have lots of chats, it could cause backfilling to fail. portal_sync_wait: 600 user_message_buffer: 1024 portal_message_buffer: 128 # Whether or not to send call start/end notices to Matrix. # N/A GroupMe call_notices: start: true end: true # Number of chats to sync for new users. initial_chat_sync_count: 5 # Number of old messages to fill when creating new portal rooms. initial_history_fill_count: 100 # Whether or not notifications should be turned off while filling initial history. # Only applicable when using double puppeting. initial_history_disable_notifications: false # Maximum number of chats to sync when recovering from downtime. # Set to -1 to sync all new chats during downtime. recovery_chat_sync_limit: -1 # Whether or not to sync history when recovering from downtime. recovery_history_backfill: true # Maximum number of seconds since last message in chat to skip # syncing the chat in any case. This setting will take priority # over both recovery_chat_sync_limit and initial_chat_sync_count. # Default is 3 days = 259200 seconds sync_max_chat_age: 259200 # Whether or not to sync with custom puppets to receive EDUs that # are not normally sent to appservices. 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 # When double puppeting is enabled, users can use `!wa toggle` to change whether or not # presence and read receipts are bridged. These settings set the default values. # Existing users won't be affected when these are changed. default_bridge_receipts: true default_bridge_presence: true # Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth login_shared_secret_map: example.com: null # # 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. login_shared_secret: null # Whether or not to invite own GroupMe user's Matrix puppet into private # chat portals when backfilling if needed. # This always uses the default puppet instead of custom puppets due to # rate limits and timestamp massaging. invite_own_puppet_for_backfilling: true # Whether or not to explicitly set the avatar and room name for private # chat portal rooms. This can be useful if the previous field works fine, # but causes room avatar/name bugs. private_chat_portal_meta: false # 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 # Whether or not thumbnails from GroupMe should be sent. # They're disabled by default due to very low resolution. groupme_thumbnail: false # Allow invite permission for user. User can invite any bots to room with GroupMe # users (private chat and groups) allow_user_invite: false # The prefix for commands. Only required in non-management rooms. command_prefix: "!gm" # Messages sent upon joining a management room. # Markdown is supported. The defaults are listed below. management_room_text: # Sent when joining a room. welcome: "Hello, I'm a GroupMe bridge bot." # Sent when joining a management room and the user is already logged in. welcome_connected: "Use `help` for help." # Sent when joining a management room and the user is not logged in. welcome_unconnected: "Use `help` for help or `login` to log in." # Optional extra text sent when joining a management room. additional_help: "" # 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 allow: false # Default to encryption, force-enable encryption in all portals the bridge creates # This will cause the bridge bot to be in private chats for the encryption to work properly. default: false # Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data. appservice: false # Require encryption, drop any unencrypted messages. 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: false # What level of device verification should be required from users? # # Valid levels: # unverified - Send keys to all device in the room. # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys. # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes). # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot. # Note that creating user signatures from the bridge bot is not currently possible. # 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 GroupMe 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 # configure the m.room.encryption event content. See: # 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 # set. enable_custom: false # The maximum number of milliseconds a session should be used # before changing it. The Matrix spec recommends 604800000 (a week) # as the default. milliseconds: 604800000 # The maximum number of messages that should be sent with a given a # session before changing it. The Matrix spec recommends 100 as the # default. messages: 100 # Settings for provisioning API provisioning: # Prefix for the provisioning API paths. prefix: /_matrix/provision/v1 # Shared secret for authentication. If set to "disable", the provisioning API will be disabled. shared_secret: disable # Permissions for using the bridge. # Permitted values: # relaybot - Talk through the relaybot (if enabled), no access otherwise # user - Access to use the bridge to chat with a GroupMe account. # admin - User level and some additional administration tools # Permitted keys: # * - All Matrix users # domain - All users on that homeserver # mxid - Specific user permissions: "*": relaybot "example.com": user "@admin:example.com": admin # Logging config. See https://github.com/tulir/zeroconfig for details. logging: min_level: debug writers: - type: stdout format: pretty-colored - type: file format: json filename: ./logs/mautrix-groupme.log max_size: 100 max_backups: 10 compress: true