chatroom syncer

聊天室同步器

Chatroom-Syncer 是一个将 IM 聊天室同步到公共领域（如过去的 IRC）的项目，以便其他人可以随时通过任何软件发现、学习和引用通信的信息、上下文和历史。

演示聊天同步.mp4

支持的接收器

• 松弛
• GitHub
• IRC
• 电报
• 不和谐

组件和流程

成分	Docker 镜像	图片评论
wechaty-gateway		"wechaty": "1.20.2" "wechaty-puppet-wechat": "1.18.4"
chatroom-syncer		- tag: dev是主分支头 - latest是最新版本

系统中有两个进程：

• Chatroom Syncer，当前的 Python 代码库，作为微信客户端和机器人
• 微信网关，利用微信与UOS微信客户端（也称为傀儡）来由聊天室同步器调用，因为WebChaty不是原生Python库，而微信网关是一个gRPC服务器来操纵和观看微信傀儡。

因此，我们需要在聊天室同步器之前启动微信网关。

 ┌────────────────────────────┐        ┌────────┐     ┌────────┐
│                            │        │ Sink   │     │        │
│ Chatroom Syncer            │        │        │     │        │
│                            │        │ GitHub │     │        │
│ onMessage()                ├────────▶ Slack ─ ─ ─ ─▶ Linen* │
│   self.use(***SinkPlugin())│        │        │     │        │
│                            │        │        │     │        │
└──────────────▲─────────────┘        │        │     │        │
               │                      └────────┘     └────────┘
             gRPC
               │
┌──────────────▼──────────────┐
│                             │
│  Wechaty Gateway            │
│                             │
│                             │
│┌────────────────────────┐   │
││ Wechaty UOS puppet     │   │
│└────────────────────────┘   │
└─────────────────────────────┘

# * Linen.dev is a Open Source project and a SaaS/Cloud service to help sync slack/discord to a searchable and shareable public domain.

跑步

在运行之前，我们需要满足以下先决条件：

• 在config.yaml中配置微信群组名称和 Sink 信息，它们应该同时存在于微信和 Sink 中。
• 在.env中配置 Sink API 令牌（Slack API 令牌、GitHub 令牌等）。

使用 Docker 运行

在后台运行它：

cp config-example.yaml config.yaml
cp env-example .env
docker-compose up -d

检查两个容器是否已启动：

docker-compose ps

如果存在任何Exit 0容器，请再次尝试启动：

docker-compose up -d

使用微信扫描二维码，即可开始！

docker logs chatroom-syncer_chatroom-syncer_1 2> /dev/null | grep -v Wechaty

停止它：

docker-compose down

从主机运行

首先运行Webchaty网关：

 export token= " iwonttellyou "
docker run -d 
    --name=wechaty-gateway 
    --net=bridge 
    -p 9009:9009 
    -e WECHATY_PUPPET_SERVICE_TOKEN= " $token " 
    --restart=unless-stopped weygu/wechaty-gateway:latest

运行聊天室同步器：

 # install it
python3 -m pip install chatroom-syncer
# create config.yaml and change it
cp config-example.yaml config.yaml

# put tokens for sink according to your config.yaml
# i.e. if both slack and github discussion sinks were enabled
# we need token to send message to slack and github discussion
# as follow:
export SLACK_BOT_TOKEN= " xoxb-1234567890-1234567890-1234567890-1234567890 "
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxx

# run it
python3 -m chatroom_syncer

配置

微信

将 config-example.yaml 复制到 config.yaml

cp config-example.yaml config.yaml

并填写表中的以下字段：

场地	描述
enable_slack	松弛水槽开关
group_channel_mapping	将微信群组名称映射到 Slack 频道名称
enable_avatar	切换为 Slack 接收器生成基于表情符号的头像
enable_github_discussion	Github讨论池切换
group_github_discussion_mapping	将微信群组名称映射到讨论：owner/repo/category

贡献

从主机构建

git clone https://github.com/wey-gu/chatroom-syncer && cd chatroom-syncer
# install pdm
curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
# install chatroom-syncer
pdm install

如果依赖项已更新，请运行pdm sync以更新锁定清单。

pdm sync

从 Docker 构建

docker-compose -f docker-compose.dev.yaml build
docker-compose -f docker-compose.dev.yaml up -d

# get QR code to scan
docker logs chatroom-syncer_chatroom-syncer_1 2> /dev/null | grep -v Wechaty

# watch logs of the chatroom syncer
docker logs chatroom-syncer_chatroom-syncer_1 --follow

# stop the chatroom syncer and remove the container
docker-compose -f docker-compose.dev.yaml down

棉绒

 # install pre-commit
pip install pre-commit

# run pre-commit
pre-commit run --all-files