Skip to content

Latest commit

 

History

History
169 lines (137 loc) · 5.26 KB

README_Docker.md

File metadata and controls

169 lines (137 loc) · 5.26 KB
Raw

在 Docker 中运行

关于QQ的重要说明

2020年7月22日，晨风机器人作者被警方喝茶，随后酷Q作者迫于压力跑路。本程序QQ部分依赖酷Q运行，因此也不再支持QQ传话，直到有其他解决方案为止。

下面是一个基于 Docker Compose 的示例配置方法：

1. 配置机器人账号

参见README.md。

2. 安装必要的软件

需要在服务器上安装Docker、Docker Compose、git，具体操作步骤略。

如使用中国国内服务器：

  1. 需配置好Docker镜像源，否则拉镜像时网络会非常卡。
  2. Dockerfile中的网址需要翻墙。如果已配置代理，需要增加
ENV HTTP_PROXY http://192.168.1.100:1080
ENV HTTPS_PROXY http://192.168.1.100:1080

如果未配置代理，需要找个墙外网站（例如Docker Hub）把容器构建出来，再借助国内镜像源来pull容器。

3. 下载必要的文件

下面命令在服务器执行，会在家目录建立一个子目录bot，相关文件均会放到该目录中。

cd
mkdir bot
cd bot

# 互联机器人源码
git clone https://github.com/infnan/LilyWhiteBot

# 酷Q插件（酷Q本体会自动下载，我们只需把插件配置好）
mkdir -p coolq/app
cd coolq/app
wget https://github.com/richardchien/coolq-http-api/releases/download/v4.15.0/io.github.richardchien.coolqhttpapi.cpk

4. 修改配置文件

LilyWhiteBot 配置文件

执行

cd ~/bot/LilyWhiteBot
cp config.example.yml config.yml
cp badwords.example.yml badwords.yml

如果您是从旧版本升级而来，您可以继续使用json文件（然而程序会优先读取yaml文件，注意处理冲突）。因yaml更适合维护配置，建议花点时间转一下格式。

另外 cqsocketapi 并非为 Docker 设计。启用 Docker 之后该插件将无法连接，需换成 CoolQ HTTP API 并重新配置。

根据示例配置文件中的注释修改两个配置文件。其中，config.yml的 QQ 部分有几处需要留意的地方：

  1. qq.apiRoot设置为http://coolq:5700。
  2. qq.accessToken与qq.secret内容随意填写，但必须和 Cool HTTP API 配置文件中的 token 与 secret 保持一致。
  3. qq.listen.host设置为0.0.0.0。
  4. qq.host与qq.port参数需删除。
  5. 如需转发图片，建议使用图床（transport.options.servemedia.type不设置为self），因容器取文件比较麻烦。

CoolQ HTTP API 配置

执行

cd ~/bot/coolq/app
mkdir io.github.richardchien.coolqhttpapi

创建config.json文件，内容大体如下（请根据实际情况修改）：

{
    "general": {
        "host": "0.0.0.0",
        "use_http": true,
        "use_ws": false,
        "use_ws_reverse": false,
        "post_url": "http://lilywhitebot:11234",
        "log_level": "info",
        "show_log_console": false,
        "disable_coolq_log": false,
        "serve_data_files": true,
        "access_token": "随便一个字符串",
        "secret": "随便一个字符串"
    },
    "机器人的QQ号": {
        "port": 5700
    }
}

注意 access_token 与 secret 两参数需要和 LilyWhiteBot 的 config.yml 保持一致。

docker-compose.yaml

在bot目录创建docker-compose.yaml文件，可参照以下配置文件进行设置（注意修改下面的 VNC 密码与机器人 QQ 号）：

version: "3"

services:
  coolq:
    image: coolq/wine-coolq
    restart: always
    volumes:
      - ./coolq:/home/user/coolq
    ports:
      # 使用9000作为运维端口，HTTP协议
      - "9000:9000"
    environment:
      VNC_PASSWD: VNC密码
      COOLQ_ACCOUNT: 你的机器人账号
      # 如果使用酷Q Pro 则需要解除下面的注释
      # COOLQ_URL: http://dlsec.cqp.me/cqp-full

  lilywhitebot:
    image: node:12
    restart: always
    working_dir: /home/node/app
    volumes:
      - ./LilyWhiteBot:/home/node/app
    command: "npm run install-start"

5. 启动

执行

docker-compose up -d

第一次启动时，需安装配置酷 Q。调整服务器防火墙，放行9000端口，然后使用浏览器访问http://你的服务器IP:9000，输入VNC密码，进行酷 Q 的安装与登录操作。登录成功后，启用 CoolQ HTTP API 插件，然后在界面中重启酷 Q。

配置完成后，检查机器人是否正常运行。酷 Q 与 CoolQ HTTP API 插件日志可在酷 Q 软件中查看，而互联机器人日志可通过docker logs bot_lilywhitebot_1命令查看。

其他说明

文件服务器

version: "3"

services:
  # ...

  lilywhitebot:
    image: node:12
    restart: always
    working_dir: /home/node/app
    volumes:
      - ./LilyWhiteBot:/home/node/app
      # 在此处增加临时文件存放目录
      - ./cache:/home/ndoe/cache
    command: "npm run install-start"

  nginx:
    # ...
    ports:
      - "80:80"
      - "443:443"
    volumes:
      # 与上面保持一致
      - ./cache:/var/www/html

config.yml：

  • transport.options.servemedia.type设置为self
  • transport.options.servemedia.cachePath设置为/home/node/cache
  • transport.options.servemedia.serveUrl设置为你的（上面示例为nginx）服务器网址

树莓派

由于酷 Q 仅支持 x86_64 平台，因此在需要 QQ 的情况下，程序不能在树莓派等硬件上运行。