sorunome/mx-puppet-slack

mx-puppet-slack

镜像概述和主要用途

mx-puppet-slack是一个用于Matrix的Slack木偶桥接器，基于https://github.com/Sorunome/mx-puppet-bridge%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%94%AF%E6%8C%81%E5%A4%9A%E7%94%A8%E6%88%B7%E5%AE%9E%E4%BE%8B%E3%80%82%E5%AE%83%E8%83%BD%E5%A4%9F%E5%9C%A8Matrix%E5%92%8CSlack%E4%B9%8B%E9%97%B4%E5%BB%BA%E7%AB%8B%E6%A1%A5%E6%8E%A5%EF%BC%8C%E5%AE%9E%E7%8E%B0%E6%B6%88%E6%81%AF%E7%9A%84%E5%8F%8C%E5%90%91%E5%90%8C%E6%AD%A5%EF%BC%8C%E4%BD%BF%E7%94%A8%E6%88%B7%E5%8F%AF%E4%BB%A5%E9%80%9A%E8%BF%87Matrix%E5%AE%A2%E6%88%B7%E7%AB%AF%E4%B8%8ESlack%E5%B7%A5%E4%BD%9C%E5%8C%BA%E8%BF%9B%E8%A1%8C%E4%BA%A4%E4%BA%92%E3%80%82

核心功能和特性

• 多用户支持：允许多个用户通过同一桥接实例连接不同的Slack工作区
• 多种Slack凭证获取方式：支持Legacy Token、OAuth、xoxs token（不推荐，违反Slack服务条款）和xoxc token（不推荐，违反Slack服务条款）
• 中继功能：可配置为中继模式，通过事件API处理Slack事件
• 房间列表与邀请：支持列出Slack可用房间并发送Matrix房间邀请

使用场景和适用范围

适用于需要在Matrix和Slack之间同步消息的个人用户或组织，尤其适合希望通过单一Matrix客户端管理多个Slack工作区消息的用户。

使用方法和配置说明

Docker快速启动

Docker镜像地址：https://hub.docker.com/r/sorunome/mx-puppet-slack

对于Docker部署，建议在config.yaml中进行以下配置修改：

yaml
bindAddress: '0.0.0.0'  # 绑定所有网络接口
filename: '/data/database.db'  # 数据库文件路径，使用数据卷持久化
file: '/data/bridge.log'  # 日志文件路径

同时需检查配置文件中的其他值，如homeserver域名等。

从源码安装

1. 克隆仓库并安装依赖：

   bash
   git clone https://github.com/Sorunome/mx-puppet-slack.git
   cd mx-puppet-slack
   npm install
   

2. 编辑配置文件并生成注册文件：

   bash
   cp sample.config.yaml config.yaml
   # 手动编辑config.yaml，填写homeserver信息和Slack应用凭证
   npm run start -- -r  # 生成注册文件
   

3. 将注册文件复制到Synapse配置目录，并在Synapse配置文件的app_service_config_files:列表中添加该注册文件路径。

4. 重启Synapse服务。

5. 启动桥接器：

   bash
   npm run start
   

6. 与机器人用户（默认@_slackpuppet_bot:domain.tld，可在配置中修改）发起私聊（邀请后需等待约1分钟机器人加入）。

7. 获取Slack令牌（详见下方说明），并发送命令链接工作区：

   link MYTOKEN (详见下方获取令牌的详细步骤)
   

8. 发送命令列出可用房间（也可发送help获取帮助）：

   list
   

   点击列表中的房间将收到桥接房间的邀请。

Slack应用凭证获取方法

选项1：Legacy Token

从[***]

link <token>

选项2：OAuth

1. 在[***]
2. 在侧边栏进入"OAuth & Permissions"选项卡。
3. 添加重定向URL。
4. 在config.yaml中填写oauth配置块，确保将oauth.redirectUri转发到桥接器。
5. 与机器人用户私聊。
6. 发送命令：link
7. 点击机器人提供的链接并授权访问。
8. 复制生成的令牌，发送命令：link TOKEN_YOU_COPIED

选项3：xoxs token

警告：链接xoxs账户令牌违反Slack服务条款。

1. 访问Slack自定义页面（如[***]
2. 打开调试控制台（F12或右键→检查元素）。
3. 输入TS.boot_data.api_token获取令牌。
4. 发送命令：link <token>

选项4：xoxc token

警告：链接xoxc账户令牌违反Slack服务条款。

1. 在网络管理器中过滤WS/WebSocket类型请求，从请求URL参数中获取xoxc令牌。
2. 获取d cookie的内容。
3. 发送命令：link <token> <d cookie contents>

中继模式配置

mx-puppet-slack可配置为中继模式，需设置事件API：

• 在slack.path中配置新端点的基础路径，默认值为/_matrix/slack/client
• 事件API端点为基础路径+/events，默认/_matrix/slack/client/events
• 用于添加Slack机器人到新团队的OAuth端点为基础路径+/oauth/{appId}，默认/_matrix/slack/client/oauth/{appId}

配置步骤：

1. 创建Slack应用并配置权限。
2. 发送命令链接应用：link <appId> <clientId> <clientSecret> <signingSecret>
3. 发送命令设置类型：settype <puppetId> relay