基于Docker部署coolq-http-api插件的完整指南

基于Docker部署coolq-http-api插件的完整指南

coolq-http-api 项目地址: https://gitcode.com/gh_mirrors/coo/coolq-http-api

前言

本文将详细介绍如何在Docker环境中部署和使用coolq-http-api插件。coolq-http-api是一个为酷Q机器人提供HTTP API接口的插件，通过Docker部署可以大大简化安装和配置过程。

Docker部署基础

准备工作

在开始之前，您需要确保系统中已经安装了Docker环境。coolq-http-api提供了基于官方酷Q Docker镜像的预配置版本，包含了插件和必要的运行环境。

镜像获取与运行

获取最新版本的coolq-http-api Docker镜像：

docker pull richardchien/cqhttp:latest

创建用于持久化存储的目录：

mkdir coolq

运行容器的基础命令：

docker run -ti --rm --name cqhttp-test \
           -v $(pwd)/coolq:/home/user/coolq \
           -p 9000:9000 \
           -p 5700:5700 \
           -e CQHTTP_POST_URL=http://example.com:8080 \
           -e CQHTTP_SERVE_DATA_FILES=yes \
           richardchien/cqhttp:latest

参数说明

• -v $(pwd)/coolq:/home/user/coolq：将主机目录挂载到容器内，用于持久化酷Q程序文件
• -p 9000:9000：映射noVNC端口，用于浏览器访问控制界面
• -p 5700:5700：映射HTTP API插件端口
• CQHTTP_POST_URL：设置事件上报地址
• CQHTTP_SERVE_DATA_FILES：允许通过HTTP接口访问酷Q数据文件

配置详解

插件配置

所有插件配置项都可以通过环境变量设置，格式为CQHTTP_加上配置项的大写形式。例如：

• CQHTTP_ACCESS_TOKEN=your_token 设置访问令牌
• CQHTTP_SECRET=your_secret 设置签名密钥
• CQHTTP_USE_HTTP=yes 启用HTTP API

容器特有配置

除了插件配置外，还有一些容器特有的环境变量：

| 变量名 | 说明 | 默认值 | |--------|------|--------| | VNC_PASSWD | noVNC访问密码 | MAX8char | | COOLQ_ACCOUNT | 设置自动登录的QQ号 | 无 | | COOLQ_URL | 酷Q程序下载地址 | 官方Air图灵版 |

版本管理

coolq-http-api的Docker镜像使用tag来标记版本：

• latest：最新稳定版
• 3.0.0：特定版本号

要使用特定版本：

docker pull richardchien/cqhttp:3.0.0

高级用法

手动管理模式

默认情况下，容器会自动管理插件版本和配置。要切换到手动模式：

1. 进入容器或通过挂载目录访问
2. 删除app/io.github.richardchien.coolqhttpapi/app.lock文件
3. 之后可以自由修改配置文件和替换插件版本

数据持久化

建议将以下目录通过-v参数挂载到主机：

• /home/user/coolq：酷Q主程序和数据
• /home/user/coolq/data/app/io.github.richardchien.coolqhttpapi：插件配置和数据

常见问题

性能优化

对于生产环境，建议添加以下参数：

--restart unless-stopped \
--memory 2g \
--cpus 1

安全建议

1. 修改默认的VNC密码
2. 为API访问设置token
3. 限制可访问API的IP地址

结语

通过Docker部署coolq-http-api插件可以极大简化部署流程，同时保持环境的一致性。本文介绍了从基础部署到高级配置的完整指南，希望能帮助您快速搭建稳定的酷Q机器人开发环境。

coolq-http-api 项目地址: https://gitcode.com/gh_mirrors/coo/coolq-http-api