chatroom syncer
v0.1.9: ci piped, avatar for slack, github discussion!
Chatroom-Syncer เป็นโครงการที่จะซิงค์ IM Chat Room กับสาธารณสมบัติ เช่น IRC ในสมัยก่อน เพื่อให้สามารถค้นพบ เรียนรู้ และอ้างอิงข้อมูล บริบท และประวัติการสื่อสารของผู้อื่นได้ทุกที่ทุกเวลา
สาธิตแชท-sync.mp4
อ่างล้างจานที่รองรับ
ส่วนประกอบ | รูปภาพนักเทียบท่า | ความคิดเห็นเกี่ยวกับรูปภาพ |
---|---|---|
wechaty-gateway | "wechaty": "1.20.2" "wechaty-puppet-wechat": "1.18.4" | |
chatroom-syncer | - แท็ก: dev เป็นหัวหน้าสาขาหลัก- latest คือรุ่นล่าสุดบน |
มีสองกระบวนการในระบบ:
ดังนั้นเราจึงต้องเริ่ม WeChaty Gateway ก่อน Chatroom Syncer
┌────────────────────────────┐ ┌────────┐ ┌────────┐
│ │ │ 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
ซึ่งควรมีอยู่ในทั้ง WeChat และ Sink.env
เรียกใช้ในพื้นหลัง:
cp config-example.yaml config.yaml
cp env-example .env
docker-compose up -d
ตรวจสอบว่าทั้งสองคอนเทนเนอร์พร้อมใช้งาน:
docker-compose ps
ในกรณีที่มีคอนเทนเนอร์ Exit 0
ให้ลองเริ่มต้นใหม่อีกครั้ง:
docker-compose up -d
สแกนโค้ด QR ด้วยแอป WeChat ของคุณ เท่านี้ก็พร้อมแล้ว!
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
เรียกใช้ Chatroom-Syncer:
# 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 | การแมปชื่อกลุ่ม WeChat กับชื่อช่อง Slack |
enable_avatar | สลับเพื่อสร้างอวตารที่ใช้อิโมจิสำหรับ Slack sink |
enable_github_discussion | สวิตช์ของอ่างล้างจาน Github |
group_github_discussion_mapping | การแมปชื่อกลุ่ม WeChat กับการสนทนา: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-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