mirror of
https://github.com/suyiiyii/nonebot-bison.git
synced 2025-06-06 20:06:12 +08:00
122 lines
5.4 KiB
Markdown
122 lines
5.4 KiB
Markdown
---
|
||
sidebar: auto
|
||
---
|
||
# 部署和使用
|
||
本节将教你快速部署和使用一个nonebot-bison，如果你不知道要选择哪种部署方式，推荐使用[docker-compose](#docker-compose部署-推荐)
|
||
|
||
## 部署
|
||
本项目可以作为单独的Bot使用，可以作为nonebot2的插件使用
|
||
### 作为Bot使用
|
||
额外提供自动同意超级用户的好友申请和同意超级用户的加群邀请的功能
|
||
#### 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
|
||
docker-compose run go-cqhttp
|
||
```
|
||
通信方式选择：`3: 反向 Websocket 通信`
|
||
编辑`bot-data/config.yml`，更改下面字段：
|
||
```
|
||
account: # 账号相关
|
||
uin: <QQ号> # QQ账号
|
||
password: "<QQ密码>" # 密码为空时使用扫码登录
|
||
|
||
message:
|
||
post-format: array
|
||
|
||
............
|
||
|
||
servers:
|
||
- ws-reverse:
|
||
universal: ws://nonebot:8080/cqhttp/ws # 将这个字段写为这个值
|
||
```
|
||
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
|
||
```
|
||
#### docker部署
|
||
本项目的docker镜像为`felinae98/nonebot-bison`，可以直接pull后run进行使用，
|
||
相关配置参数可以使用`-e`作为环境变量传入
|
||
#### 直接运行（不推荐）
|
||
可以参考[nonebot的运行方法](https://v2.nonebot.dev/guide/getting-started.html)
|
||
::: danger
|
||
直接克隆源代码需要自行编译前端，否则会出现无法使用管理后台等情况。
|
||
:::
|
||
::: danger
|
||
本项目中使用了Python 3.9的语法，如果出现问题，请检查Python版本
|
||
:::
|
||
1. 首先安装poetry：[安装方法](https://python-poetry.org/docs/#installation)
|
||
2. clone本项目，在项目中`poetry install`安装依赖
|
||
2. 安装yarn，配置yarn源（推荐）
|
||
3. 在`admin-fronted`中运行`yarn && yarn build`编译前端
|
||
3. 编辑`.env.prod`配置各种环境变量，见[Nonebot2配置](https://v2.nonebot.dev/guide/basic-configuration.html)
|
||
4. 运行`poetry run python bot.py`启动机器人
|
||
### 作为插件使用
|
||
本部分假设大家会部署nonebot2
|
||
#### 手动安装
|
||
1. 安装pip包`nonebot-bison`
|
||
2. 在`bot.py`中导入插件`nonebot_bison`
|
||
### 自动安装
|
||
使用`nb-cli`执行：`nb plugin install nonebot_bison`
|
||
## 配置
|
||
可参考[源文件](https://github.com/felinae98/nonebot-bison/blob/main/src/plugins/nonebot_bison/plugin_config.py)
|
||
* `BISON_CONFIG_PATH`: 插件存放配置文件的位置，如果不设定默认为项目目录下的`data`目录
|
||
* `BISON_USE_PIC`: 将文字渲染成图片后进行发送，多用于规避风控
|
||
* `BISON_BROWSER`: 本插件使用Chrome来渲染图片
|
||
* 使用browserless提供的Chrome管理服务，设置为`ws://xxxxxxxx`，值为Chrome Endpoint（推荐）
|
||
* 使用本地安装的Chrome，设置为`local:<chrome path>`，例如`local:/usr/bin/google-chrome-stable`
|
||
* 如果不进行配置，那么会在启动时候自动进行安装（不推荐）
|
||
* `BISON_OUTER_URL`: 从外部访问服务器的地址，默认为`http://localhost:8080/bison`，如果你的插件部署
|
||
在服务器上，建议配置为`http://<你的服务器ip>:8080/bison`
|
||
## 使用
|
||
::: warning
|
||
本节假设`COMMAND_START`设置中包含`''`，如果出现bot不响应的问题，请先
|
||
排查这个设置
|
||
:::
|
||
### 命令
|
||
#### 在本群中进行配置
|
||
所有命令都需要@bot触发
|
||
* 添加订阅（仅管理员和群主和SUPERUSER）：`添加订阅`
|
||
* 查询订阅：`查询订阅`
|
||
* 删除订阅（仅管理员和群主和SUPERUSER）：`删除订阅`
|
||
#### 私聊机器人获取后台地址
|
||
`后台管理`，之后点击返回的链接
|
||
如果你是superuser，那么你可以管理所有群的订阅；如果你是bot所在的群的其中部分群的管理，
|
||
你可以管理你管理的群里的订阅；如果你不是任意一个群的管理，那么bot将会报错。
|
||
::: tip
|
||
可以和bot通过临时聊天触发
|
||
:::
|
||
::: warning
|
||
网页的身份鉴别机制全部由bot返回的链接确定，所以这个链接并不能透露给别人。
|
||
并且链接会过期，所以一段时间后需要重新私聊bot获取新的链接。
|
||
:::
|
||
#### 私聊机器人进行配置（需要SUPERUER权限）
|
||
* 添加订阅：`管理-添加订阅`
|
||
* 查询订阅：`管理-查询订阅`
|
||
* 删除订阅：`管理-删除订阅`
|
||
### 所支持平台的uid
|
||
#### Weibo
|
||
* 对于一般用户主页`https://weibo.com/u/6441489862?xxxxxxxxxxxxxxx`，`/u/`后面的数字即为uid
|
||
* 对于有个性域名的用户如：`https://weibo.com/arknights`，需要点击左侧信息标签下“更多”，链接为`https://weibo.com/6279793937/about`，其中中间数字即为uid
|
||
#### Bilibili
|
||
主页链接一般为`https://space.bilibili.com/161775300?xxxxxxxxxx`，数字即为uid
|
||
#### RSS
|
||
RSS链接即为uid
|
||
#### 网易云音乐-歌手
|
||
在网易云网页上歌手的链接一般为`https://music.163.com/#/artist?id=32540734`，`id=`
|
||
后面的数字即为uid
|
||
#### 网易云音乐-电台
|
||
在网易云网页上电台的链接一般为`https://music.163.com/#/djradio?id=793745436`，`id=`
|
||
后面的数字即为uid
|