Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.
/ CQGitBot Public archive

CQGitBot是一个简单的Github消息推送机器人,它会将来自github仓库的push、star等消息推送到指定QQ或QQ群,可以用来帮助协作开发者跟进项目进展

Notifications You must be signed in to change notification settings

Billdex/CQGitBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CQGitBot

CoolQ 已经废了,这个项目也废弃了

简介

CQGitBot是一个通过监听Github仓库的WebHook消息并调用cqhttp提供的酷Q的Http API接口发送QQ消息 的简单Github消息推送服务机器人。它在接收到Github的WebHook消息之后,会进行一些简单的处理并将消息转发到指定QQ群。

使用说明

使用该机器人需要先下载安装酷QCoolQ Http API插件。安装好酷Q后,将下载好的cpk插件放入酷Q安装目录内的app目录下,即

|--CoolQAir
|  |--app
|     |--io.github.richardchien.coolqhttpapi.cpk

接下来启动酷Q并在应用管理中启用HTTP API插件。

Linux下可以使用cqhttp的Docker镜像richardchien/cqhttp

$ docker pull richardchien/cqhttp:latest
$ docker run -tid --rm --name cqhttp-cqgitbot \
    -v $(pwd)/coolq/cqgitbot:/home/user/coolq \
    -p 9000:9000 \ #noVNC端口,用于从浏览器管理酷Q
    -p 5700:5700 \ #HTTP API插件的端口
    -e COOLQ_ACCOUNT=你要登录的QQ号 \
    -e CQHTTP_POST_URL=http://127.0.0.1:7920/qq \
    -e CQHTTP_SERVE_DATA_FILES=yes \
    richardchien/cqhttp:latest

之后访问 http://<你的IP>:9000/ 进入noVNC管理页面,默认密码为 MAX8char ,登录酷Q。

最后,启动本项目的机器人,并在你想要推送消息的Github仓库中设置WebHook。

访问 http://仓库地址/settings/hooks
点击Add WebHook按钮添加
PayLoad URL 设为 http://<机器人所在IP>:7920/git
Content type 选择 application/json 
Secret 鉴权用的密钥,可以为空,与配置文件的secret保持一致
需要推送的Events事件可以选择 仅push、全选、自选,根据需要进行选择 

添加好WebHook之后会发送一条ping消息,正常接收到该消息则说明配置正确且机器人正常启动。

配置文件说明

配置文件 conf.json 需要放在与执行程序同级的目录下。配置项格式如下

{
  "port": 7920,         //程序监听的端口,用来接收消息
  "git": {
    "uri": "/git",      //接收git消息的路由
    "secret": "YourSecret"    //鉴权用的密钥,可以为空,与WebHook的Secret保持一致
  },
  "qq": {
    "uri": "/qq",       //接收QQ消息的路由
    "cq_port": 5700,    //发送QQ消息到cqhttp的端口
    "group_id": [
      "1234567891",     //接收消息的QQ群号列表
      "1234567892"
    ]
  }
}

About

CQGitBot是一个简单的Github消息推送机器人,它会将来自github仓库的push、star等消息推送到指定QQ或QQ群,可以用来帮助协作开发者跟进项目进展

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages