chatroom syncer

Чат-Syncer

Chatroom-Syncer — это проект по синхронизации чата обмена мгновенными сообщениями с общедоступным достоянием, таким как IRC в старые времена, чтобы информация, контекст и история общения могли быть обнаружены, изучены и использованы другими в любое время и в любое время.

демо-чат-sync.mp4

Поддерживаемые приемники

• Слабый
• GitHub
• IRC
• Телеграмма
• Раздор

Компоненты и поток

Компоненты	Изображения Докера	Комментарии к изображениям
wechaty-gateway		"wechaty": "1.20.2" "wechaty-puppet-wechat": "1.18.4"
chatroom-syncer		- тег: dev — руководитель основного филиала - latest — это последний выпуск на

В системе есть два процесса:

• Chatroom Syncer, текущая база кода на Python в качестве клиента WeChaty и бота.
• WeChaty Gateway, который использует Wechaty с клиентом Wechat UOS UOS (также называемым марионеткой) для вызова Chatroom Syncer, поскольку WebChaty не является встроенной библиотекой Python, а Wechaty Gateway представляет собой сервер gRPC для управления марионеткой WeChat и наблюдения за ней. .

Таким образом, нам нужно запустить 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.

Бегать

Перед запуском нам необходимо выполнить предварительные условия:

• Настройте имена групп WeChat и информацию о приемниках в config.yaml , они должны существовать как в WeChat, так и в Sink.
• Настройте токен Sink API (токен Slack API, токен GitHub и т. д.) в .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.
enable_github_discussion	Переключение приемника обсуждений Github
group_github_discussion_mapping	Сопоставление имени группы WeChat с обсуждением: владелец/репозиторий/категория.

Способствовать

Сборка с хоста

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