docs:优化用户文档的配置项部分的相关描述

This commit is contained in:
Azide
2022-09-23 23:23:56 +08:00
parent ac505f51d3
commit 0a3171689a
2 changed files with 16 additions and 9 deletions
+12 -5
View File
@@ -4,7 +4,7 @@ sidebar: auto
# 部署和使用
本节将教你快速部署和使用一个 nonebot-bison,如果你不知道要选择哪种部署方式,推荐使用[docker-compose](#docker-compose部署-推荐)
本节将教你快速部署和使用一个 nonebot-bison,如果你不知道要选择哪种部署方式,推荐使用[docker-compose](#docker-compose-部署-推荐)
## 部署
@@ -14,13 +14,15 @@ sidebar: auto
额外提供自动同意超级用户的好友申请和同意超级用户的加群邀请的功能
#### docker-compose 部署(推荐)
#### docker-compose 部署 \[推荐\]
1. 在一个新的目录中下载[docker-compose.yml](https://raw.githubusercontent.com/felinae98/nonebot-bison/main/docker-compose.yml)
将其中的`<your QQ>`改成自己的 QQ 号
```bash
wget https://raw.githubusercontent.com/felinae98/nonebot-bison/main/docker-compose.yml
```
2. 运行配置 go-cqhttp
```bash
@@ -30,7 +32,7 @@ sidebar: auto
通信方式选择:`3: 反向 Websocket 通信`
编辑`bot-data/config.yml`,更改下面字段:
```
```yml
account: # 账号相关
uin: <QQ号> # QQ账号
password: "<QQ密码>" # 密码为空时使用扫码登录
@@ -47,12 +49,16 @@ sidebar: auto
3. 登录 go-cqhttp
再次
```bash
docker-compose run go-cqhttp
```
参考[go-cqhttp 文档](https://docs.go-cqhttp.org/faq/slider.html#%E6%96%B9%E6%A1%88a-%E8%87%AA%E8%A1%8C%E6%8A%93%E5%8C%85)
完成登录
4. 确定完成登录后,启动 bot
```bash
docker-compose up -d
```
@@ -96,8 +102,9 @@ sidebar: auto
::: tip INFO
- 所有配置项可参[源文件](https://github.com/felinae98/nonebot-bison/blob/main/src/plugins/nonebot_bison/plugin_config.py)
- **配置项的配置方法** 请参考[NoneBot 配置方式](https://v2.nonebot.dev/docs/tutorial/configuration#%E9%85%8D%E7%BD%AE%E6%96%B9%E5%BC%8F),在`.env`/`.env.*`文件中写入希望配置的 Bison 配置项
- 所有可用配置项可参[源文件](https://github.com/felinae98/nonebot-bison/blob/main/src/plugins/nonebot_bison/plugin_config.py)
- 如果要在在 nonebot 中配置需要的**Bison 配置项**请参考[NoneBot 配置方式](https://v2.nonebot.dev/docs/tutorial/configuration#%E9%85%8D%E7%BD%AE%E6%96%B9%E5%BC%8F),在`.env`/`.env.*`文件中写入希望配置的 Bison 配置项
- 请注意,在`.env`/`.env.*`中添加的配置项 **不** 需要声明变量类型
:::
- `BISON_CONFIG_PATH`: 插件存放配置文件的位置,如果不设定默认为项目目录下的`data`目录