Skip to content

部署流程

神代綺凜 edited this page Jan 15, 2020 · 21 revisions

1. 酷Q

本插件依赖 酷Q机器人 以及相关插件和SDK运作

Pro 不是必须的,Air 也可,但 Air 无法发送图片,某些功能会受限

如果您想使用 docker 版酷Q请直接继续往下看

2. CoolQ HTTP API 插件

插件基于 CoolQ HTTP API 插件node-cq-websocket SDK 进行开发,因此你需要在你的酷Q上启用并配置 CoolQ HTTP API 插件

如何配置插件请参考 插件使用文档对于本项目,必须将use_ws设置为true,其他配置项自由发挥

Docker

该插件也提供了 docker 镜像,可以直接部署带插件的 docker 版酷Q,但注意启动参数需要加上-p 6700:6700-e CQHTTP_USE_WS=true

3. Node.js

Node.js 建议版本 10.16.x,理论上来说 LTS 版也是可以的,但如果出现问题请 issue 告知或尝试使用建议版本

你可以在这里查看 Node.js 的所有历史版本

项目部署过程示例:

git clone https://github.com/Tsuk1ko/CQ-picfinder-robot.git
cd CQ-picfinder-robot
cp config.default.json config.json

# 一般情况下
npm i

# 如果你将机器人部署在国内,为了避免因网络问题导致的各种莫名其妙的问题,建议像下面这样使用淘宝 NPM 镜像安装依赖(后同理)
# npm i --registry=https://registry.npm.taobao.org
  • 如果 Windows 系统在npm i--fallback-to-build出现错误,请使用npm i -g windows-build-tools安装编译依赖后再试
    注:--fallback-to-build本身并不是错误,只是因为安装依赖没有预编译的二进制文件所以回退到本地编译而已
  • 如果出现 404 之类的网络错误,一般是因为你当前的网络无法直连 Github 导致无法下载某些依赖预编译的二进制文件,请自己想办法挂代理,或者使用国外服务器
  • 如果总是因为各种奇怪的错误导致依赖无法正常安装,你可以尝试用 yarn 来安装依赖

注意此处(第三行)需要将config.default.json复制一份,重命名为config.json,然后编辑config.json文件来配置本程序

配置文件说明

配置完成后先启用 CoolQ HTTP API 插件 再运行本程序

初次尝试部署建议直接使用npm start命令启动,可以直接看到运行日志,如果有错误能方便地查看报错日志

确保没有错误后再使用pm2守护运行,否则会因错误导致不停重启,出现不停弹窗、CPU 占满等情况

# 没有pm2必须先安装
npm install pm2 -g

# 运行
npm run pm2start

# 停止
npm run pm2stop

# 重启
npm run pm2restart

# 查看日志(日志同时也保存在 logs 文件夹内)
npm run pm2log

当你使用pm2守护运行后,每当config.json发生变动时,程序会自动重启以应用新配置(但有时候也不会自动重启,pm2 的 watch 会有莫名其妙的 bug,这时候就自己来吧)

更新

git pull
npm i

然后阅读更新日志,如果有新添加的配置内容,根据说明和自己的需要添加到配置文件config.json

未配置的设置项将会取config.default.json中的配置值

You can’t perform that action at this time.