diff --git a/CHANGELOG.md b/CHANGELOG.md index 1324fba9e..2aeeaaaaa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # 2025-11-04 +## The MX Puppet Discord bridge has been removed from the playbook + +The [mx-puppet-discord](./docs/configuring-playbook-bridge-mx-puppet-discord.md) bridge has been removed from the playbook, as it has been unmaintained for a long time more than several years and does not support important features like authenticated media. See [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3867) for the context. + +The playbook will let you know if you're using any `matrix_mx_puppet_discord_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the bridge manually](./docs/configuring-playbook-bridge-mx-puppet-discord.md#uninstalling-the-bridge-manually). + ## The MX Puppet Twitter bridge has been removed from the playbook The [mx-puppet-twitter](./docs/configuring-playbook-bridge-mx-puppet-twitter.md) bridge has been removed from the playbook, as it has been unmaintained for a long time more than several years and does not support important features like authenticated media. See [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3867) for the context. diff --git a/README.md b/README.md index 49fe94d17..91e8518a3 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | [Heisenbridge](https://github.com/hifi/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | [Link](docs/configuring-playbook-bridge-heisenbridge.md) | | [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) | ❌ | Bridge to [Slack](https://slack.com) | [Link](docs/configuring-playbook-bridge-mx-puppet-slack.md) | | [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) | ❌ | Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) | [Link](docs/configuring-playbook-bridge-mx-puppet-instagram.md) | -| [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-discord.md) | | [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md) | | [mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-steam.md) | | [Postmoogle](https://github.com/etkecc/postmoogle) | ❌ | Email to Matrix bridge | [Link](docs/configuring-playbook-bridge-postmoogle.md) | diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 8aeb188b4..6c4f77a73 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later # Setting up Appservice Discord bridging (optional) -**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook. +**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge supported by the playbook. - For using as a Bot we are recommend the Appservice Discord bridge (the one being discussed here), because it supports plumbing. - For personal use we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook. diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index 884b17afa..d53af91af 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -14,7 +14,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md) -**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridges supported by the playbook. +**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridge supported by the playbook. - For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing. - For personal use with a discord account we recommend the `mautrix-discord` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook. @@ -26,7 +26,7 @@ See the project's [documentation](https://docs.mau.fi/bridges/go/discord/index.h There are 2 ways to login to discord using this bridge, either by [scanning a QR code](#method-1-login-using-qr-code-recommended) using the Discord mobile app **or** by using a [Discord token](#method-2-login-using-discord-token-not-recommended). -If this is a dealbreaker for you, consider using one of the other Discord bridges supported by the playbook: [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) or [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). These come with their own complexity and limitations, however, so we recommend that you proceed with this one if possible. +If this is a dealbreaker for you, consider using [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). This comes with its own complexity and limitations, however, so we recommend that you proceed with this one if possible. ### Enable Appservice Double Puppet or Shared Secret Auth (optional) diff --git a/docs/configuring-playbook-bridge-mx-puppet-discord.md b/docs/configuring-playbook-bridge-mx-puppet-discord.md index 7285e8971..0613cd260 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-discord.md +++ b/docs/configuring-playbook-bridge-mx-puppet-discord.md @@ -1,51 +1,31 @@ -# Setting up MX Puppet Discord bridging (optional) +# Setting up MX Puppet Discord bridging (optional, removed) -**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md)and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook. -- For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing. -- For personal use with a discord account we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook. +🪦 The playbook used to be able to install and configure [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord), but no longer includes this component, as it has been unmaintained for a long time. -The playbook can install and configure [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) for you. +You may wish to use the [Mautrix Discord bridge](https://github.com/mautrix/discord) instead. -See the project's [documentation](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/blob/master/README.md) to learn what it does and why it might be useful to you. +## Uninstalling the bridge manually -## Adjusting the playbook configuration +If you still have the MX Puppet Discord bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server: -To enable the [Discord](https://discordapp.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: - -```yaml -matrix_mx_puppet_discord_enabled: true -``` - -## Installing - -After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: - - ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +systemctl disable --now matrix-mx-puppet-discord.service + +rm -rf /matrix/mx-puppet-discord + +/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mx_puppet_discord;' ``` - -The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` - -`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too. - -## Usage - -To use the bridge, you need to start a chat with `Discord Puppet Bridge` with the handle `@_discordpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). - -Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-discord [documentation](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) for more information about how to configure the bridge. - -Once logged in, send `list` to the bot user to list the available rooms. - -Clicking rooms in the list will result in you receiving an invitation to the bridged room. - -Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 9e6e59355..5302acc9a 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -178,8 +178,6 @@ Bridges can be used to connect your Matrix installation with third-party communi - [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md) -- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) - - [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md) - [Setting up Steam bridging](configuring-playbook-bridge-steam.md) @@ -285,6 +283,8 @@ Various services that don't fit any other categories. - [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-instagram](configuring-playbook-bridge-mautrix-meta-instagram.md)) +- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md)) + - [Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (removed; this component has been broken for a long time, so it has been removed from the playbook. Consider [setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)) - [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md)) diff --git a/docs/container-images.md b/docs/container-images.md index 6d8e47298..8e9cfbcb9 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -110,7 +110,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) | [hif1/heisenbridge](https://hub.docker.com/r/hif1/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | | [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) | [mx-puppet/slack/mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/container_registry) | ❌ | Bridge to [Slack](https://slack.com) | | [mx-puppet-instagram](configuring-playbook-bridge-mx-puppet-instagram.md) | [sorunome/mx-puppet-instagram](https://hub.docker.com/r/sorunome/mx-puppet-instagram) | ❌ | Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) | -| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) | | [mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md) | [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | | [matrix-steam-bridge](configuring-playbook-bridge-steam.md) | [jasonlaguidice/matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge/pkgs/container/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) | | [mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md) | [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | @@ -184,4 +183,5 @@ The list of the deprecated or unmaintained services is available [here](configur | [matrix-chatgpt-bot](configuring-playbook-bot-chatgpt.md) | [matrixgpt/matrix-chatgpt-bot](https://ghcr.io/matrixgpt/matrix-chatgpt-bot) | ❌ | Accessing ChatGPT via your favourite Matrix client | | [mautrix-facebook](configuring-playbook-bridge-mautrix-facebook.md) | [mautrix/facebook](https://mau.dev/mautrix/facebook/container_registry) | ❌ | Bridge to [Facebook](https://facebook.com/) | | [mautrix-instagram](configuring-playbook-bridge-mautrix-instagram.md) | [mautrix/instagram](https://mau.dev/mautrix/instagram/container_registry) | ❌ | Bridge to [Instagram](https://instagram.com/) | +| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) | | [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) | [sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter) | ❌ | Bridge for Twitter-DMs ([Twitter](https://twitter.com/)) | diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index c06964fdb..d9e0d3fe0 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -146,8 +146,6 @@ matrix_homeserver_container_extra_arguments_auto: | + (['--mount type=bind,src=' + matrix_mautrix_wsproxy_config_path + '/imessage-registration.yaml,dst=/matrix-mautrix-imessage-registration.yaml,ro'] if matrix_mautrix_wsproxy_enabled else []) + - (['--mount type=bind,src=' + matrix_mx_puppet_discord_config_path + '/registration.yaml,dst=/matrix-mx-puppet-discord-registration.yaml,ro'] if matrix_mx_puppet_discord_enabled else []) - + (['--mount type=bind,src=' + matrix_mx_puppet_groupme_config_path + '/registration.yaml,dst=/matrix-mx-puppet-groupme-registration.yaml,ro'] if matrix_mx_puppet_groupme_enabled else []) + (['--mount type=bind,src=' + matrix_mx_puppet_instagram_config_path + '/registration.yaml,dst=/matrix-mx-puppet-instagram-registration.yaml,ro'] if matrix_mx_puppet_instagram_enabled else []) @@ -217,8 +215,6 @@ matrix_homeserver_app_service_config_files_auto: | + (['/matrix-mautrix-imessage-registration.yaml'] if matrix_mautrix_wsproxy_enabled else []) + - (['/matrix-mx-puppet-discord-registration.yaml'] if matrix_mx_puppet_discord_enabled else []) - + (['/matrix-mx-puppet-groupme-registration.yaml'] if matrix_mx_puppet_groupme_enabled else []) + (['/matrix-mx-puppet-instagram-registration.yaml'] if matrix_mx_puppet_instagram_enabled else []) @@ -359,8 +355,6 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': 'matrix-mautrix-wsproxy-syncproxy.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'mautrix-wsproxy-syncproxy']}] if matrix_mautrix_wsproxy_enabled else []) + - ([{'name': 'matrix-mx-puppet-discord.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'mx-puppet-discord']}] if matrix_mx_puppet_discord_enabled else []) - + ([{'name': 'matrix-mx-puppet-groupme.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'mx-puppet-groupme']}] if matrix_mx_puppet_groupme_enabled else []) + ([{'name': 'matrix-mx-puppet-instagram.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'mx-puppet-instagram']}] if matrix_mx_puppet_instagram_enabled else []) @@ -2420,57 +2414,6 @@ matrix_mx_puppet_instagram_database_password: "{{ '%s' | format(matrix_homeserve # ###################################################################### -###################################################################### -# -# matrix-bridge-mx-puppet-discord -# -###################################################################### - -# We don't enable bridges by default. -matrix_mx_puppet_discord_enabled: false - -matrix_mx_puppet_discord_systemd_required_services_list_auto: | - {{ - matrix_addons_homeserver_systemd_services_list - + - ([postgres_identifier ~ '.service'] if (postgres_enabled and matrix_mx_puppet_discord_database_hostname == postgres_connection_hostname) else []) - }} - -matrix_mx_puppet_discord_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_mx_puppet_discord_docker_image_registry_prefix_upstream_default }}" - -matrix_mx_puppet_discord_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" - -matrix_mx_puppet_discord_container_network: "{{ matrix_addons_container_network }}" - -matrix_mx_puppet_discord_container_additional_networks_auto: |- - {{ - ( - ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network]) - + - ([postgres_container_network] if (postgres_enabled and matrix_mx_puppet_discord_database_hostname == postgres_connection_hostname and matrix_mx_puppet_discord_container_network != postgres_container_network) else []) - ) | unique - }} - -matrix_mx_puppet_discord_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.as.tok', rounds=655555) | to_uuid }}" - -matrix_mx_puppet_discord_homeserver_address: "{{ matrix_addons_homeserver_client_api_url }}" -matrix_mx_puppet_discord_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxdsc.hs.tok', rounds=655555) | to_uuid }}" - -matrix_mx_puppet_discord_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}" - -matrix_mx_puppet_discord_presence_enabled: "{{ matrix_homeserver_implementation != 'synapse' or matrix_synapse_presence_enabled }}" - -# Postgres is the default, except if not using internal Postgres server -matrix_mx_puppet_discord_database_engine: "{{ 'postgres' if postgres_enabled else 'sqlite' }}" -matrix_mx_puppet_discord_database_hostname: "{{ postgres_connection_hostname if postgres_enabled else '' }}" -matrix_mx_puppet_discord_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxpup.dsc.db', rounds=655555) | to_uuid }}" - -###################################################################### -# -# /matrix-bridge-mx-puppet-discord -# -###################################################################### - ###################################################################### # # matrix-bridge-mx-puppet-steam @@ -4329,12 +4272,6 @@ postgres_managed_databases_auto: | 'password': matrix_mx_puppet_instagram_database_password, }] if (matrix_mx_puppet_instagram_enabled and matrix_mx_puppet_instagram_database_engine == 'postgres' and matrix_mx_puppet_instagram_database_hostname == postgres_connection_hostname) else []) + - ([{ - 'name': matrix_mx_puppet_discord_database_name, - 'username': matrix_mx_puppet_discord_database_username, - 'password': matrix_mx_puppet_discord_database_password, - }] if (matrix_mx_puppet_discord_enabled and matrix_mx_puppet_discord_database_engine == 'postgres' and matrix_mx_puppet_discord_database_hostname == postgres_connection_hostname) else []) - + ([{ 'name': matrix_mx_puppet_steam_database_name, 'username': matrix_mx_puppet_steam_database_username, @@ -5231,10 +5168,6 @@ matrix_synapse_admin_config_asManagedUsers_auto: | '^@imessage_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', ] if matrix_mautrix_wsproxy_enabled else []) + - ([ - '^@_discordpuppet_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', - ] if matrix_mx_puppet_discord_enabled else []) - + ([ '^@_groupmepuppet_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', ] if matrix_mx_puppet_groupme_enabled else []) diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml deleted file mode 100644 index 196052d59..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml +++ /dev/null @@ -1,144 +0,0 @@ -# SPDX-FileCopyrightText: 2020 - 2024 MDAD project contributors -# SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev -# SPDX-FileCopyrightText: 2020 Hugues Morisset -# SPDX-FileCopyrightText: 2021 Ahmad Haghighi -# SPDX-FileCopyrightText: 2022 Daniel Sonck -# SPDX-FileCopyrightText: 2022 Marko Weltzer -# SPDX-FileCopyrightText: 2022 Nikita Chernyi -# SPDX-FileCopyrightText: 2023 Samuel Meenzen -# SPDX-FileCopyrightText: 2024 Suguru Hirahara -# -# SPDX-License-Identifier: AGPL-3.0-or-later - ---- -# Mx Puppet Discord is a Matrix <-> Discord bridge -# Project source code URL: https://gitlab.com/mx-puppet/discord/mx-puppet-discord - -matrix_mx_puppet_discord_enabled: true - -matrix_mx_puppet_discord_container_image_self_build: false -matrix_mx_puppet_discord_container_image_self_build_repo: "https://gitlab.com/mx-puppet/discord/mx-puppet-discord.git" -matrix_mx_puppet_discord_container_image_self_build_version: "{{ 'main' if matrix_mx_puppet_discord_version == 'latest' else matrix_mx_puppet_discord_version }}" -matrix_mx_puppet_discord_container_image_self_build_dockerfile_path: "Dockerfile" - -# Controls whether the mx-puppet-discord container exposes its HTTP port (tcp/8432 in the container). -# -# Takes an ":" or "" value (e.g. "127.0.0.1:8432"), or empty string to not expose. -matrix_mx_puppet_discord_container_http_host_bind_port: '' - -# renovate: datasource=docker depName=registry.gitlab.com/mx-puppet/discord/mx-puppet-discord -matrix_mx_puppet_discord_version: v0.1.1 -matrix_mx_puppet_discord_docker_image: "{{ matrix_mx_puppet_discord_docker_image_registry_prefix }}mx-puppet/discord/mx-puppet-discord:{{ matrix_mx_puppet_discord_version }}" -matrix_mx_puppet_discord_docker_image_registry_prefix: "{{ 'localhost/' if matrix_mx_puppet_discord_container_image_self_build else matrix_mx_puppet_discord_docker_image_registry_prefix_upstream }}" -matrix_mx_puppet_discord_docker_image_registry_prefix_upstream: "{{ matrix_mx_puppet_discord_docker_image_registry_prefix_upstream_default }}" -matrix_mx_puppet_discord_docker_image_registry_prefix_upstream_default: "registry.gitlab.com/" -matrix_mx_puppet_discord_docker_image_force_pull: "{{ matrix_mx_puppet_discord_docker_image.endswith(':latest') }}" - -matrix_mx_puppet_discord_base_path: "{{ matrix_base_data_path }}/mx-puppet-discord" -matrix_mx_puppet_discord_config_path: "{{ matrix_mx_puppet_discord_base_path }}/config" -matrix_mx_puppet_discord_data_path: "{{ matrix_mx_puppet_discord_base_path }}/data" -matrix_mx_puppet_discord_docker_src_files_path: "{{ matrix_mx_puppet_discord_base_path }}/docker-src" - -matrix_mx_puppet_discord_appservice_port: "8432" - -matrix_mx_puppet_discord_homeserver_address: "" -matrix_mx_puppet_discord_homeserver_domain: '{{ matrix_domain }}' -matrix_mx_puppet_discord_appservice_address: 'http://matrix-mx-puppet-discord:{{ matrix_mx_puppet_discord_appservice_port }}' - -matrix_mx_puppet_discord_bridge_mediaUrl: "{{ matrix_homeserver_url }}" # noqa var-naming - -# "@alice:example.com" to allow a specific user -# "@.*:example.com" to allow users on a specific homeserver -# "@.*" to allow anyone -matrix_mx_puppet_discord_provisioning_whitelist: - - "@.*:{{ matrix_domain | regex_escape }}" - -# Leave empty to disable blacklist -# "@bob:example.com" to disallow a specific user -# "@.*:example.com" to disallow users on a specific homeserver -matrix_mx_puppet_discord_provisioning_blacklist: [] - -matrix_mx_puppet_discord_container_network: "" - -matrix_mx_puppet_discord_container_additional_networks: "{{ matrix_mx_puppet_discord_container_additional_networks_auto + matrix_mx_puppet_discord_container_additional_networks_custom }}" -matrix_mx_puppet_discord_container_additional_networks_auto: [] -matrix_mx_puppet_discord_container_additional_networks_custom: [] - -# A list of extra arguments to pass to the container -matrix_mx_puppet_discord_container_extra_arguments: [] - -# List of systemd services that matrix-puppet-discord.service depends on. -matrix_mx_puppet_discord_systemd_required_services_list: "{{ matrix_mx_puppet_discord_systemd_required_services_list_default + matrix_mx_puppet_discord_systemd_required_services_list_auto + matrix_mx_puppet_discord_systemd_required_services_list_custom }}" -matrix_mx_puppet_discord_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" -matrix_mx_puppet_discord_systemd_required_services_list_auto: [] -matrix_mx_puppet_discord_systemd_required_services_list_custom: [] - -# List of systemd services that matrix-puppet-discord.service wants -matrix_mx_puppet_discord_systemd_wanted_services_list: [] - -matrix_mx_puppet_discord_appservice_token: '' -matrix_mx_puppet_discord_homeserver_token: '' - -# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth). -matrix_mx_puppet_discord_login_shared_secret: '' - -matrix_mx_puppet_discord_presence_enabled: true -matrix_mx_puppet_discord_presence_interval: 5000 - -# Database configuration -matrix_mx_puppet_discord_database_engine: 'sqlite' - -matrix_mx_puppet_discord_sqlite_database_path_local: "{{ matrix_mx_puppet_discord_data_path }}/database.db" -matrix_mx_puppet_discord_sqlite_database_path_in_container: "/data/database.db" - -matrix_mx_puppet_discord_database_username: matrix_mx_puppet_discord -matrix_mx_puppet_discord_database_password: ~ -matrix_mx_puppet_discord_database_hostname: '' -matrix_mx_puppet_discord_database_port: 5432 -matrix_mx_puppet_discord_database_name: matrix_mx_puppet_discord -matrix_mx_puppet_discord_database_sslmode: disable - -matrix_mx_puppet_discord_database_connection_string: 'postgresql://{{ matrix_mx_puppet_discord_database_username }}:{{ matrix_mx_puppet_discord_database_password }}@{{ matrix_mx_puppet_discord_database_hostname }}:{{ matrix_mx_puppet_discord_database_port }}/{{ matrix_mx_puppet_discord_database_name }}?sslmode={{ matrix_mx_puppet_discord_database_sslmode }}' - -# Default configuration template which covers the generic use case. -# You can customize it by controlling the various variables inside it. -# -# For a more advanced customization, you can extend the default (see `matrix_mx_puppet_discord_configuration_extension_yaml`) -# or completely replace this variable with your own template. -matrix_mx_puppet_discord_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}" - -matrix_mx_puppet_discord_configuration_extension_yaml: | - # Your custom YAML configuration goes here. - # This configuration extends the default starting configuration (`matrix_mx_puppet_discord_configuration_yaml`). - # - # You can override individual variables from the default configuration, or introduce new ones. - # - # If you need something more special, you can take full control by - # completely redefining `matrix_mx_puppet_discord_configuration_yaml`. - -matrix_mx_puppet_discord_configuration_extension: "{{ matrix_mx_puppet_discord_configuration_extension_yaml | from_yaml if matrix_mx_puppet_discord_configuration_extension_yaml | from_yaml is mapping else {} }}" - -# Holds the final configuration (a combination of the default and its extension). -# You most likely don't need to touch this variable. Instead, see `matrix_mx_puppet_discord_configuration_yaml`. -matrix_mx_puppet_discord_configuration: "{{ matrix_mx_puppet_discord_configuration_yaml | from_yaml | combine(matrix_mx_puppet_discord_configuration_extension, recursive=True) }}" - -matrix_mx_puppet_discord_registration_yaml: | - as_token: "{{ matrix_mx_puppet_discord_appservice_token }}" - hs_token: "{{ matrix_mx_puppet_discord_homeserver_token }}" - id: discord-puppet - namespaces: - users: - - exclusive: true - regex: '@_discordpuppet_.*:{{ matrix_mx_puppet_discord_homeserver_domain | regex_escape }}' - rooms: [] - aliases: - - exclusive: true - regex: '#_discordpuppet_.*:{{ matrix_mx_puppet_discord_homeserver_domain | regex_escape }}' - protocols: [] - rate_limited: false - sender_localpart: _discordpuppet_bot - url: {{ matrix_mx_puppet_discord_appservice_address }} - de.sorunome.msc2409.push_ephemeral: true - receive_ephemeral: true - -matrix_mx_puppet_discord_registration: "{{ matrix_mx_puppet_discord_registration_yaml | from_yaml }}" diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/main.yml b/roles/custom/matrix-bridge-mx-puppet-discord/tasks/main.yml deleted file mode 100644 index 67e4948e4..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/main.yml +++ /dev/null @@ -1,26 +0,0 @@ -# SPDX-FileCopyrightText: 2020 Hugues Morisset -# SPDX-FileCopyrightText: 2022 - 2023 Slavi Pantaleev -# SPDX-FileCopyrightText: 2022 Marko Weltzer -# -# SPDX-License-Identifier: AGPL-3.0-or-later - ---- - -- tags: - - setup-all - - setup-mx-puppet-discord - - install-all - - install-mx-puppet-discord - block: - - when: matrix_mx_puppet_discord_enabled | bool - ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" - - - when: matrix_mx_puppet_discord_enabled | bool - ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml" - -- tags: - - setup-all - - setup-mx-puppet-discord - block: - - when: not matrix_mx_puppet_discord_enabled | bool - ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/setup_install.yml b/roles/custom/matrix-bridge-mx-puppet-discord/tasks/setup_install.yml deleted file mode 100644 index d98a2628d..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/setup_install.yml +++ /dev/null @@ -1,144 +0,0 @@ -# SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev -# SPDX-FileCopyrightText: 2020 Hugues Morisset -# SPDX-FileCopyrightText: 2020 Stuart Mumford -# SPDX-FileCopyrightText: 2022 Jim Myhrberg -# SPDX-FileCopyrightText: 2022 Marko Weltzer -# SPDX-FileCopyrightText: 2022 Nikita Chernyi -# SPDX-FileCopyrightText: 2022 Sebastian Gumprich -# SPDX-FileCopyrightText: 2024 David Mehren -# -# SPDX-License-Identifier: AGPL-3.0-or-later - ---- - -- name: Ensure MX Puppet Discord paths exist - ansible.builtin.file: - path: "{{ item.path }}" - state: directory - mode: 0750 - owner: "{{ matrix_user_name }}" - group: "{{ matrix_group_name }}" - with_items: - - {path: "{{ matrix_mx_puppet_discord_base_path }}", when: true} - - {path: "{{ matrix_mx_puppet_discord_config_path }}", when: true} - - {path: "{{ matrix_mx_puppet_discord_data_path }}", when: true} - - {path: "{{ matrix_mx_puppet_discord_docker_src_files_path }}", when: "{{ matrix_mx_puppet_discord_container_image_self_build }}"} - when: matrix_mx_puppet_discord_enabled | bool and item.when | bool - -- name: Check if an old database file already exists - ansible.builtin.stat: - path: "{{ matrix_mx_puppet_discord_base_path }}/database.db" - register: matrix_mx_puppet_discord_stat_database - -- when: "matrix_mx_puppet_discord_stat_database.stat.exists" - block: - - name: (Data relocation) Ensure matrix-mx-puppet-discord.service is stopped - ansible.builtin.service: - name: matrix-mx-puppet-discord - state: stopped - daemon_reload: true - failed_when: false - - - name: (Data relocation) Move mx-puppet-discord database file to ./data directory - ansible.builtin.command: - cmd: "mv {{ matrix_mx_puppet_discord_base_path }}/database.db {{ matrix_mx_puppet_discord_data_path }}/database.db" - register: matrix_mx_puppet_discord_relocate_database_result - changed_when: matrix_mx_puppet_discord_relocate_database_result.rc == 0 - -- ansible.builtin.set_fact: - matrix_mx_puppet_discord_requires_restart: false - -- when: "matrix_mx_puppet_discord_database_engine == 'postgres'" - block: - - name: Check if an SQLite database already exists - ansible.builtin.stat: - path: "{{ matrix_mx_puppet_discord_sqlite_database_path_local }}" - register: matrix_mx_puppet_discord_sqlite_database_path_local_stat_result - - - when: "matrix_mx_puppet_discord_sqlite_database_path_local_stat_result.stat.exists | bool" - block: - - ansible.builtin.include_role: - name: galaxy/postgres - tasks_from: migrate_db_to_postgres - vars: - postgres_db_migration_request: - src: "{{ matrix_mx_puppet_discord_sqlite_database_path_local }}" - dst: "{{ matrix_mx_puppet_discord_database_connection_string }}" - caller: "{{ role_path | basename }}" - engine_variable_name: 'matrix_mx_puppet_discord_database_engine' - engine_old: 'sqlite' - systemd_services_to_stop: ['matrix-mx-puppet-discord.service'] - - - ansible.builtin.set_fact: - matrix_mx_puppet_discord_requires_restart: true - -- name: Ensure MX Puppet Discord image is pulled - community.docker.docker_image: - name: "{{ matrix_mx_puppet_discord_docker_image }}" - source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" - force_source: "{{ matrix_mx_puppet_discord_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" - force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mx_puppet_discord_docker_image_force_pull }}" - when: matrix_mx_puppet_discord_enabled | bool and not matrix_mx_puppet_discord_container_image_self_build - register: result - retries: "{{ devture_playbook_help_container_retries_count }}" - delay: "{{ devture_playbook_help_container_retries_delay }}" - until: result is not failed - -- name: Ensure MX Puppet Discord repository is present on self build - ansible.builtin.git: - repo: "{{ matrix_mx_puppet_discord_container_image_self_build_repo }}" - dest: "{{ matrix_mx_puppet_discord_docker_src_files_path }}" - force: "yes" - version: "{{ matrix_mx_puppet_discord_container_image_self_build_version }}" - become: true - become_user: "{{ matrix_user_name }}" - register: matrix_mx_puppet_discord_git_pull_results - when: "matrix_mx_puppet_discord_enabled | bool and matrix_mx_puppet_discord_container_image_self_build" - -- name: Ensure MX Puppet Discord Docker image is built - community.docker.docker_image: - name: "{{ matrix_mx_puppet_discord_docker_image }}" - source: build - force_source: "{{ matrix_mx_puppet_discord_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" - force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mx_puppet_discord_git_pull_results.changed }}" - build: - dockerfile: "{{ matrix_mx_puppet_discord_container_image_self_build_dockerfile_path }}" - path: "{{ matrix_mx_puppet_discord_docker_src_files_path }}" - pull: true - when: "matrix_mx_puppet_discord_enabled | bool and matrix_mx_puppet_discord_container_image_self_build | bool" - -- name: Ensure mx-puppet-discord config.yaml installed - ansible.builtin.copy: - content: "{{ matrix_mx_puppet_discord_configuration | to_nice_yaml(indent=2, width=999999) }}" - dest: "{{ matrix_mx_puppet_discord_config_path }}/config.yaml" - mode: 0644 - owner: "{{ matrix_user_name }}" - group: "{{ matrix_group_name }}" - -- name: Ensure mx-puppet-discord discord-registration.yaml installed - ansible.builtin.copy: - content: "{{ matrix_mx_puppet_discord_registration | to_nice_yaml(indent=2, width=999999) }}" - dest: "{{ matrix_mx_puppet_discord_config_path }}/registration.yaml" - mode: 0644 - owner: "{{ matrix_user_name }}" - group: "{{ matrix_group_name }}" - -- name: Ensure mx-puppet-discord container network is created - community.general.docker_network: - enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" - name: "{{ matrix_mx_puppet_discord_container_network }}" - driver: bridge - driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}" - -- name: Ensure matrix-mx-puppet-discord.service installed - ansible.builtin.template: - src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-discord.service.j2" - dest: "/etc/systemd/system/matrix-mx-puppet-discord.service" - mode: 0644 - -- name: Ensure matrix-mx-puppet-discord.service restarted, if necessary - ansible.builtin.service: - name: "matrix-mx-puppet-discord.service" - state: restarted - daemon_reload: true - when: "matrix_mx_puppet_discord_requires_restart | bool" diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/setup_uninstall.yml b/roles/custom/matrix-bridge-mx-puppet-discord/tasks/setup_uninstall.yml deleted file mode 100644 index 2deb391a0..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/setup_uninstall.yml +++ /dev/null @@ -1,26 +0,0 @@ -# SPDX-FileCopyrightText: 2020 Hugues Morisset -# SPDX-FileCopyrightText: 2021 - 2022 Slavi Pantaleev -# SPDX-FileCopyrightText: 2022 Marko Weltzer -# -# SPDX-License-Identifier: AGPL-3.0-or-later - ---- - -- name: Check existence of matrix-mx-puppet-discord service - ansible.builtin.stat: - path: "/etc/systemd/system/matrix-mx-puppet-discord.service" - register: matrix_mx_puppet_discord_service_stat - -- when: matrix_mx_puppet_discord_service_stat.stat.exists | bool - block: - - name: Ensure matrix-mx-puppet-discord is stopped - ansible.builtin.service: - name: matrix-mx-puppet-discord - state: stopped - enabled: false - daemon_reload: true - - - name: Ensure matrix-mx-puppet-discord.service doesn't exist - ansible.builtin.file: - path: "/etc/systemd/system/matrix-mx-puppet-discord.service" - state: absent diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/validate_config.yml b/roles/custom/matrix-bridge-mx-puppet-discord/tasks/validate_config.yml deleted file mode 100644 index ba90eb314..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/tasks/validate_config.yml +++ /dev/null @@ -1,26 +0,0 @@ -# SPDX-FileCopyrightText: 2020 Hugues Morisset -# SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev -# -# SPDX-License-Identifier: AGPL-3.0-or-later - ---- - -- name: Fail if required mx-puppet-discord settings not defined - ansible.builtin.fail: - msg: >- - You need to define a required configuration setting (`{{ item.name }}`). - when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0" - with_items: - - {'name': 'matrix_mx_puppet_discord_appservice_token', when: true} - - {'name': 'matrix_mx_puppet_discord_homeserver_address', when: true} - - {'name': 'matrix_mx_puppet_discord_homeserver_token', when: true} - - {'name': 'matrix_mx_puppet_discord_database_hostname', when: "{{ matrix_mx_puppet_discord_database_engine == 'postgres' }}"} - - {'name': 'matrix_mx_puppet_discord_container_network', when: true} - -- name: (Deprecation) Catch and report renamed mx-puppet-discord variables - ansible.builtin.fail: - msg: >- - The variable `{{ item.old }}` is deprecated. Please use `{{ item.new }}` instead. - when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0" - with_items: - - {'old': 'matrix_mx_puppet_discord_docker_image_name_prefix', 'new': 'matrix_mx_puppet_discord_docker_image_registry_prefix'} diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 deleted file mode 100644 index 2a1046417..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 +++ /dev/null @@ -1,125 +0,0 @@ -#jinja2: lstrip_blocks: True -bridge: - # Port to host the bridge on - # Used for communication between the homeserver and the bridge - port: {{ matrix_mx_puppet_discord_appservice_port }} - # The host connections to the bridge's webserver are allowed from - bindAddress: 0.0.0.0 - # Public domain of the homeserver - domain: {{ matrix_mx_puppet_discord_homeserver_domain }} - # Reachable URL of the Matrix homeserver - homeserverUrl: {{ matrix_mx_puppet_discord_homeserver_address }} - # Optionally specify a different media URL used for the media store - # - # This is where Discord will download user profile pictures and media - # from - mediaUrl: {{ matrix_mx_puppet_discord_bridge_mediaUrl }} - {% if matrix_mx_puppet_discord_login_shared_secret != '' %} - loginSharedSecretMap: - {{ matrix_domain }}: {{ matrix_mx_puppet_discord_login_shared_secret }} - {% endif %} - # Display name of the bridge bot - displayname: Discord Puppet Bridge - -presence: - # Bridge Discord online/offline status - enabled: {{ matrix_mx_puppet_discord_presence_enabled | to_json }} - # How often to send status to the homeserver in milliseconds - interval: {{ matrix_mx_puppet_discord_presence_interval | to_json }} - -provisioning: - # Regex of Matrix IDs allowed to use the puppet bridge - whitelist: {{ matrix_mx_puppet_discord_provisioning_whitelist|to_json }} - # Allow a specific user - #- "@alice:example\\.com" - # Allow users on a specific homeserver - #- "@.*:example\\.com" - # Allow anyone - #- ".*" - # Regex of Matrix IDs forbidden from using the puppet bridge - #blacklist: - # Disallow a specific user - #- "@bob:example\\.com" - # Disallow users on a specific homeserver - #- "@.*:example\\.com" - blacklist: {{ matrix_mx_puppet_discord_provisioning_blacklist|to_json }} - -relay: - # Regex of Matrix IDs who are allowed to use the bridge in relay mode. - # Relay mode is when a single Discord bot account relays messages of - # multiple Matrix users - # - # Same format as in provisioning - whitelist: {{ matrix_mx_puppet_discord_provisioning_whitelist|to_json }} - blacklist: {{ matrix_mx_puppet_discord_provisioning_blacklist|to_json }} - -selfService: - # Regex of Matrix IDs who are allowed to use bridge self-servicing (plumbed rooms) - # - # Same format as in provisioning - whitelist: {{ matrix_mx_puppet_discord_provisioning_whitelist|to_json }} - blacklist: {{ matrix_mx_puppet_discord_provisioning_blacklist|to_json }} - -# Override the default name patterns for users, rooms and groups -# -# Variable names must be prefixed with a ':' -namePatterns: - # The default displayname for a bridged user - # - # Available variables: - # - # name: username of the user - # discriminator: hashtag of the user (ex. #1234) - user: :name - - # A user's guild-specific displayname - if they've set a custom nick in - # a guild - # - # Available variables: - # - # name: username of the user - # discriminator: hashtag of the user (ex. #1234) - # displayname: the user's custom group-specific nick - # channel: the name of the channel - # guild: the name of the guild - userOverride: :name - - # Room names for bridged Discord channels - # - # Available variables: - # - # name: name of the channel - # guild: name of the guild - room: :name - - # Group names for bridged Discord servers - # - # Available variables: - # - # name: name of the guide - group: :name - -database: -{% if matrix_mx_puppet_discord_database_engine == 'sqlite' %} - # Use SQLite3 as a database backend - # The name of the database file - filename: {{ matrix_mx_puppet_discord_sqlite_database_path_in_container|to_json }} -{% else %} - # Use Postgres as a database backend - # If set, will be used instead of SQLite3 - # Connection string to connect to the Postgres instance - # with username "user", password "pass", host "localhost" and database name "dbname". - # Modify each value as necessary - connString: {{ matrix_mx_puppet_discord_database_connection_string|to_json }} -{% endif %} - -logging: - # Log level of console output - # Allowed values starting with most verbose: - # silly, debug, verbose, info, warn, error - console: warn - # Date and time formatting - lineDateFormat: MMM-D HH:mm:ss.SSS - # Logging files - # Log files are rotated daily by default - files: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2.license b/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2.license deleted file mode 100644 index 7b4bc3507..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2.license +++ /dev/null @@ -1,6 +0,0 @@ -SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev -SPDX-FileCopyrightText: 2020 Hugues Morisset -SPDX-FileCopyrightText: 2020 MDAD project contributors -SPDX-FileCopyrightText: 2022 Nikita Chernyi - -SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2 b/roles/custom/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2 deleted file mode 100644 index 200712092..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2 +++ /dev/null @@ -1,48 +0,0 @@ -#jinja2: lstrip_blocks: True -[Unit] -Description=Matrix Mx Puppet Discord bridge -{% for service in matrix_mx_puppet_discord_systemd_required_services_list %} -Requires={{ service }} -After={{ service }} -{% endfor %} -{% for service in matrix_mx_puppet_discord_systemd_wanted_services_list %} -Wants={{ service }} -{% endfor %} -DefaultDependencies=no - -[Service] -Type=simple -Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" -ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-mx-puppet-discord 2>/dev/null || true' -ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-mx-puppet-discord 2>/dev/null || true' - -ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ - --rm \ - --name=matrix-mx-puppet-discord \ - --log-driver=none \ - --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ - --cap-drop=ALL \ - --network={{ matrix_mx_puppet_discord_container_network }} \ - -e CONFIG_PATH=/config/config.yaml \ - -e REGISTRATION_PATH=/config/registration.yaml \ - --mount type=bind,src={{ matrix_mx_puppet_discord_config_path }},dst=/config \ - --mount type=bind,src={{ matrix_mx_puppet_discord_data_path }},dst=/data \ - {% for arg in matrix_mx_puppet_discord_container_extra_arguments %} - {{ arg }} \ - {% endfor %} - {{ matrix_mx_puppet_discord_docker_image }} - -{% for network in matrix_mx_puppet_discord_container_additional_networks %} -ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-mx-puppet-discord -{% endfor %} - -ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-mx-puppet-discord - -ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-mx-puppet-discord 2>/dev/null || true' -ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-mx-puppet-discord 2>/dev/null || true' -Restart=always -RestartSec=30 -SyslogIdentifier=matrix-mx-puppet-discord - -[Install] -WantedBy=multi-user.target diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2.license b/roles/custom/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2.license deleted file mode 100644 index 16b2b499b..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-discord/templates/systemd/matrix-mx-puppet-discord.service.j2.license +++ /dev/null @@ -1,5 +0,0 @@ -SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev -SPDX-FileCopyrightText: 2020 Hugues Morisset -SPDX-FileCopyrightText: 2020 Scott Crossen - -SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml index fe36251c5..8136be9d1 100644 --- a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml +++ b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml @@ -547,6 +547,18 @@ The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mautrix_hangouts_.+', wantlist=True) | join(', ') }} when: "lookup('ansible.builtin.varnames', '^matrix_mautrix_hangouts_.+', wantlist=True) | length > 0" +- name: (Deprecation) Catch and report mx-puppet-discord variables + ansible.builtin.fail: + msg: |- + The MX Puppet Discord bridge was completely removed from the playbook in November 2025. + + Please remove all `matrix_mx_puppet_discord_*` variables from your configuration file (vars.yml). + + You may also wish to uninstall the bridge manually. See `docs/configuring-playbook-bridge-mx-puppet-discord.md` for more information. + + The following variables in your configuration need to be removed: {{ lookup('ansible.builtin.varnames', '^matrix_mx_puppet_discord_.+', wantlist=True) | join(', ') }} + when: "lookup('ansible.builtin.varnames', '^matrix_mx_puppet_discord_.+', wantlist=True) | length > 0" + - name: (Deprecation) Catch and report mx-puppet-twitter variables ansible.builtin.fail: msg: |- diff --git a/setup.yml b/setup.yml index 95fd18493..e5addd5f3 100644 --- a/setup.yml +++ b/setup.yml @@ -75,7 +75,6 @@ - custom/matrix-bridge-mautrix-discord - custom/matrix-bridge-mautrix-slack - custom/matrix-bridge-mautrix-bluesky - - custom/matrix-bridge-mx-puppet-discord - custom/matrix-bridge-mx-puppet-groupme - custom/matrix-bridge-mx-puppet-steam - custom/matrix-bridge-mx-puppet-slack