mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-01 13:25:18 +08:00
doc：补全快速配置页，侧边栏子菜单折叠，统一页面的pageInfo
This commit is contained in:
lazy
@@ -11,6 +11,7 @@ export default sidebar({
|
||||
{
|
||||
text: "部署教程",
|
||||
icon: "blog",
|
||||
collapsible: true,
|
||||
prefix: "posts/deploy/",
|
||||
link: "posts/deploy/",
|
||||
children: [
|
||||
@@ -59,7 +60,11 @@ export default sidebar({
|
||||
link: "official",
|
||||
}
|
||||
],
|
||||
},
|
||||
},{
|
||||
text: "填写配置信息",
|
||||
icon: "class",
|
||||
link: "config",
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
@@ -68,13 +73,14 @@ export default sidebar({
|
||||
link: "posts/command",
|
||||
},
|
||||
{
|
||||
text: "配置方法",
|
||||
text: "配置详解",
|
||||
icon: "context",
|
||||
link: "posts/config-intro",
|
||||
},
|
||||
{
|
||||
text: "常见问题",
|
||||
icon: "info",
|
||||
collapsible: true,
|
||||
link: "posts/error/",
|
||||
prefix: "posts/error/",
|
||||
children: [
|
||||
@@ -98,6 +104,7 @@ export default sidebar({
|
||||
{
|
||||
text: "插件功能",
|
||||
icon: "plugin",
|
||||
collapsible: true,
|
||||
prefix: "posts/plugin/",
|
||||
link: "posts/plugin/intro",
|
||||
// collapsible: true,
|
||||
|
||||
@@ -137,6 +137,9 @@ export default hopeTheme({
|
||||
// sandpack: true,
|
||||
},
|
||||
|
||||
sitemap: true,
|
||||
catalog: true,
|
||||
|
||||
// 如果你需要 PWA。安装 vuepress-plugin-pwa2 并取消下方注释
|
||||
// pwa: {
|
||||
// favicon: "/favicon.ico",
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
head:
|
||||
- - meta
|
||||
- name: keywords
|
||||
content: ChatGPT QQ机器人，实时联网，支持插件，高稳定性，采用mirai或gocq框架，QChatGPT项目wiki页目录
|
||||
title: 页面目录
|
||||
icon: tree
|
||||
date: 2023-09-30
|
||||
category:
|
||||
- 页面目录
|
||||
index: false
|
||||
---
|
||||
<AutoCatalog base='/posts/'/>
|
||||
@@ -5,10 +5,8 @@ head:
|
||||
content: ChatGPT QQ机器人教程，QChatGPT项目部署教程
|
||||
title: 部署教程
|
||||
icon: blog
|
||||
author: Lazy,ikun
|
||||
date: 2023-10-28
|
||||
category:
|
||||
- 部署教程
|
||||
author: Lazy
|
||||
date: 2024-02-18
|
||||
index: false
|
||||
---
|
||||
:::info 目录
|
||||
@@ -17,13 +15,17 @@ index: false
|
||||
|
||||
## 部署教程：
|
||||
|
||||
### [第一步：部署QChatGPT](qchatgpt/)
|
||||
## [第一步：部署QChatGPT](qchatgpt/)
|
||||
|
||||
#### [👉部署QChatGPT的教程👈](qchatgpt/)
|
||||
### [👉部署QChatGPT的教程👈](qchatgpt/)
|
||||
|
||||
## [第二步：部署消息平台](platforms/)
|
||||
|
||||
#### 👉[部署消息平台的教程👈](platforms/)
|
||||
### 👉[部署消息平台的教程👈](platforms/)
|
||||
|
||||
## [第三步：填写配置信息](config.md)
|
||||
|
||||
### 👉[填写配置信息的教程](config.md)👈
|
||||
|
||||
## 本项目交流 QQ 群
|
||||
|
||||
|
||||
@@ -0,0 +1,193 @@
|
||||
---
|
||||
head:
|
||||
- - meta
|
||||
- name: keywords
|
||||
content: ChatGPT QQ机器人教程，QChatGPT项目部署教程
|
||||
title: 填写配置信息
|
||||
icon: class
|
||||
author: Lazy
|
||||
date: 2024-02-18
|
||||
---
|
||||
|
||||
|
||||
|
||||
为了快速上手，你需要重点关注以下文件：
|
||||
|
||||
- `data/config/platform.json`
|
||||
- `data/config/provider.json`
|
||||
|
||||
## 配置消息平台platform.json
|
||||
|
||||
配置data/config/platform.json
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "yiri-mirai",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080,
|
||||
"verifyKey": "yirimirai",
|
||||
"qq": 123456789
|
||||
},
|
||||
{
|
||||
"adapter": "nakuru",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"ws_port": 8080,
|
||||
"http_port": 5700,
|
||||
"token": ""
|
||||
},
|
||||
{
|
||||
"adapter": "aiocqhttp",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080
|
||||
},
|
||||
{
|
||||
"adapter": "qq-botpy",
|
||||
"enable": false,
|
||||
"appid": "",
|
||||
"secret": "",
|
||||
"intents": [
|
||||
"public_guild_messages",
|
||||
"direct_message"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
截至2024年2月13日，目前支持`mirai`、`go-cqhttp`、`aiocqhttp`、`QQ官方机器人`，支持同时开启多个消息适配器，甚至四个全开
|
||||
|
||||
#### 接入mirai
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "yiri-mirai",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080,
|
||||
"verifyKey": "yirimirai",
|
||||
"qq": 123456789
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "yiri-mirai"`，无需动，表明是接入`mirai`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`host`：主机地址，一般不动
|
||||
|
||||
`port`：设置端口，默认8080，与`mirai-api-http`里面设置的保持一致
|
||||
|
||||
`verifyKey`：密钥，默认yirimirai，与`mirai-api-http`里面设置的保持一致
|
||||
|
||||
`qq`：设置机器人QQ号，与当前mirai登录的机器人的QQ号保持一致
|
||||
|
||||
#### 接入go-cqhttp
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "nakuru",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"ws_port": 8080,
|
||||
"http_port": 5700,
|
||||
"token": ""
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "nakuru",`，无需动，表明是接入`go-cqhttp`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`host`：主机地址，一般不动
|
||||
|
||||
`ws_port`：正向WS服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
`http_port`：http服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
`token`：验证密钥，，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
#### 接入shamrock等onebot协议实现的机器人框架
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "aiocqhttp",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "aiocqhttp",`，无需动，表示是接入`shamrock等onebot协议实现的机器人框架`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`host`：主机地址，一般不动
|
||||
|
||||
`port`：设置端口，默认8080，与对应框架里面设置的保持一致
|
||||
|
||||
#### 接入QQ官方机器人
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "qq-botpy",
|
||||
"enable": false,
|
||||
"appid": "",
|
||||
"secret": "",
|
||||
"intents": [
|
||||
"public_guild_messages",
|
||||
"direct_message"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
`"adapter": "qq-botpy",`，无需动，表明是接入`QQ官方机器人`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`appid`：申请到的QQ官方机器人的appid
|
||||
|
||||
`secret`：申请到的QQ官方机器人的secret
|
||||
|
||||
`intents`：控制监听的事件类型，`public_guild_messages` 频道消息`direct_message` 频道私聊消息 `public_messages` Q群消息（需要权限）
|
||||
|
||||
## 配置 AI 模型provider.json
|
||||
|
||||
配置data/config/provider.json
|
||||
|
||||
配置提供AI聊天接口的信息
|
||||
|
||||
```json
|
||||
"enable-chat": true,
|
||||
```
|
||||
|
||||
`enable-chat`：是否开启AI聊天功能
|
||||
|
||||
```json
|
||||
"openai-config": {
|
||||
"api-keys": [
|
||||
"sk-1234567890"
|
||||
],
|
||||
"base_url": "https://api.openai.com/v1",
|
||||
"chat-completions-params": {
|
||||
"model": "gpt-3.5-turbo"
|
||||
},
|
||||
"request-timeout": 120
|
||||
},
|
||||
```
|
||||
|
||||
`api-keys`：以列表的形式设置若干个api key，例如：
|
||||
|
||||
```json
|
||||
"api-keys": [
|
||||
"sk-1234567890",
|
||||
"sk-23452354253",
|
||||
"sk-2352453674"
|
||||
],
|
||||
```
|
||||
|
||||
`base_url`：设置接口地址，后面一定要加`/v1`
|
||||
|
||||
`model`：选择模型
|
||||
|
||||
`request-timeout`：设置请求超时时间，以秒为单位，对于耗时较长的模型(如GPT4)，建议设置较大值
|
||||
@@ -5,12 +5,9 @@ head:
|
||||
content: ChatGPT QQ机器人教程，QChatGPT项目部署教程
|
||||
title: 消息平台部署教程
|
||||
icon: merge
|
||||
author: Lazy,ikun
|
||||
date: 2023-10-28
|
||||
category:
|
||||
- 部署教程
|
||||
author: Lazy
|
||||
date: 2023-02-17
|
||||
index: false
|
||||
|
||||
---
|
||||
|
||||
:::info 目录
|
||||
|
||||
@@ -8,8 +8,6 @@ icon: mobile
|
||||
order: 3
|
||||
author: ikun
|
||||
date: 2023-12-21
|
||||
category:
|
||||
- 部署教程
|
||||
---
|
||||
|
||||
# OpenShamrock(未来可能的方向)
|
||||
|
||||
@@ -5,10 +5,8 @@ head:
|
||||
content: ChatGPT QQ机器人教程，QChatGPT项目部署教程
|
||||
title: QChatGPT部署教程
|
||||
icon: flow
|
||||
author: Lazy,ikun
|
||||
date: 2023-10-28
|
||||
category:
|
||||
- 部署教程
|
||||
author: Lazy
|
||||
date: 2023-02-17
|
||||
index: false
|
||||
---
|
||||
:::info 目录
|
||||
|
||||
@@ -8,8 +8,6 @@ icon: stack
|
||||
order: 4
|
||||
author: Lazy,ikun
|
||||
date: 2023-10-28
|
||||
category:
|
||||
- 部署教程
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -6,10 +6,8 @@ head:
|
||||
title: 手动部署(推荐，可以在所有平台上使用)
|
||||
icon: support
|
||||
order: 3
|
||||
author: Lazy.ikun.RockChinQ
|
||||
date: 2023-10-29
|
||||
category:
|
||||
- 部署教程
|
||||
author: Lazy
|
||||
date: 2023-02-17
|
||||
---
|
||||
:::warning
|
||||
请使用Python 3.9.x以上版本，**注意不要使用3.12.x版本**，没有Python的需自行安装，参考[此教程](./more-details/python.md)
|
||||
@@ -73,184 +71,3 @@ python3 main.py
|
||||
- data/config/sensitive-words.json
|
||||
- data/scenario/default.json
|
||||
```
|
||||
|
||||
## 配置主程序
|
||||
|
||||
为了快速上手，你需要重点关注以下文件：
|
||||
|
||||
- `data/config/platform.json`
|
||||
- `data/config/provider.json`
|
||||
|
||||
### 配置data/config/platform.json
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "yiri-mirai",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080,
|
||||
"verifyKey": "yirimirai",
|
||||
"qq": 123456789
|
||||
},
|
||||
{
|
||||
"adapter": "nakuru",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"ws_port": 8080,
|
||||
"http_port": 5700,
|
||||
"token": ""
|
||||
},
|
||||
{
|
||||
"adapter": "aiocqhttp",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080
|
||||
},
|
||||
{
|
||||
"adapter": "qq-botpy",
|
||||
"enable": false,
|
||||
"appid": "",
|
||||
"secret": "",
|
||||
"intents": [
|
||||
"public_guild_messages",
|
||||
"direct_message"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
截至2024年2月13日，目前支持`mirai`、`go-cqhttp`、`aiocqhttp`、`QQ官方机器人`，支持同时开启多个消息适配器，甚至四个全开
|
||||
|
||||
#### 接入mirai
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "yiri-mirai",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080,
|
||||
"verifyKey": "yirimirai",
|
||||
"qq": 123456789
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "yiri-mirai"`，无需动，表明是接入`mirai`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`host`：主机地址，一般不动
|
||||
|
||||
`port`：设置端口，默认8080，与`mirai-api-http`里面设置的保持一致
|
||||
|
||||
`verifyKey`：密钥，默认yirimirai，与`mirai-api-http`里面设置的保持一致
|
||||
|
||||
`qq`：设置机器人QQ号，与当前mirai登录的机器人的QQ号保持一致
|
||||
|
||||
#### 接入go-cqhttp
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "nakuru",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"ws_port": 8080,
|
||||
"http_port": 5700,
|
||||
"token": ""
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "nakuru",`，无需动，表明是接入`go-cqhttp`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`host`：主机地址，一般不动
|
||||
|
||||
`ws_port`：正向WS服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
`http_port`：http服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
`token`：验证密钥，，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
#### 接入shamrock等onebot协议实现的机器人框架
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "aiocqhttp",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "aiocqhttp",`，无需动，表示是接入`shamrock等onebot协议实现的机器人框架`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`host`：主机地址，一般不动
|
||||
|
||||
`port`：设置端口，默认8080，与对应框架里面设置的保持一致
|
||||
|
||||
#### 接入QQ官方机器人
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "qq-botpy",
|
||||
"enable": false,
|
||||
"appid": "",
|
||||
"secret": "",
|
||||
"intents": [
|
||||
"public_guild_messages",
|
||||
"direct_message"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
`"adapter": "qq-botpy",`，无需动，表明是接入`QQ官方机器人`的配置
|
||||
|
||||
`enable`：是否启用，`true`开启
|
||||
|
||||
`appid`：申请到的QQ官方机器人的appid
|
||||
|
||||
`secret`：申请到的QQ官方机器人的secret
|
||||
|
||||
`intents`：控制监听的事件类型，`public_guild_messages` 频道消息`direct_message` 频道私聊消息 `public_messages` Q群消息（需要权限）
|
||||
|
||||
|
||||
|
||||
### 配置data/config/provider.json
|
||||
|
||||
配置提供AI聊天接口的信息
|
||||
|
||||
```json
|
||||
"enable-chat": true,
|
||||
```
|
||||
|
||||
`enable-chat`：是否开启AI聊天功能
|
||||
|
||||
```json
|
||||
"openai-config": {
|
||||
"api-keys": [
|
||||
"sk-1234567890"
|
||||
],
|
||||
"base_url": "https://api.openai.com/v1",
|
||||
"chat-completions-params": {
|
||||
"model": "gpt-3.5-turbo"
|
||||
},
|
||||
"request-timeout": 120
|
||||
},
|
||||
```
|
||||
|
||||
`api-keys`：以列表的形式设置若干个api key，例如：
|
||||
|
||||
```json
|
||||
"api-keys": [
|
||||
"sk-1234567890",
|
||||
"sk-23452354253",
|
||||
"sk-2352453674"
|
||||
],
|
||||
```
|
||||
|
||||
`base_url`：设置接口地址，后面一定要加`/v1`
|
||||
|
||||
`model`：选择模型
|
||||
|
||||
`request-timeout`：设置请求超时时间，以秒为单位，对于耗时较长的模型(如GPT4)，建议设置较大值
|
||||
|
||||
@@ -8,8 +8,6 @@ icon: support
|
||||
order: 3
|
||||
author: Lazy
|
||||
date: 2023-12-18
|
||||
category:
|
||||
- 部署教程
|
||||
---
|
||||
|
||||
## 第一步：安装Python
|
||||
|
||||
@@ -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/devolop/'/>
|
||||
@@ -1,14 +0,0 @@
|
||||
---
|
||||
head:
|
||||
- - meta
|
||||
- name: keywords
|
||||
content: ChatGPT QQ机器人报错，QChatGPT项目部署报错
|
||||
title: 常见问题
|
||||
icon: tree
|
||||
author: Lazy
|
||||
date: 2023-09-30
|
||||
category:
|
||||
- 常见问题
|
||||
index: false
|
||||
---
|
||||
<AutoCatalog base='/posts/error/'/>
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
head:
|
||||
- - meta
|
||||
- name: keywords
|
||||
content: QChatGPT的插件相关页面
|
||||
title: 插件相关
|
||||
icon: list
|
||||
order: 1
|
||||
author: Lazy
|
||||
date: 2023-12-20
|
||||
category:
|
||||
- 插件使用
|
||||
---
|
||||
|
||||
<AutoCatalog base='/posts/plugin/'/>
|
||||
@@ -10,6 +10,7 @@ author: Lazy
|
||||
date: 2023-12-20
|
||||
category:
|
||||
- 插件使用
|
||||
index: false
|
||||
---
|
||||
|
||||
<AutoCatalog base='/posts/plugin/some-plugin-deploy/'/>
|
||||
Reference in New Issue
Block a user