| @@ -15,6 +15,8 @@ homeserver: | |||||
| # If set, the bridge will make POST requests to this URL whenever a user's Signal connection state changes. | # If set, the bridge will make POST requests to this URL whenever a user's Signal connection state changes. | ||||
| # The bridge will use the appservice as_token to authorize requests. | # The bridge will use the appservice as_token to authorize requests. | ||||
| status_endpoint: null | status_endpoint: null | ||||
| # Endpoint for reporting per-message status. | |||||
| message_send_checkpoint_endpoint: null | |||||
| # Application service host/registration related details | # Application service host/registration related details | ||||
| # Changing these values requires regeneration of the registration. | # Changing these values requires regeneration of the registration. | ||||
| @@ -32,25 +34,19 @@ appservice: | |||||
| # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s | # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s | ||||
| max_body_size: 1 | max_body_size: 1 | ||||
| # The full URI to the database. Only Postgres is currently supported. | |||||
| # The full URI to the database. SQLite and Postgres are supported. | |||||
| # Format examples: | |||||
| # SQLite: sqlite:///filename.db | |||||
| # Postgres: postgres://username:password@hostname/dbname | |||||
| database: {{ matrix_mautrix_signal_database_connection_string }} | database: {{ matrix_mautrix_signal_database_connection_string }} | ||||
| # Additional arguments for asyncpg.create_pool() | |||||
| # Additional arguments for asyncpg.create_pool() or sqlite3.connect() | |||||
| # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool | # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool | ||||
| # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect | |||||
| # For sqlite, min_size is used as the connection thread pool size and max_size is ignored. | |||||
| database_opts: | database_opts: | ||||
| min_size: 5 | min_size: 5 | ||||
| max_size: 10 | 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. | # The unique ID of this appservice. | ||||
| id: signal | id: signal | ||||
| # Username of the appservice bot. | # Username of the appservice bot. | ||||
| @@ -66,7 +62,12 @@ appservice: | |||||
| # Example: "+signal:example.com". Set to false to disable. | # Example: "+signal:example.com". Set to false to disable. | ||||
| community_id: false | community_id: false | ||||
| # Authentication tokens for AS <-> HS communication. | |||||
| # 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: "{{ matrix_mautrix_signal_appservice_token }}" | as_token: "{{ matrix_mautrix_signal_appservice_token }}" | ||||
| hs_token: "{{ matrix_mautrix_signal_homeserver_token }}" | hs_token: "{{ matrix_mautrix_signal_homeserver_token }}" | ||||
| @@ -75,6 +76,17 @@ metrics: | |||||
| enabled: false | enabled: false | ||||
| listen_port: 8000 | listen_port: 8000 | ||||
| # Manhole config. | |||||
| manhole: | |||||
| # Whether or not opening the manhole is allowed. | |||||
| enabled: false | |||||
| # The path for the unix socket. | |||||
| path: /var/tmp/mautrix-signal.manhole | |||||
| # The list of UIDs who can be added to the whitelist. | |||||
| # If empty, any UIDs can be specified in the open-manhole command. | |||||
| whitelist: | |||||
| - 0 | |||||
| signal: | signal: | ||||
| # Path to signald unix socket | # Path to signald unix socket | ||||
| socket_path: /signald/signald.sock | socket_path: /signald/signald.sock | ||||
| @@ -91,6 +103,8 @@ signal: | |||||
| delete_unknown_accounts_on_start: false | delete_unknown_accounts_on_start: false | ||||
| # Whether or not message attachments should be removed from disk after they're bridged. | # Whether or not message attachments should be removed from disk after they're bridged. | ||||
| remove_file_after_handling: true | remove_file_after_handling: true | ||||
| # Whether or not users can register a primary device | |||||
| registration_enabled: true | |||||
| # Bridge config | # Bridge config | ||||
| bridge: | bridge: | ||||
| @@ -102,6 +116,7 @@ bridge: | |||||
| # available variable in displayname_preference. The variables in displayname_preference | # available variable in displayname_preference. The variables in displayname_preference | ||||
| # can also be used here directly. | # can also be used here directly. | ||||
| displayname_template: "{displayname} (Signal)" | displayname_template: "{displayname} (Signal)" | ||||
| # Whether or not contact list displaynames should be used. | |||||
| # Possible values: disallow, allow, prefer | # Possible values: disallow, allow, prefer | ||||
| # | # | ||||
| # Multi-user instances are recommended to disallow contact list names, as otherwise there can | # Multi-user instances are recommended to disallow contact list names, as otherwise there can | ||||
| @@ -140,7 +155,7 @@ bridge: | |||||
| # If false, created portal rooms will never be federated. | # If false, created portal rooms will never be federated. | ||||
| federate_rooms: true | federate_rooms: true | ||||
| # End-to-bridge encryption support options. You must install the e2be optional dependency for | # End-to-bridge encryption support options. You must install the e2be optional dependency for | ||||
| # this to work. See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html | |||||
| # this to work. See https://github.com/tulir/mautrix-telegram/wiki/End‐to‐bridge-encryption | |||||
| encryption: | encryption: | ||||
| # Allow encryption, work in group chat rooms with e2ee enabled | # Allow encryption, work in group chat rooms with e2ee enabled | ||||
| allow: false | allow: false | ||||
| @@ -173,12 +188,38 @@ bridge: | |||||
| # This field will automatically be changed back to false after it, | # This field will automatically be changed back to false after it, | ||||
| # except if the config file is not writable. | # except if the config file is not writable. | ||||
| resend_bridge_info: false | resend_bridge_info: false | ||||
| # Interval at which to resync contacts. | |||||
| # Interval at which to resync contacts (in seconds). | |||||
| periodic_sync: 0 | periodic_sync: 0 | ||||
| # 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 prefix for commands. Only required in non-management rooms. | # The prefix for commands. Only required in non-management rooms. | ||||
| command_prefix: "!signal" | command_prefix: "!signal" | ||||
| # 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 Signal 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 `register` to log in." | |||||
| # Optional extra text sent when joining a management room. | |||||
| additional_help: "" | |||||
| # Send each message separately (for readability in some clients) | |||||
| management_room_multiple_messages: false | |||||
| # Permissions for using the bridge. | # Permissions for using the bridge. | ||||
| # Permitted values: | # Permitted values: | ||||
| # relay - Allowed to be relayed through the bridge, no access to commands. | # relay - Allowed to be relayed through the bridge, no access to commands. | ||||