diff --git a/roles/mautrix_signal/cfg.schema.json b/roles/mautrix_signal/cfg.schema.json new file mode 100644 index 0000000..2bbb5e9 --- /dev/null +++ b/roles/mautrix_signal/cfg.schema.json @@ -0,0 +1,158 @@ +{ + "nullable": false, + "type": "object", + "properties": { + "user_name": { + "nullable": false, + "type": "string", + "default": "mautrix" + }, + "directory": { + "nullable": false, + "type": "string", + "default": "/opt/mautrix-signal" + }, + "database": { + "nullable": false, + "type": "object", + "properties": { + "host": { + "nullable": false, + "type": "string", + "default": "localhost" + }, + "port": { + "nullable": false, + "type": "integer", + "default": 5432 + }, + "username": { + "nullable": false, + "type": "string", + "default": "mautrix_signal_user" + }, + "password": { + "nullable": false, + "type": "string" + }, + "schema": { + "nullable": false, + "type": "string", + "default": "mautrix_signal" + } + }, + "additionalProperties": false, + "required": [ + "password" + ] + }, + "homeserver": { + "nullable": false, + "type": "object", + "properties": { + "address": { + "nullable": false, + "type": "string", + "default": "http://localhost:8008" + }, + "domain": { + "nullable": false, + "type": "string", + "default": "synapse.example.org" + }, + "conf_directory": { + "nullable": false, + "type": "string", + "default": "/etc/matrix-synapse/conf.d" + }, + "appservices_directory": { + "nullable": false, + "type": "string", + "default": "/etc/matrix-synapse/appservices.d" + }, + "user_name": { + "nullable": false, + "type": "string", + "default": "matrix-synapse" + }, + "service_name": { + "nullable": false, + "type": "string", + "default": "matrix-synapse" + } + }, + "additionalProperties": false, + "required": [ + ] + }, + "formats": { + "nullable": false, + "type": "object", + "properties": { + "displayname": { + "nullable": false, + "type": "string" + }, + "messages": { + "nullable": false, + "type": "object", + "properties": { + "displayname": { + "nullable": false, + "type": "string" + }, + "text": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }}: {{ .Message }}" + }, + "notice": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }}: {{ .Message }}" + }, + "emote": { + "nullable": false, + "type": "string", + "default": "* {{ .Sender.DisambiguatedName }} {{ .Message }}" + }, + "file": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }} sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}" + }, + "image": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }} sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}" + }, + "audio": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }} sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}" + }, + "video": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }} sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}" + }, + "location": { + "nullable": false, + "type": "string", + "default": "{{ .Sender.DisambiguatedName }} sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}" + } + }, + "additionalProperties": false, + "required": [ + ] + } + }, + "additionalProperties": false, + "required": [ + ] + } + }, + "additionalProperties": false, + "required": [ + ] +} diff --git a/roles/mautrix_signal/defaults/main.json b/roles/mautrix_signal/defaults/main.json new file mode 100644 index 0000000..cb313cb --- /dev/null +++ b/roles/mautrix_signal/defaults/main.json @@ -0,0 +1,33 @@ +{ + "cfg_mautrix_signal_defaults": { + "user_name": "mautrix", + "directory": "/opt/mautrix-signal", + "database": { + "host": "localhost", + "port": 5432, + "username": "mautrix_signal_user", + "schema": "mautrix_signal" + }, + "homeserver": { + "address": "http://localhost:8008", + "domain": "synapse.example.org", + "conf_directory": "/etc/matrix-synapse/conf.d", + "appservices_directory": "/etc/matrix-synapse/appservices.d", + "user_name": "matrix-synapse", + "service_name": "matrix-synapse" + }, + "formats": { + "displayname": "{{ .DisambiguatedName }}", + "messages": { + "text": "{{ .Sender.DisambiguatedName }}: {{ .Message }}", + "notice": "{{ .Sender.DisambiguatedName }}: {{ .Message }}", + "emote": "* {{ .Sender.DisambiguatedName }} {{ .Message }}", + "file": "{{ .Sender.DisambiguatedName }} sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}", + "image": "{{ .Sender.DisambiguatedName }} sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}", + "audio": "{{ .Sender.DisambiguatedName }} sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}", + "video": "{{ .Sender.DisambiguatedName }} sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}", + "location": "{{ .Sender.DisambiguatedName }} sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}" + } + } + } +} diff --git a/roles/mautrix_signal/tasks/main.json b/roles/mautrix_signal/tasks/main.json new file mode 100644 index 0000000..7520db9 --- /dev/null +++ b/roles/mautrix_signal/tasks/main.json @@ -0,0 +1,132 @@ +[ + { + "name": "show vars", + "when": "switch_show_vars", + "ansible.builtin.debug": { + "var": "vars.cfg_mautrix_signal" + } + }, + { + "name": "user", + "become": true, + "ansible.builtin.user": { + "name": "{{cfg_mautrix_signal.user_name}}", + "create_home": true, + "home": "{{cfg_mautrix_signal.directory}}" + } + }, + { + "name": "fetch", + "ansible.builtin.block": [ + { + "name": "download", + "ansible.builtin.get_url": { + "url": "https://mau.dev/mautrix/signal/-/jobs/artifacts/main/download?job=build%20amd64", + "dest": "/tmp/mautrix-signal.zip" + } + }, + { + "name": "unpack", + "ansible.builtin.unarchive": { + "remote_src": true, + "src": "/tmp/mautrix-signal.zip", + "dest": "{{cfg_mautrix_signal.directory}}" + } + } + ] + }, + { + "name": "conf", + "ansible.builtin.block": [ + { + "name": "conf | base", + "become": true, + "become_user": "{{cfg_mautrix_signal.user_name}}", + "ansible.builtin.template": { + "src": "config.yaml.j2", + "dest": "{{cfg_mautrix_signal.directory}}/config.yaml" + } + }, + { + "name": "conf | appservice registration | generate", + "become": true, + "become_user": "{{cfg_mautrix_signal.user_name}}", + "ansible.builtin.command": { + "chdir": "{{cfg_mautrix_signal.directory}}", + "cmd": "./mautrix-signal --generate-registration --config {{cfg_mautrix_signal.directory}}/config.yaml --registration /tmp/registration.yaml" + } + }, + { + "name": "conf | appservice registration | adjust", + "become": true, + "ansible.builtin.file": { + "path": "/tmp/registration.yaml", + "dest": "{{cfg_mautrix_signal.directory}}/registration.yaml", + "owner": "{{cfg_mautrix_signal.homeserver.user_name}}" + } + } + ] + }, + { + "name": "matrix homeserver", + "ansible.builtin.block": [ + { + "name": "matrix homeserver | appservice directory", + "become": true, + "ansible.builtin.file": { + "mode": "directory", + "path": "{{cfg_mautrix_signal.homeserver.appservices_directory}}", + "owner": "{{cfg_mautrix_signal.homeserver.user_name}}" + } + }, + { + "name": "matrix homeserver | insert appservice registration | copy to destination", + "become": true, + "ansible.builtin.copy": { + "remote_src": true, + "src": "{{cfg_mautrix_signal.directory}}/registration.yaml", + "dest": "{{cfg_mautrix_signal.homeserver.appservices_directory}}/bridge-mautrix-signal.yaml", + "owner": "{{cfg_mautrix_signal.homeserver.user_name}}" + } + }, + { + "name": "matrix homeserver | insert appservice registration | delete source", + "become": true, + "ansible.builtin.file": { + "mode": "absent", + "path": "{{cfg_mautrix_signal.directory}}/registration.yaml" + } + }, + { + "become": true, + "ansible.builtin.template": { + "src": "matrix-appservice.yaml.j2", + "dest": "{{cfg_mautrix_signal.homeserver.conf_directory}}/bridge-mautrix-signal.yaml", + "owner": "{{cfg_mautrix_signal.homeserver.user_name}}" + } + } + ] + }, + { + "name": "service", + "ansible.builtin.block": [ + { + "name": "service | define", + "become": true, + "ansible.builtin.template": { + "src": "systemd-unit.j2", + "dest": "/etc/systemd/system/mautrix-signal.service" + } + }, + { + "name": "service | start", + "become": true, + "ansible.builtin.systemd_service": { + "enabled": true, + "state": "started", + "name": "mautrix-signal" + } + } + ] + } +] diff --git a/roles/mautrix_signal/templates/config.yaml.j2 b/roles/mautrix_signal/templates/config.yaml.j2 new file mode 100644 index 0000000..b812865 --- /dev/null +++ b/roles/mautrix_signal/templates/config.yaml.j2 @@ -0,0 +1,500 @@ +# Network-specific config options +network: + # Displayname template for Signal users. + # {{.ProfileName}} - The Signal profile name set by the user. + # {{.ContactName}} - The name for the user from your phone's contact list. This is not safe on multi-user instances. + # {{.Nickname}} - The nickname set for the user in the native Signal app. This is not safe on multi-user instances. + # {{.PhoneNumber}} - The phone number of the user. + # {{.UUID}} - The UUID of the Signal user. + # {{.AboutEmoji}} - The emoji set by the user in their profile. + displayname_template: '{{or .ProfileName .PhoneNumber "Unknown user"}}' + # Should avatars from the user's contact list be used? This is not safe on multi-user instances. + use_contact_avatars: false + # Should the bridge request the user's contact list from the phone on startup? + sync_contacts_on_startup: true + # Should the bridge sync ghost user info even if profile fetching fails? This is not safe on multi-user instances. + use_outdated_profiles: false + # Should the Signal user's phone number be included in the room topic in private chat portal rooms? + number_in_topic: true + # Default device name that shows up in the Signal app. + device_name: mautrix-signal + # Avatar image for the Note to Self room. + note_to_self_avatar: mxc://maunium.net/REBIVrqjZwmaWpssCZpBlmlL + # Format for generating URLs from location messages for sending to Signal. + # Google Maps: 'https://www.google.com/maps/place/%[1]s,%[2]s' + # OpenStreetMap: 'https://www.openstreetmap.org/?mlat=%[1]s&mlon=%[2]s' + location_format: 'https://www.google.com/maps/place/%[1]s,%[2]s' + # Should view-once messages disappear shortly after sending a read receipt on Matrix? + disappear_view_once: false + # Should polls be sent using unstable MSC3381 event types? + extev_polls: false + + +# Config options that affect the central bridge module. +bridge: + # The prefix for commands. Only required in non-management rooms. + command_prefix: '!signal' + # Should the bridge create a space for each login containing the rooms that account is in? + personal_filtering_spaces: true + # 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: true + # 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. + # This is not yet safe to use. + 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. + # SETTING THIS IS IRREVERSIBLE AND POTENTIALLY DESTRUCTIVE IF PORTALS ALREADY EXIST. + split_portals: false + # Should the bridge resend `m.bridge` events to all portals on startup? + resend_bridge_info: false + # Should `m.bridge` events be sent without a state key? + # By default, the bridge uses a unique key that won't conflict with other bridges. + no_bridge_info_state_key: false + # Should bridge connection status be sent to the management room as `m.notice` events? + # These contain the same data that can be posted to an external HTTP server using homeserver -> status_endpoint. + # Allowed values: none, errors, all + bridge_status_notices: errors + # How long after an unknown error should the bridge attempt a full reconnect? + # Must be at least 1 minute. The bridge will add an extra ±20% jitter to this value. + unknown_error_auto_reconnect: null + + # Should leaving Matrix rooms be bridged as leaving groups on the remote network? + bridge_matrix_leave: false + # Should `m.notice` messages be bridged? + bridge_notices: 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 + # List of tags to allow bridging. If empty, no tags will be bridged. + only_bridge_tags: [m.favourite, m.lowpriority] + # 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 + # Should the bridge check the db to ensure that incoming events haven't been handled before + deduplicate_matrix_messages: false + # Should cross-room reply metadata be bridged? + # Most Matrix clients don't support this and servers may reject such messages too. + cross_room_replies: false + # If a state event fails to bridge, should the bridge revert any state changes made by that event? + revert_failed_state_changes: false + # In portals with no relay set, should Matrix users be kicked if they're + # not logged into an account that's in the remote chat? + kick_matrix_users: 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: "{{cfg_mautrix_signal.formats.messages.text}}" + m.notice: "{{cfg_mautrix_signal.formats.messages.notice}}" + m.emote: "{{cfg_mautrix_signal.formats.messages.emote}}" + m.file: "{{cfg_mautrix_signal.formats.messages.file}}" + m.image: "{{cfg_mautrix_signal.formats.messages.image}}" + m.audio: "{{cfg_mautrix_signal.formats.messages.audio}}" + m.video: "{{cfg_mautrix_signal.formats.messages.video}}" + m.location: "{{cfg_mautrix_signal.formats.messages.location}}" + # 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: "{{cfg_mautrix_signal.formats.displayname}}" + + # 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: + "*": relay + "example.com": user + "@admin:example.com": admin + +# 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:?_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://{{cfg_mautrix_signal.database.username}}:{{cfg_mautrix_signal.database.password}}@{{cfg_mautrix_signal.database.host}}:{{cfg_mautrix_signal.database.port | string}}/{{cfg_mautrix_signal.database.schema}}?sslmode=disable + # 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. + # 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: {{cfg_mautrix_signal.homeserver.address}} + # The domain of the homeserver (also known as server_name, used for MXIDs, etc). + domain: {{cfg_mautrix_signal.homeserver.domain}} + + # 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 remote network connection state changes. + # The bridge will use the appservice as_token to authorize requests. + status_endpoint: + # Endpoint for reporting per-message status. + # 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 + + # Should the bridge use a websocket for connecting to the homeserver? + # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy, + # mautrix-asmux (deprecated), and hungryserv (proprietary). + websocket: false + # How often should the websocket be pinged? Pinging will be disabled if this is zero. + ping_interval_seconds: 0 + +# Application service host/registration related details. +# 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. + # Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine. + # If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard) + # If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in. + address: http://localhost:29328 + # A public address that external services can use to reach this appservice. + # This is only needed for things like public media. A reverse proxy is generally necessary when using this field. + # 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: 127.0.0.1 + port: 29328 + + # The unique ID of this appservice. + id: signal + # Appservice bot details. + bot: + # Username of the appservice bot. + username: signalbot + # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty + # to leave display name/avatar as-is. + displayname: Signal bridge bot + avatar: mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp + + # Whether to receive ephemeral events via appservice transactions. + 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: "This value is generated when generating the registration" + hs_token: "This value is generated when generating the registration" + + # Localpart template of MXIDs for remote users. + # {{.}} is replaced with the internal ID of the user. + username_template: signal_{{.}} + +# Config options that affect the Matrix connector of the bridge. +matrix: + # 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. + sync_direct_chat_list: true + # Whether created rooms should have federation enabled. If false, created portal rooms + # will never be federated. Changing this option requires recreating rooms. + federate_rooms: true + # The threshold as bytes after which the bridge should roundtrip uploads via the disk + # rather than keeping the whole file in memory. + upload_file_threshold: 5242880 + +# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors. +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 + +# Settings for provisioning API +provisioning: + # Shared secret for authentication. If set to "generate" or null, a random secret will be generated, + # or if set to "disable", the provisioning API will be disabled. Must be at least 16 characters. + shared_secret: generate + # Whether to allow provisioning API requests to be authed using Matrix access tokens. + # This follows the same rules as double puppeting to determine which server to contact to check the token, + # which means that by default, it only works for users on the same server as the bridge. + allow_matrix_auth: true + # Enable debug API at /debug with provisioning authentication. + debug_endpoints: false + # Enable session transfers between bridges. Note that this only validates Matrix or shared secret + # auth before passing live network client credentials down in the response. + enable_session_transfers: 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: generate + # 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 + # The path prefix for generated URLs. Note that this will NOT change the path where media is actually served. + # If you change this, you must configure your reverse proxy to rewrite the path accordingly. + path_prefix: /_mautrix/publicmedia + # Should the bridge store media metadata in the database in order to support encrypted media and generate shorter URLs? + # If false, the generated URLs will just have the MXC URI and a HMAC signature. + # The hash_length field will be used to decide the length of the generated URL. + # This also allows invalidating URLs by deleting the database entry. + use_database: false + +# 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: discord-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: generate + +# 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: false + # Maximum number of messages to backfill in empty rooms. + max_initial_messages: 50 + # Maximum number of missed messages to backfill after bridge restarts. + max_catchup_messages: 500 + # 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: 720 + # Settings for backfilling threads within other backfills. + threads: + # Maximum number of messages to backfill in a new thread. + max_initial_messages: 50 + # 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: + anotherserver.example.org: https://matrix.anotherserver.example.org + # 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: + example.com: as_token:foobar + +# End-to-bridge encryption support options. +# +# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info. +encryption: + # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms. + allow: false + # Whether to force-enable encryption in all bridged rooms. + default: false + # Whether to require all messages to be encrypted and drop any unencrypted messages. + require: false + # Whether to use MSC3202/MSC4203 instead of /sync long polling for receiving encryption-related data. + # This option is not yet compatible with standard Matrix servers like Synapse and should not be used. + # Changing this option requires updating the appservice registration file. + appservice: false + # Whether to use MSC4190 instead of appservice login to create the bridge bot device. + # Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202. + # Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861). + # Changing this option requires updating the appservice registration file. + msc4190: false + # Should the bridge bot generate a recovery key and cross-signing keys and verify itself? + # Note that without the latest version of MSC4190, this will fail if you reset the bridge database. + # The generated recovery key will be saved in the kv_store table under `recovery_key`. + self_sign: 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: true + # Pickle key for encrypting encryption keys in the bridge database. + # If set to generate, a random key will be generated. + pickle_key: generate + # Options for deleting megolm sessions from the bridge. + delete_keys: + # Beeper-specific: delete outbound sessions when hungryserv confirms + # that the user has uploaded the key to key backup. + delete_outbound_on_ack: false + # Don't store outbound sessions in the inbound table. + dont_store_outbound: false + # Ratchet megolm sessions forward after decrypting messages. + ratchet_on_decrypt: false + # Delete fully used keys (index >= max_messages) after decrypting messages. + delete_fully_used_on_decrypt: false + # Delete previous megolm sessions from same device when receiving a new one. + delete_prev_on_new_session: false + # Delete megolm sessions received from a device when the device is deleted. + delete_on_device_delete: false + # Periodically delete megolm sessions when 2x max_age has passed since receiving the session. + periodically_delete_expired: false + # Delete inbound megolm sessions that don't have the received_at field used for + # automatic ratcheting and expired session deletion. This is meant as a migration + # to delete old keys prior to the bridge update. + delete_outdated_inbound: 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 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 configure the m.room.encryption event content. + # See https://spec.matrix.org/v1.10/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 + # 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 + +# Prefix for environment variables. All variables with this prefix must map to valid config fields. +# Nesting in variable names is represented with a dot (.). +# If there are no dots in the name, two underscores (__) are replaced with a dot. +# +# e.g. if the prefix is set to `BRIDGE_`, then `BRIDGE_APPSERVICE__AS_TOKEN` will set appservice.as_token. +# `BRIDGE_appservice.as_token` would work as well, but can't be set in a shell as easily. +# +# If this is null, reading config fields from environment will be disabled. +env_config_prefix: null + +# 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/bridge.log + max_size: 100 + max_backups: 10 + compress: false diff --git a/roles/mautrix_signal/templates/matrix-appservice.yaml.j2 b/roles/mautrix_signal/templates/matrix-appservice.yaml.j2 new file mode 100644 index 0000000..418993d --- /dev/null +++ b/roles/mautrix_signal/templates/matrix-appservice.yaml.j2 @@ -0,0 +1 @@ +app_service_config_files: [{{cfg_mautrix_signal.homeserver.appservices_directory}}/bridge-mautrix-signal.yaml] diff --git a/roles/mautrix_signal/templates/systemd-unit.j2 b/roles/mautrix_signal/templates/systemd-unit.j2 new file mode 100644 index 0000000..b4e73ad --- /dev/null +++ b/roles/mautrix_signal/templates/systemd-unit.j2 @@ -0,0 +1,12 @@ +[Unit] +Description=Mautrix Signal +After=multi-user.target + +[Service] +WorkingDirectory={{cfg_mautrix_signal.directory}} +User={{cfg_mautrix_signal.user_name}} +ExecStart={{cfg_mautrix_signal.directory}}/mautrix-signal +SyslogIdentifier=mautrix-signal + +[Install] +WantedBy=multi-user.target diff --git a/roles/postgresql-for-mautrix_signal/cfg.schema.json b/roles/postgresql-for-mautrix_signal/cfg.schema.json new file mode 100644 index 0000000..eff95bb --- /dev/null +++ b/roles/postgresql-for-mautrix_signal/cfg.schema.json @@ -0,0 +1,24 @@ +{ + "nullable": false, + "type": "object", + "properties": { + "username": { + "nullable": false, + "type": "string", + "default": "mautrix_signal_user" + }, + "password": { + "nullable": false, + "type": "string" + }, + "schema": { + "nullable": false, + "type": "string", + "default": "mautrix_signal" + } + }, + "additionalProperties": false, + "required": [ + "password" + ] +} diff --git a/roles/postgresql-for-mautrix_signal/defaults/main.json b/roles/postgresql-for-mautrix_signal/defaults/main.json new file mode 100644 index 0000000..a2d195d --- /dev/null +++ b/roles/postgresql-for-mautrix_signal/defaults/main.json @@ -0,0 +1,6 @@ +{ + "cfg_postgresql_for_mautrix_signal_defaults": { + "username": "mautrix_signal_user", + "schema": "mautrix_signal" + } +} diff --git a/roles/postgresql-for-mautrix_signal/tasks/main.json b/roles/postgresql-for-mautrix_signal/tasks/main.json new file mode 100644 index 0000000..ed98a56 --- /dev/null +++ b/roles/postgresql-for-mautrix_signal/tasks/main.json @@ -0,0 +1,49 @@ +[ + { + "name": "packages", + "become": true, + "ansible.builtin.apt": { + "update_cache": true, + "pkg": [ + "acl", + "python3-psycopg2" + ] + } + }, + { + "name": "user", + "become": true, + "become_user": "postgres", + "community.postgresql.postgresql_user": { + "state": "present", + "name": "{{cfg_postgresql_for_mautrix_signal.username}}", + "password": "{{cfg_postgresql_for_mautrix_signal.password}}" + }, + "environment": { + "PGOPTIONS": "-c password_encryption=scram-sha-256" + } + }, + { + "name": "schema", + "become": true, + "become_user": "postgres", + "community.postgresql.postgresql_db": { + "state": "present", + "name": "{{cfg_postgresql_for_mautrix_signal.schema}}", + "owner": "{{cfg_postgresql_for_mautrix_signal.username}}" + } + }, + { + "name": "rights", + "become": true, + "become_user": "postgres", + "community.postgresql.postgresql_privs": { + "state": "present", + "login_db": "{{cfg_postgresql_for_mautrix_signal.schema}}", + "objs": "ALL_IN_SCHEMA", + "roles": "{{cfg_postgresql_for_mautrix_signal.username}}", + "privs": "ALL", + "grant_option": true + } + } +]