doc: 分离QChatGPT和消息平台的部署教程

This commit is contained in:
lazy
2024-02-19 20:09:55 +08:00
committed by RockChinQ
parent 359e905ce3
commit 66f11ed459
12 changed files with 236 additions and 72 deletions
+45 -20
View File
@@ -17,25 +17,51 @@ export default sidebar({
link: "posts/deploy/",
children: [
{
text: "手动部署(推荐,可以在所有平台上使用)",
icon: "support",
link: "manual",
text: "部署QChatGPT",
icon: "flow",
prefix:"qchatgpt/",
link: "qchatgpt/",
children: [
{
text: "手动部署",
icon: "support",
link: "manual",
},
{
text: "Docker部署",
icon: "stack",
link: "docker",
},
],
},
{
text: "部署消息平台",
icon: "merge",
prefix:"platforms/",
link: "platforms/",
children: [
{
text: "mirai",
icon: "support",
link: "mirai",
},
{
text: "go-cqhttp",
icon: "state",
link: "gocq",
},
{
text: "shamrock",
icon: "mobile",
link: "shamrock",
},
{
text: "QQ官方机器人",
icon: "network",
link: "official",
}
],
},
// {
// text: "安装器部署(Win)(不推荐,长时间未维护)",
// icon: "list",
// link: "auto-app-win",
// },
// {
// text: "Docker部署(仅推荐在Linux上使用)",
// icon: "list",
// link: "auto-docker",
// },
// {
// text: "安装器部署(Linux)(不推荐,已经长时间未维护)",
// icon: "list",
// link: "auto-app-linux",
// },
],
},
{
@@ -46,7 +72,7 @@ export default sidebar({
{
text: "配置方法",
icon: "context",
link: "posts/config-intro"
link: "posts/config-intro",
},
{
text: "常见问题",
@@ -58,7 +84,6 @@ export default sidebar({
text: "Mirai常见报错",
icon: "notice",
link: "mirai",
},
{
text: "go-cqhttp常见报错",
+10 -4
View File
@@ -4,7 +4,7 @@ head:
- name: keywords
content: ChatGPT QQ机器人教程,QChatGPT项目部署教程
title: 部署教程
icon: info
icon: blog
author: Lazy,ikun
date: 2023-10-28
category:
@@ -15,9 +15,15 @@ index: false
[[toc]]
:::
## 手动部署(推荐)
> 全平台通用,可以避免安装器部署失败的问题
- [<HopeIcon icon="support" size="1.2em"/> 点击查看手动部署的具体操作](manual.md)
## 部署教程:
### [第一步:部署QChatGPT](qchatgpt/)
#### [👉部署QChatGPT的教程👈](qchatgpt/)
## [第二步:部署消息平台](platforms/)
#### 👉[部署消息平台的教程👈](platforms/)
## 本项目交流 QQ 群
@@ -1,15 +0,0 @@
---
head:
- - meta
- name: keywords
content: QChatGPT的登录教程
title: 登录教程
icon: tree
order: 1
author: Lazy
date: 2023-12-20
category:
- 登录教程
---
<AutoCatalog base='/posts/deploy/manual-deploy-details/'/>
+51
View File
@@ -0,0 +1,51 @@
---
head:
- - meta
- name: keywords
content: ChatGPT QQ机器人教程,QChatGPT项目部署教程
title: 消息平台部署教程
icon: merge
author: Lazy,ikun
date: 2023-10-28
category:
- 部署教程
index: false
---
:::info 目录
[[toc]]
:::
## 可选的平台
以下平台任选(支持同时使用多平台):
- mirai
- go-cqhttp
- shamrock
- QQ官方机器人
## [mirai部署教程](mirai.md)
## [go-cqhttp部署教程](gocq.md)
## [shamrock部署教程](shamrock.md)
## [QQ官方机器人部署教程](official.md)
## 本项目交流 QQ 群
### 社区群
Lazy的交流群一:891448839(已满)
Lazy的交流群二:738382634(已满)
Lazy的交流群三:248432104
### 官方群
> 官方群不解答部署问题
四群:195992197 [链接](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=cSekvWmyezfCE4O8gXS7lSjkmPinjzpP&authKey=G4jHfz2%2BtQawxCRhn1ZRrQiI8bTvlepQubZL6F9fymFuz8jqZZ4FkYh6lhKLMCd9&noverify=0&group_code=195992197)
@@ -3,8 +3,8 @@ head:
- - meta
- name: keywords
content: Go-cqhttp的部署教程
title: Go-cqhttp的部署教程
icon: support
title: 部署消息平台go-cqhttp的教程
icon: state
order: 3
author: Anonymous
date: 2023-12-21
@@ -3,7 +3,7 @@ head:
- - meta
- name: keywords
content: Yiri-mirai的部署教程
title: Yiri-mirai的部署教程(QChatGPT)
title: 部署消息平台mirai的教程
icon: support
order: 3
author: Lazy
@@ -3,8 +3,8 @@ head:
- - meta
- name: keywords
content: OpenShamrock的部署教程
title: OpenShamrock的部署教程
icon: support
title: 部署消息平台shamrock的教程
icon: mobile
order: 3
author: ikun
date: 2023-12-21
+40
View File
@@ -0,0 +1,40 @@
---
head:
- - meta
- name: keywords
content: ChatGPT QQ机器人教程,QChatGPT项目部署教程
title: QChatGPT部署教程
icon: flow
author: Lazy,ikun
date: 2023-10-28
category:
- 部署教程
index: false
---
:::info 目录
[[toc]]
:::
## 手动部署
> 全平台通用,可以避免安装器部署失败的问题
- [<HopeIcon icon="support" size="1.2em"/> 点击查看手动部署的具体操作](manual.md)
## Docker部署
- [<HopeIcon icon="support" size="1.2em"/> 点击查看Docker部署的具体操作](docker.md)
## 本项目交流 QQ 群
### 社区群
Lazy的交流群一:891448839(已满)
Lazy的交流群二:738382634(已满)
Lazy的交流群三:248432104
### 官方群
> 官方群不解答部署问题
四群:195992197 [链接](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=cSekvWmyezfCE4O8gXS7lSjkmPinjzpP&authKey=G4jHfz2%2BtQawxCRhn1ZRrQiI8bTvlepQubZL6F9fymFuz8jqZZ4FkYh6lhKLMCd9&noverify=0&group_code=195992197)
+84
View File
@@ -0,0 +1,84 @@
---
head:
- - meta
- name: keywords
content: ChatGPT QQ机器人教程,QChatGPT项目部署教程
title: Docker部署(仅推荐在Linux上使用)
icon: stack
order: 4
author: Lazy,ikun
date: 2023-10-28
category:
- 部署教程
---
:::warning
请您确保您**确实**需要 Docker 部署,您**必须**具有以下能力:
- 了解 `Docker` 和 `Docker Compose` 的使用
- 了解容器间网络通信配置方式
- 了解容器文件挂载机制
- 了解容器调试操作
- 动手能力强、资料查找能力强
若您不完全具有以上能力,请勿使用 Docker 部署,由于误操作导致的配置不正确,我们将不会解答您的问题并不负任何责任。
**非常不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。
:::
:::info 目录
[[toc]]
:::
## 概览
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`
复制`res/templates/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`),安装插件时可能会自动安装相应的依赖,此时若`重新创建`容器,已安装的插件将被加载,但所需的增量依赖并未安装,会导致引入问题。您可以删除插件目录后重启,再次安装插件,以便程序可以自动安装插件所需依赖。
@@ -12,41 +12,14 @@ category:
- 部署教程
---
:::warning
请使用Python 3.9.x以上版本,**注意不要使用3.12.x版本**,没有Python的需自行安装,参考[此教程](./manual-deploy-details/python.md)
请使用Python 3.9.x以上版本,**注意不要使用3.12.x版本**,没有Python的需自行安装,参考[此教程](./more-details/python.md)
:::
:::info 目录
[[toc]]
:::
## 配置QQ登录框架
目前支持mirai和go-cqhttp和OpenShamrock(未来的可能方案),配置任意一个即可
<details>
<summary>mirai</summary>
1. 按照[此教程](./manual-deploy-details/yirimirai.md)配置Mirai及mirai-api-http
2. 启动mirai-console后,保持mirai-console运行状态
3. 在下一步配置主程序时请在config.py中将`msg_source_adapter`设为`yirimirai`
</details>
<details>
<summary>go-cqhttp</summary>
1. 按照[此文档](./manual-deploy-details/gocq.md)配置go-cqhttp
2. 启动go-cqhttp,确保登录成功,保持运行
3. 在下一步配置主程序时请在config.py中将`msg_source_adapter`设为`nakuru`
</details>
<details>
<summary>OpenShamrock(未来的可能方案)</summary>
详细见[此文档](./manual-deploy-details/shamrock.md)
</details>
## 安装主程序