Signed-off-by: Suguru Hirahara <did🔑z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>
pull/4931/head
| @@ -127,7 +127,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | |||
| | [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) | ❌ | Bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | [Link](docs/configuring-playbook-bridge-appservice-irc.md) | | |||
| | [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) | ❌ | Bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) | [Link](docs/configuring-playbook-bridge-appservice-kakaotalk.md) | | |||
| | [matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-appservice-discord.md) | | |||
| | [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) | ❌ | Bridge to [Slack](https://slack.com/) | [Link](docs/configuring-playbook-bridge-appservice-slack.md) | | |||
| | [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular | [Link](docs/configuring-playbook-bridge-hookshot.md) | | |||
| | [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) | ❌ | Bridge to SMS | [Link](docs/configuring-playbook-bridge-matrix-bridge-sms.md) | | |||
| | [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) | [Link](docs/configuring-playbook-bridge-steam.md) | | |||
| @@ -11,10 +11,6 @@ SPDX-License-Identifier: AGPL-3.0-or-later | |||
| <sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup> | |||
| **Note**: bridging to [Slack](https://slack.com/) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridge supported by the playbook. | |||
| - For using as a Bot we recommend the [Appservice Slack](configuring-playbook-bridge-appservice-slack.md), because it supports plumbing. Note that it is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued. | |||
| - For personal use with a slack account we recommend the `mautrix-slack` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Slack bridges supported by the playbook. | |||
| The playbook can install and configure [mautrix-slack](https://github.com/mautrix/slack) for you. | |||
| See the project's [documentation](https://docs.mau.fi/bridges/go/slack/index.html) to learn what it does and why it might be useful to you. | |||
| @@ -25,7 +21,7 @@ See the [features and roadmap](https://github.com/mautrix/slack/blob/main/ROADMA | |||
| For using this bridge, you would need to authenticate by **providing your username and password** (legacy) or by using a **token login**. See more information in the [docs](https://docs.mau.fi/bridges/go/slack/authentication.html). | |||
| Note that neither of these methods are officially supported by Slack. [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) uses a Slack bot account which is the only officially supported method for bridging a Slack channel. | |||
| Note that neither of these methods are officially supported by Slack. | |||
| ### Enable Appservice Double Puppet (optional) | |||
| @@ -162,8 +162,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | |||
| - [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) | |||
| - [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) | |||
| - [Setting up Appservice Kakaotalk bridging](configuring-playbook-bridge-appservice-kakaotalk.md) | |||
| - [Setting up Beeper LinkedIn bridging](configuring-playbook-bridge-beeper-linkedin.md) | |||
| @@ -263,6 +261,8 @@ Various services that don't fit any other categories. | |||
| - [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like old Element X versions, before it got switched to Simplified Sliding Sync) | |||
| - [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (removed; this component has been discontinued) | |||
| - [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (deprecated; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md)) | |||
| - [Setting up the Dimension integration manager](configuring-playbook-dimension.md) ([unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299); after [installing](installing.md)) | |||
| @@ -101,7 +101,6 @@ Bridges can be used to connect your Matrix installation with third-party communi | |||
| | [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) | [matrixdotorg/matrix-appservice-irc](https://hub.docker.com/r/matrixdotorg/matrix-appservice-irc) | ❌ | Bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | | |||
| | [matrix-appservice-kakaotalk](configuring-playbook-bridge-appservice-kakaotalk.md) | Self-building | ❌ | Bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) | | |||
| | [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) | [matrix-org/matrix-appservice-discord](https://ghcr.io/matrix-org/matrix-appservice-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | | |||
| | [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) | [matrixdotorg/matrix-appservice-slack](https://hub.docker.com/r/matrixdotorg/matrix-appservice-slack) | ❌ | Bridge to [Slack](https://slack.com/) | | |||
| | [matrix-hookshot](configuring-playbook-bridge-hookshot.md) | [halfshot/matrix-hookshot](https://hub.docker.com/r/halfshot/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular | | |||
| | [matrix-sms-bridge](configuring-playbook-bridge-matrix-bridge-sms.md) | [folivonet/matrix-sms-bridge](https://hub.docker.com/repository/docker/folivonet/matrix-sms-bridge) | ❌ | Bridge to SMS | | |||
| | [matrix-wechat](configuring-playbook-bridge-wechat.md) | [lxduo/matrix-wechat](https://hub.docker.com/r/lxduo/matrix-wechat) | ❌ | Bridge to [WeChat](https://www.wechat.com/) | | |||
| @@ -176,6 +175,7 @@ The list of the deprecated or unmaintained services is available [here](configur | |||
| | [Email2Matrix](configuring-playbook-email2matrix.md) | [devture/email2matrix](https://hub.docker.com/r/devture/email2matrix/) | ❌ | Bridge for relaying emails to Matrix rooms | | |||
| | [Go-NEB](configuring-playbook-bot-go-neb.md) | [matrixdotorg/go-neb](https://hub.docker.com/r/matrixdotorg/go-neb) | ❌ | Multi functional bot written in Go | | |||
| | [ma1sd](configuring-playbook-ma1sd.md) | [ma1uta/ma1sd](https://hub.docker.com/r/ma1uta/ma1sd/) | ❌ | Matrix Identity Server | | |||
| | [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) | [matrixdotorg/matrix-appservice-slack](https://hub.docker.com/r/matrixdotorg/matrix-appservice-slack) | ❌ | Bridge to [Slack](https://slack.com/) | | |||
| | [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md) | [turt2live/matrix-appservice-webhooks](https://hub.docker.com/r/turt2live/matrix-appservice-webhooks) | ❌ | Bridge for slack compatible webhooks ([ConcourseCI](https://concourse-ci.org/), [Slack](https://slack.com/) etc. pp.) | | |||
| | [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/) | | |||
| @@ -36,7 +36,6 @@ Possibly outdated list of roles where self-building the Docker image is currentl | |||
| - `exim-relay` | |||
| - `matrix-bridge-hookshot` | |||
| - `matrix-bridge-appservice-irc` | |||
| - `matrix-bridge-appservice-slack` | |||
| - `matrix-bridge-beeper-linkedin` | |||
| - `matrix-bridge-mautrix-googlechat` | |||
| - `matrix-bridge-mautrix-telegram` | |||
| @@ -104,8 +104,6 @@ matrix_homeserver_container_extra_arguments_auto: | | |||
| + | |||
| (['--mount type=bind,src=' + matrix_appservice_kakaotalk_config_path + '/registration.yaml,dst=/matrix-appservice-kakaotalk-registration.yaml,ro'] if matrix_appservice_kakaotalk_enabled else []) | |||
| + | |||
| (['--mount type=bind,src=' + matrix_appservice_slack_config_path + '/slack-registration.yaml,dst=/matrix-appservice-slack-registration.yaml,ro'] if matrix_appservice_slack_enabled else []) | |||
| + | |||
| (['--mount type=bind,src=' + matrix_beeper_linkedin_config_path + '/registration.yaml,dst=/matrix-beeper-linkedin-registration.yaml,ro'] if matrix_beeper_linkedin_enabled else []) | |||
| + | |||
| (['--mount type=bind,src=' + matrix_wechat_config_path + '/registration.yaml,dst=/matrix-wechat-registration.yaml,ro'] if matrix_wechat_enabled else []) | |||
| @@ -163,8 +161,6 @@ matrix_homeserver_app_service_config_files_auto: | | |||
| + | |||
| (['/matrix-appservice-kakaotalk-registration.yaml'] if matrix_appservice_kakaotalk_enabled else []) | |||
| + | |||
| (['/matrix-appservice-slack-registration.yaml'] if matrix_appservice_slack_enabled else []) | |||
| + | |||
| (['/matrix-beeper-linkedin-registration.yaml'] if matrix_beeper_linkedin_enabled else []) | |||
| + | |||
| (['/matrix-wechat-registration.yaml'] if matrix_wechat_enabled else []) | |||
| @@ -399,13 +395,6 @@ devture_systemd_service_manager_services_list_auto: | | |||
| 'groups': ['matrix', 'bridges', 'appservice-kakaotalk', 'appservice-kakaotalk-node'], | |||
| }] if matrix_appservice_kakaotalk_enabled else []) | |||
| + | |||
| ([{ | |||
| 'name': 'matrix-appservice-slack.service', | |||
| 'priority': 2000, | |||
| 'restart_necessary': (matrix_appservice_slack_restart_necessary | bool), | |||
| 'groups': ['matrix', 'bridges', 'appservice-slack'], | |||
| }] if matrix_appservice_slack_enabled else []) | |||
| + | |||
| ([{ | |||
| 'name': 'matrix-beeper-linkedin.service', | |||
| 'priority': 2000, | |||
| @@ -1211,66 +1200,6 @@ matrix_appservice_discord_database_password: "{{ (matrix_homeserver_generic_secr | |||
| # | |||
| ###################################################################### | |||
| ###################################################################### | |||
| # | |||
| # matrix-appservice-slack | |||
| # | |||
| ###################################################################### | |||
| # We don't enable bridges by default. | |||
| matrix_appservice_slack_enabled: false | |||
| matrix_appservice_slack_hostname: "{{ matrix_server_fqn_matrix }}" | |||
| matrix_appservice_slack_systemd_required_services_list_auto: | | |||
| {{ | |||
| matrix_addons_homeserver_systemd_services_list | |||
| + | |||
| ([postgres_identifier ~ '.service'] if (postgres_enabled and matrix_appservice_slack_database_hostname == postgres_connection_hostname) else []) | |||
| }} | |||
| matrix_appservice_slack_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_appservice_slack_docker_image_registry_prefix_upstream_default }}" | |||
| matrix_appservice_slack_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}" | |||
| matrix_appservice_slack_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ matrix_appservice_slack_slack_port) if matrix_playbook_service_host_bind_interface_prefix else '' }}" | |||
| matrix_appservice_slack_container_network: "{{ matrix_addons_container_network }}" | |||
| matrix_appservice_slack_container_additional_networks_auto: |- | |||
| {{ | |||
| ( | |||
| ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network]) | |||
| + | |||
| ([postgres_container_network] if (postgres_enabled and matrix_appservice_slack_database_hostname == postgres_connection_hostname and matrix_appservice_slack_container_network != postgres_container_network) else []) | |||
| + | |||
| ([matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_playbook_reverse_proxyable_services_additional_network and matrix_appservice_slack_container_labels_traefik_enabled) else []) | |||
| ) | unique | |||
| }} | |||
| matrix_appservice_slack_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" | |||
| matrix_appservice_slack_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" | |||
| matrix_appservice_slack_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" | |||
| matrix_appservice_slack_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" | |||
| matrix_appservice_slack_appservice_token: "{{ (matrix_homeserver_generic_secret_key + ':slack.as.token') | hash('sha512') | to_uuid }}" | |||
| matrix_appservice_slack_homeserver_url: "{{ matrix_addons_homeserver_client_api_url }}" | |||
| matrix_appservice_slack_homeserver_token: "{{ (matrix_homeserver_generic_secret_key + ':slack.hs.token') | hash('sha512') | to_uuid }}" | |||
| matrix_appservice_slack_id_token: "{{ (matrix_homeserver_generic_secret_key + ':slack.id.token') | hash('sha512') | to_uuid }}" | |||
| # Postgres is the default, except if not using internal Postgres server | |||
| matrix_appservice_slack_database_engine: "{{ 'postgres' if postgres_enabled else 'nedb' }}" | |||
| matrix_appservice_slack_database_hostname: "{{ postgres_connection_hostname if postgres_enabled else '' }}" | |||
| matrix_appservice_slack_database_password: "{{ (matrix_homeserver_generic_secret_key + ':as.slack.db') | hash('sha512') | to_uuid }}" | |||
| matrix_appservice_slack_database_container_network: "{{ postgres_container_network if postgres_enabled else '' }}" | |||
| ###################################################################### | |||
| # | |||
| # /matrix-bridge-appservice-slack | |||
| # | |||
| ###################################################################### | |||
| ###################################################################### | |||
| # | |||
| @@ -4149,12 +4078,6 @@ postgres_managed_databases_auto: | | |||
| 'password': matrix_appservice_draupnir_for_all_database_password, | |||
| }] if (matrix_appservice_draupnir_for_all_enabled and matrix_appservice_draupnir_for_all_database_hostname == postgres_connection_hostname) else []) | |||
| + | |||
| ([{ | |||
| 'name': matrix_appservice_slack_database_name, | |||
| 'username': matrix_appservice_slack_database_username, | |||
| 'password': matrix_appservice_slack_database_password, | |||
| }] if (matrix_appservice_slack_enabled and matrix_appservice_slack_database_engine == 'postgres' and matrix_appservice_slack_database_hostname == postgres_connection_hostname) else []) | |||
| + | |||
| ([{ | |||
| 'name': matrix_appservice_irc_database_name, | |||
| 'username': matrix_appservice_irc_database_username, | |||
| @@ -5063,11 +4986,6 @@ matrix_synapse_admin_config_asManagedUsers_auto: | | |||
| '^@_discord_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', | |||
| ] if matrix_appservice_discord_enabled else []) | |||
| + | |||
| ([ | |||
| '^@'+(matrix_appservice_slack_bot_name | default('') | regex_escape)+':'+(matrix_domain | regex_escape)+'$', | |||
| '^@'+(matrix_appservice_slack_user_prefix | default('') | regex_escape)+'[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', | |||
| ] if matrix_appservice_slack_enabled else []) | |||
| + | |||
| ([ | |||
| '^@'+(matrix_beeper_linkedin_appservice_bot_username | default('') | regex_escape)+':'+(matrix_domain | regex_escape)+'$', | |||
| '^@linkedin_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', | |||
| @@ -55,7 +55,6 @@ | |||
| - custom/matrix-appservice-double-puppet | |||
| - custom/matrix-alertmanager-receiver | |||
| - custom/matrix-bridge-appservice-discord | |||
| - custom/matrix-bridge-appservice-slack | |||
| - custom/matrix-bridge-appservice-irc | |||
| - custom/matrix-bridge-appservice-kakaotalk | |||
| - custom/matrix-bridge-beeper-linkedin | |||