From 8d9cac323ac6d8445a1f83fea0f092f0a31068fc Mon Sep 17 00:00:00 2001 From: Jade Ellis Date: Sat, 5 Oct 2024 01:31:28 +0100 Subject: [PATCH] mautrix-discord bridge --- servers/containers/conduwuit.container | 2 +- servers/containers/mautrix-discord.container | 47 +++ servers/mautrix/discord/config.yaml | 366 +++++++++++++++++++ servers/mautrix/discord/registration.yaml | 14 + 4 files changed, 428 insertions(+), 1 deletion(-) create mode 100644 servers/containers/mautrix-discord.container create mode 100644 servers/mautrix/discord/config.yaml create mode 100644 servers/mautrix/discord/registration.yaml diff --git a/servers/containers/conduwuit.container b/servers/containers/conduwuit.container index b00daced..86754929 100644 --- a/servers/containers/conduwuit.container +++ b/servers/containers/conduwuit.container @@ -13,7 +13,7 @@ Image=ghcr.io/girlbossceo/conduwuit:latest ReadOnly=true Volume=/var/opt/conduwuit:/var/lib/conduwuit:z,U AutoUpdate=registry -Network=web.network +# Network=web.network # conduwuit uses quite a few file descriptors, and on some systems it defaults to 1024 Ulimit=nofile=1048567:1048567 diff --git a/servers/containers/mautrix-discord.container b/servers/containers/mautrix-discord.container new file mode 100644 index 00000000..16582e4e --- /dev/null +++ b/servers/containers/mautrix-discord.container @@ -0,0 +1,47 @@ + + +[Unit] +Description=Matrix Discord Bridge +Wants=network-online.target +After=network-online.target +Documentation=https://github.com/mautrix/discord + +[Container] +ContainerName=mautrix-discord +Image=dock.mau.dev/mautrix/discord:latest +Volume=/var/opt/mautrix/discord:/data:z +AutoUpdate=registry +# Network=web.network + +Label="traefik.enable=true" +Label="traefik.http.routers.mautrix-discord.rule=Host(`mautrix-discord.ellis.link`)" + +Label="traefik.http.routers.mautrix-discord.entrypoints=https" +Label="traefik.http.services.mautrix-discord.loadbalancer.server.port=29334" + +Label="traefik.http.routers.mautrix-discord.tls.certresolver=letsencrypt" +# Label="traefik.http.routers.mautrix-discord.tls.options=intermediate@file" + +Label="traefik.http.routers.mautrix-discord.middlewares=default@file" + +Label="homepage.group=Services" +Label="homepage.name=mautrix-discord" +# Label="homepage.href=https://jade.ellis.link/" +# Label="homepage.siteMonitor=https://matrix.ellis.link/client/server.json" +Label="homepage.description=Matrix bridge" + +StopTimeout=100 + +[Service] + +Restart=on-failure +RestartSec=5 + +TimeoutStopSec=2m +TimeoutStartSec=2m + +# StartLimitInterval=1m +StartLimitBurst=5 + +[Install] +WantedBy=default.target \ No newline at end of file diff --git a/servers/mautrix/discord/config.yaml b/servers/mautrix/discord/config.yaml new file mode 100644 index 00000000..f9a41924 --- /dev/null +++ b/servers/mautrix/discord/config.yaml @@ -0,0 +1,366 @@ +# Homeserver details. +homeserver: + # The address that this appservice can use to connect to the homeserver. + address: https://matrix.ellis.link + # address: http://conduwuit + # The domain of the homeserver (also known as server_name, used for MXIDs, etc). + domain: ellis.link + + # 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 discord 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? + # Doesn't seem to show up in conduwuit source as of 032b199 + 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. +appservice: + # The address that the homeserver can use to connect to this appservice. + address: https://mautrix-discord.ellis.link + # address: http://mautrix-discord + + # The hostname and port where this appservice should listen. + hostname: 0.0.0.0 + port: 29334 + + # Database config. + database: + # The database type. "sqlite3-fk-wal" and "postgres" are supported. + type: sqlite3-fk-wal + # 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: file:/data/mautrix-discord.db?_txlock=immediate + # 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: mautrix-discord + # Appservice bot details. + bot: + # Username of the appservice bot. + username: discordbot + # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty + # to leave display name/avatar as-is. + displayname: remove + avatar: mxc://maunium.net/nIdEykemnwdisvHbpxflpDlC + # Whether or not 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. + async_transactions: false + + # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. + as_token: "BeqHdZlIs5kscUgQG03TxLO6dWjjuFKTL0T0T5CGoBNxUfsAaYMGuNONgzrvXSni" + hs_token: "IvmSDAdVFV63hR7hjQDEDOptyyNm81JRvkr3l5l653lWG0MLJKlOc7mbNm0extWA" + +# Bridge config +bridge: + # Localpart template of MXIDs for Discord users. + # {{.}} is replaced with the internal ID of the Discord user. + username_template: discord_mautrix_{{.}} + # Displayname template for Discord users. This is also used as the room name in DMs if private_chat_portal_meta is enabled. + # Available variables: + # .ID - Internal user ID + # .Username - Legacy display/username on Discord + # .GlobalName - New displayname on Discord + # .Discriminator - The 4 numbers after the name on Discord + # .Bot - Whether the user is a bot + # .System - Whether the user is an official system user + # .Webhook - Whether the user is a webhook and is not an application + # .Application - Whether the user is an application + displayname_template: '{{or .GlobalName .Username}}{{if .Bot}} (bot){{end}}' + # Displayname template for Discord channels (bridged as rooms, or spaces when type=4). + # Available variables: + # .Name - Channel name, or user displayname (pre-formatted with displayname_template) in DMs. + # .ParentName - Parent channel name (used for categories). + # .GuildName - Guild name. + # .NSFW - Whether the channel is marked as NSFW. + # .Type - Channel type (see values at https://github.com/bwmarrin/discordgo/blob/v0.25.0/structs.go#L251-L267) + channel_name_template: '{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else}}#{{.Name}}{{end}}' + # Displayname template for Discord guilds (bridged as spaces). + # Available variables: + # .Name - Guild name + guild_name_template: '{{.Name}}' + # 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 + # Publicly accessible base URL that Discord can use to reach the bridge, used for avatars in relay mode. + # If not set, avatars will not be bridged. Only the /mautrix-discord/avatar/{server}/{id}/{hash} endpoint is used on this address. + # This should not have a trailing slash, the endpoint above will be appended to the provided address. + public_address: https://mautrix-discord.ellis.link + # A random key used to sign the avatar URLs. The bridge will only accept requests with a valid signature. + avatar_proxy_key: s2cgqrmDGTxj0vTws8mCdQHHca63pLPy + portal_message_buffer: 128 + # Number of private channel portals to create on bridge startup. + # Other portals will be created when receiving messages. + startup_private_channel_create_limit: 5 + # Should the bridge send a read receipt from the bridge bot when a message has been sent to Discord? + delivery_receipts: true + # 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 + # Should the bridge use space-restricted join rules instead of invite-only for guild rooms? + # This can avoid unnecessary invite events in guild rooms when members are synced in. + restricted_rooms: true + # Should the bridge automatically join the user to threads on Discord when the thread is opened on Matrix? + # This only works with clients that support thread read receipts (MSC3771 added in Matrix v1.4). + autojoin_thread_on_open: true + # Should inline fields in Discord embeds be bridged as HTML tables to Matrix? + # Tables aren't supported in all clients, but are the only way to emulate the Discord inline field UI. + embed_fields_as_tables: true + # Should guild channels be muted when the portal is created? This only meant for single-user instances, + # it won't mute it for all users if there are multiple Matrix users in the same Discord guild. + mute_channels_on_create: false + # 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 + # 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 + # Should incoming custom emoji reactions be bridged as mxc:// URIs? + # If set to false, custom emoji reactions will be bridged as the shortcode instead, and the image won't be available. + custom_emoji_reactions: true + # Should the bridge attempt to completely delete portal rooms when a channel is deleted on Discord? + # If true, the bridge will try to kick Matrix users from the room. Otherwise, the bridge only makes ghosts leave. + delete_portal_on_channel_delete: false + # Should the bridge delete all portal rooms when you leave a guild on Discord? + # This only applies if the guild has no other Matrix users on this bridge instance. + delete_guild_on_leave: true + # Whether or not created rooms should have federation enabled. + # If false, created portal rooms will never be federated. + federate_rooms: true + # Prefix messages from webhooks with the profile info? This can be used along with a custom displayname_template + # to better handle webhooks that change their name all the time (like ones used by bridges). + prefix_webhook_messages: false + # Bridge webhook avatars? + enable_webhook_avatars: true + # Should the bridge upload media to the Discord CDN directly before sending the message when using a user token, + # like the official client does? The other option is sending the media in the message send request as a form part + # (which is always used by bots and webhooks). + use_discord_cdn_upload: true + # Should mxc uris copied from Discord be cached? + # This can be `never` to never cache, `unencrypted` to only cache unencrypted mxc uris, or `always` to cache everything. + # If you have a media repo that generates non-unique mxc uris, you should set this to never. + cache_media: unencrypted + # Settings for converting Discord 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: true + # 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: mautrix-discord.ellis.link + # Optionally a custom .well-known response. This defaults to `server_name:443` + well_known_response: + # The bridge supports MSC3860 media download redirects and will use them if the requester supports it. + # Optionally, you can force redirects and not allow proxying at all by setting this to false. + 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: ed25519 wlh4XQ t/6fWqm90c1nRzmD6StzwTIQFggIpmrpxD4qh1xiHZM + # Settings for converting animated stickers. + animated_sticker: + # Format to which animated stickers should be converted. + # disable - No conversion, send as-is (lottie JSON) + # png - converts to non-animated png (fastest) + # gif - converts to animated gif + # webm - converts to webm video, requires ffmpeg executable with vp9 codec and webm container support + # webp - converts to animated webp, requires ffmpeg executable with webp codec/container support + target: webp + # Arguments for converter. All converters take width and height. + args: + width: 320 + height: 320 + fps: 25 # only for webm, webp and gif (2, 5, 10, 20 or 25 recommended) + # 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 + # + # 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: + ellis.link: "as_token:fR52cysNJ2s7MbQ7PscEfHIyiW" + + # The prefix for commands. Only required in non-management rooms. + command_prefix: '!discord' + + # 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 Discord 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: "" + # Settings for backfilling messages. + backfill: + # Limits for forward backfilling. + forward_limits: + # Initial backfill (when creating portal). 0 means backfill is disabled. + # A special unlimited value is not supported, you must set a limit. Initial backfill will + # fetch all messages first before backfilling anything, so high limits can take a lot of time. + initial: + dm: 10000 + channel: 10000 + thread: 10000 + # Missed message backfill (on startup). + # 0 means backfill is disabled, -1 means fetch all messages since last bridged message. + # When using unlimited backfill (-1), messages are backfilled as they are fetched. + # With limits, all messages up to the limit are fetched first and backfilled afterwards. + missed: + dm: -1 + channel: -1 + thread: -1 + # Maximum members in a guild to enable backfilling. Set to -1 to disable limit. + # This can be used as a rough heuristic to disable backfilling in channels that are too active. + # Currently only applies to missed message backfill. + max_guild_members: -1 + + # 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: true + # 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 + # Should users mentions be in the event wire content to enable the server to send push notifications? + plaintext_mentions: false + # 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 WhatsApp 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 + # 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: KC4cswhfFcp59TP0Bdv1IEuw8lVPk7GXcyigzF8UBNAkPavCuiV6Khdg9dmcxD0W + # Enable debug API at /debug with provisioning authentication. + debug_endpoints: false + + # Permissions for using the bridge. + # Permitted values: + # relay - Talk through the relaybot (if enabled), no access otherwise + # user - Access to use the bridge to chat with a Discord account. + # admin - User level and some additional administration tools + # Permitted keys: + # * - All Matrix users + # domain - All users on that homeserver + # mxid - Specific user + permissions: + "*": relay + "ellis.link": user + "@jade:ellis.link": 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-discord.log + max_size: 100 + max_backups: 10 + compress: true \ No newline at end of file diff --git a/servers/mautrix/discord/registration.yaml b/servers/mautrix/discord/registration.yaml new file mode 100644 index 00000000..b6bdef96 --- /dev/null +++ b/servers/mautrix/discord/registration.yaml @@ -0,0 +1,14 @@ +id: mautrix-discord +url: http://mautrix-discord +as_token: 5ngb86SSXij50hLfnt1BC0K7NVmxiXlagCtmcXXVFFTqh76zUkX3FI7NyERXaAFD +hs_token: 1ni0upPYy21f5GTLvCGCvTqdYrv7d6NWiRvMaC2XahWluAL6fjqLvSCd5S3PiMsv +sender_localpart: K3hPufeGniHhdywShci90i8ZGRYu0YRF +rate_limited: false +namespaces: + users: + - regex: ^@discordbot:ellis\.link$ + exclusive: true + - regex: ^@discord_mautrix_.*:ellis\.link$ + exclusive: true +de.sorunome.msc2409.push_ephemeral: true +push_ephemeral: true \ No newline at end of file