chore: 删除无用文件
Before Width: | Height: | Size: 246 KiB |
|
@ -1 +0,0 @@
|
||||||
2023/3/31 21:35 【插件兼容性问题】若您使用了revLibs插件,并将主程序升级到了v2.3.0,请立即使用管理员账号向机器人账号发送!plugin update命令更新逆向库插件,以解决由于情景预设重构引起的兼容性问题。
|
|
|
@ -1,97 +0,0 @@
|
||||||
|
|
||||||
> [!WARNING]
|
|
||||||
> 此文档已过时,请查看[QChatGPT 容器化部署指南](docker_deployment.md)
|
|
||||||
|
|
||||||
## 操作步骤
|
|
||||||
|
|
||||||
### 1.安装docker和docker compose
|
|
||||||
|
|
||||||
[各种设备的安装Docker方法](https://yeasy.gitbook.io/docker_practice/install)
|
|
||||||
|
|
||||||
[安装Compose方法](https://yeasy.gitbook.io/docker_practice/compose)
|
|
||||||
|
|
||||||
> `Docker Desktop for Mac/Windows` 自带 `docker-compose` 二进制文件,安装 Docker 之后可以直接使用。
|
|
||||||
>
|
|
||||||
> 可以选择很多下载方法,反正只要安装了就可以了
|
|
||||||
|
|
||||||
### 2. 登录qq(下面所有步骤建议在项目文件夹下操作)
|
|
||||||
|
|
||||||
#### 2.1 输入指令
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -d -it --name mcl --network host -v ${PWD}/qq/plugins:/app/plugins -v ${PWD}/qq/config:/app/config -v ${PWD}/qq/data:/app/data -v ${PWD}/qq/bots:/app/bots --restart unless-stopped kagurazakanyaa/mcl:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
这里使用了[KagurazakaNyaa/mirai-console-loader-docker](https://github.com/KagurazakaNyaa/mirai-console-loader-docker)的镜像
|
|
||||||
|
|
||||||
#### 2.2 进入容器
|
|
||||||
|
|
||||||
```
|
|
||||||
docker ps
|
|
||||||
```
|
|
||||||
在输出中查看容器的ID,例如:
|
|
||||||
```sh
|
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
||||||
bce1e5568f46 kagurazakanyaa/mcl "./mcl -u" 10 minutes ago Up 10 minutes 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp admiring_mendeleev
|
|
||||||
```
|
|
||||||
查看`IMAGE`名为`kagurazakanyaa/mcl`的容器的`CONTAINER ID`,在这里是`bce1e5568f46`,于是使用以下命令将其切到前台:
|
|
||||||
```
|
|
||||||
docker attach bce1e5568f46
|
|
||||||
```
|
|
||||||
如需将其切到后台运行,请使用组合键`Ctrl+P+Q`
|
|
||||||
|
|
||||||
#### 2.3 编写配置文件
|
|
||||||
|
|
||||||
- 在` /qq/config/net.mamoe.mirai-api-http` 文件夹中找到`setting.yml`,这是`mirai-api-http`的配置文件
|
|
||||||
- 将这个文件的内容修改为:
|
|
||||||
|
|
||||||
```
|
|
||||||
adapters:
|
|
||||||
- ws
|
|
||||||
debug: true
|
|
||||||
enableVerify: true
|
|
||||||
verifyKey: yirimirai
|
|
||||||
singleMode: false
|
|
||||||
cacheSize: 4096
|
|
||||||
adapterSettings:
|
|
||||||
ws:
|
|
||||||
host: localhost
|
|
||||||
port: 8080
|
|
||||||
reservedSyncId: -1
|
|
||||||
```
|
|
||||||
|
|
||||||
`verifyKey`要求与`bot`的`config.py`中的`verifyKey`相同
|
|
||||||
|
|
||||||
`port`: 8080要和2.4 config.py配置里面的端口号相同
|
|
||||||
|
|
||||||
#### 2.4 登录
|
|
||||||
|
|
||||||
#### 在mirai上登录QQ
|
|
||||||
|
|
||||||
```
|
|
||||||
login <机器人QQ号> <机器人QQ密码>
|
|
||||||
```
|
|
||||||
|
|
||||||
> 具体见[此教程](https://yiri-mirai.wybxc.cc/tutorials/01/configuration#4-登录-qq)
|
|
||||||
|
|
||||||
#### 配置自动登录(可选)
|
|
||||||
|
|
||||||
当机器人账号登录成功以后,执行
|
|
||||||
|
|
||||||
```
|
|
||||||
autologin add <机器人QQ号> <机器人密码>
|
|
||||||
autologin setConfig <机器人QQ号> protocol ANDROID_PAD
|
|
||||||
```
|
|
||||||
|
|
||||||
> 出现`无法登录`报错时候[无法登录的临时处理方案](https://mirai.mamoe.net/topic/223/无法登录的临时处理方案)
|
|
||||||
|
|
||||||
**完成后, `Ctrl+P+Q`退出(不会关掉容器,容器还会运行)**
|
|
||||||
|
|
||||||
### 3. 部署QChatGPT
|
|
||||||
|
|
||||||
配置好config.py,保存到当前目录下,运行下面的
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -it -d --name QChatGPT --network host -v ${PWD}/config.py:/QChatGPT/config.py -v ${PWD}/banlist.py:/QChatGPT/banlist.py -v ${PWD}/sensitive.json:/QChatGPT/sensitive.json mikumifa/qchatgpt-docker
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,64 +0,0 @@
|
||||||
# QChatGPT 容器化部署指南
|
|
||||||
|
|
||||||
> [!WARNING]
|
|
||||||
> 请您确保您**确实**需要 Docker 部署,您**必须**具有以下能力:
|
|
||||||
> - 了解 `Docker` 和 `Docker Compose` 的使用
|
|
||||||
> - 了解容器间网络通信配置方式
|
|
||||||
> - 了解容器文件挂载机制
|
|
||||||
> - 了解容器调试操作
|
|
||||||
> - 动手能力强、资料查找能力强
|
|
||||||
>
|
|
||||||
> 若您不完全具有以上能力,请勿使用 Docker 部署,由于误操作导致的配置不正确,我们将不会解答您的问题并不负任何责任。
|
|
||||||
> **非常不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。
|
|
||||||
|
|
||||||
## 概览
|
|
||||||
|
|
||||||
QChatGPT 主程序需要连接`QQ登录框架`以与QQ通信,您可以选择 [Mirai](https://github.com/mamoe/mirai)(还需要配置mirai-api-http,请查看此仓库README中手动部署部分) 或 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp),我们仅发布 QChatGPT主程序 的镜像,您需要自行配置QQ登录框架(可以参考[README.md](https://github.com/RockChinQ/QChatGPT#-%E9%85%8D%E7%BD%AEqq%E7%99%BB%E5%BD%95%E6%A1%86%E6%9E%B6)中的教程,或自行寻找其镜像)并在 QChatGPT 的配置文件中设置连接地址。
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> 请先确保 Docker 和 Docker Compose 已安装
|
|
||||||
|
|
||||||
## 准备文件
|
|
||||||
|
|
||||||
> QChatGPT 目前暂不可以在没有配置模板文件的情况下自动生成文件,您需要按照以下步骤手动创建需要挂载的文件。
|
|
||||||
> 如无特殊说明,模板文件均在此仓库中。
|
|
||||||
|
|
||||||
> 如果您不想挨个创建,也可以直接clone本仓库到本地,执行`python main.py`后即可自动根据模板生成所需文件。
|
|
||||||
|
|
||||||
现在请在一个空目录创建以下文件或目录:
|
|
||||||
|
|
||||||
### 📄`config.py`
|
|
||||||
|
|
||||||
复制根目录的`config-template.py`所有内容,创建`config.py`并根据其中注释进行修改。
|
|
||||||
|
|
||||||
### 📄`banlist.py`
|
|
||||||
|
|
||||||
复制`banlist-template.py`所有内容,创建`banlist.py`,这是黑名单配置文件,根据需要修改。
|
|
||||||
|
|
||||||
### 📄`cmdpriv.json`
|
|
||||||
|
|
||||||
复制`res/templates/cmdpriv-template.json`所有内容,创建`cmdpriv.json`,这是各命令的权限配置文件,根据需要修改。
|
|
||||||
|
|
||||||
### 📄`sensitive.json`
|
|
||||||
|
|
||||||
复制`res/templates/sensitive-template.json`所有内容,创建`sensitive.json`,这是敏感词配置,根据需要修改。
|
|
||||||
|
|
||||||
### 📄`tips.py`
|
|
||||||
|
|
||||||
复制`tips-custom-template.py`所有内容,创建`tips.py`,这是部分提示语的配置,根据需要修改。
|
|
||||||
|
|
||||||
## 运行
|
|
||||||
|
|
||||||
已预先准备好`docker-compose.yaml`,您需要根据您的网络配置进行适当修改,使容器内的 QChatGPT 程序可以正常与 Mirai 或 go-cqhttp 通信。
|
|
||||||
|
|
||||||
将`docker-compose.yaml`复制到本目录,根据网络环境进行配置,并执行:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker compose up
|
|
||||||
```
|
|
||||||
|
|
||||||
若无报错即配置完成,您可以Ctrl+C关闭后使用`docker compose up -d`将其置于后台运行
|
|
||||||
|
|
||||||
## 注意
|
|
||||||
|
|
||||||
- 安装的插件都会保存在`plugins`(映射到本目录`plugins`),安装插件时可能会自动安装相应的依赖,此时若`重新创建`容器,已安装的插件将被加载,但所需的增量依赖并未安装,会导致引入问题。您可以删除插件目录后重启,再次安装插件,以便程序可以自动安装插件所需依赖。
|
|
Before Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 73 KiB |
Before Width: | Height: | Size: 129 KiB |
Before Width: | Height: | Size: 101 KiB |
Before Width: | Height: | Size: 98 KiB |
Before Width: | Height: | Size: 22 KiB |
|
@ -1,23 +0,0 @@
|
||||||
# 使用config-template生成override.json的字段全集模板文件override-all.json
|
|
||||||
# 关于override.json机制,请参考:https://github.com/RockChinQ/QChatGPT/pull/271
|
|
||||||
import json
|
|
||||||
import importlib
|
|
||||||
|
|
||||||
|
|
||||||
template = importlib.import_module("config-template")
|
|
||||||
output_json = {
|
|
||||||
"comment": "这是override.json支持的字段全集, 关于override.json机制, 请查看https://github.com/RockChinQ/QChatGPT/pull/271"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
for k, v in template.__dict__.items():
|
|
||||||
if k.startswith("__"):
|
|
||||||
continue
|
|
||||||
# 如果是module
|
|
||||||
if type(v) == type(template):
|
|
||||||
continue
|
|
||||||
print(k, v, type(v))
|
|
||||||
output_json[k] = v
|
|
||||||
|
|
||||||
with open("override-all.json", "w", encoding="utf-8") as f:
|
|
||||||
json.dump(output_json, f, indent=4, ensure_ascii=False)
|
|
Before Width: | Height: | Size: 879 KiB |
Before Width: | Height: | Size: 57 KiB |
Before Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 140 KiB |