mirror of https://github.com/suyiiyii/nonebot-bison.git synced 2025-06-05 19:36:43 +08:00

felinae98 5117b66d4f 📝 update docs to fit pyd2

2024-03-06 11:51:29 +08:00

4.9 KiB

Raw Blame History

sidebar	prev	next
auto	/usage	/usage/easy-use

让拜松骑上自行车

本节将教你部署 nonebot-bison 项目
想知道如何开始使用请看简单使用或者详细配置

如何选择？

没有其他需要，只想使用 Nonebot-Bison？想在 Bison 的基础上再加入其他插件？
试试作为 Bot 使用！
已有项目，想要增加 Nonebot-Bison？
试试作为插件使用！

作为插件使用

本部分假设大家会部署 nonebot2 ::: tip 看看别的！参考教程 nonebot2 部署
参考视频教程保姆级新手教学 - Well404 ::: ::: warning 防止环境冲突！建议所有操作都在虚拟环境下进行，推荐使用poetry或者 python 自带的venv :::

使用 nb-cli 安装

安装nb-cli
```
pip install nb-cli
```
使用nb-cli执行在项目根目录执行
```
nb plugin install nonebot-bison
```

手动安装

安装 pip 包nonebot-bison
```
pip install nonebot-bison
```
在pyproject.toml中导入插件nonebot_bison 编辑项目根目录下的pyproject.toml文件，添加如下内容：
```
[tool.nonebot]
plugins = [
  ... # 其他插件
  "nonebot_bison",
  ]
```

作为 Bot 使用

::: tip 额外提供

自动同意超级用户的好友申请
自动同意超级用户的加群邀请 :::

docker-compose 部署

首先创建一个新的空目录

mkdir nonebot-bison && cd nonebot-bison

在目录中下载docker-compose.yml
将其中的<your QQ>改成自己的 QQ 号

:::: code-group ::: code-group-item linux

wget https://raw.githubusercontent.com/felinae98/nonebot-bison/main/docker-compose.yml

::: ::: code-group-item windows

Invoke-WebRequest -Uri https://raw.githubusercontent.com/felinae98/nonebot-bison/main/docker-compose.yml -OutFile docker-compose.yml

::: ::::

部分片断：

    ...
      HOST: 0.0.0.0 # 0.0.0.0代表监听所有地址
      # SUPERUSERS: '[<your QQ>]' #取消该行注释，并将<your QQ>改为自己的QQ号
      BISON_CONFIG_PATH: /data
      # BISON_OUTER_URL: 'http://<your server ip>:8080/bison'
      #取消上行注释，并将<your server ip>改为你的服务器ip，bison不会自动获取ip
      BISON_FILTER_LOG: 'true'
      BISON_USE_PIC: 'false' # 如果需要将文字转为图片发送请改为true
    ports:
      - 8080:8080 # 容器映射的端口，如果需要修改请同时修改上面的BISON_OUTER_URL
    ...

::: tip 想要指定更多配置请参考详细配置 :::

启动 Bot（这里请八仙过海）

docker 部署

Bison 的 docker 镜像为felinae98/nonebot-bison

在为服务器安装了docker后可以直接进行使用

docker pull felinae98/nonebot-bison

docker run -d --name nonebot-bison \
  -e SUPERUSERS='["<your QQ>"]' \
  -e BISON_CONFIG_PATH='/data' \
  -e BISON_OUTER_URL='http://<your server ip>:8080/bison' \
  -e BISON_FILTER_LOG='true' \
  -e BISON_USE_PIC='false' \
  -p 8080:8080 \
  felinae98/nonebot-bison

相关配置参数可以使用-e作为环境变量传入

直接运行

可以参考nonebot 的运行方法 ::: danger 直接克隆源代码需要自行编译前端，否则会出现无法使用管理后台等情况。 ::: ::: danger 本项目中使用了 Python 3.10 的语法，如果出现问题，请检查 Python 版本 :::

首先安装 poetry：安装方法

clone 本项目，在项目中poetry install安装依赖

git clone https://github.com/felinae98/nonebot-bison.git
cd nonebot-bison
poetry install

安装 yarn，配置 yarn 源
- 安装Node.js
- 安装yarn
```
npm install -g yarn
```
在admin-fronted目录中运行yarn && yarn build编译前端
```
cd admin-frontend
yarn && yarn build
```
编辑.env.prod配置各种环境变量，见Nonebot2 配置 :::tip 找不到 .env.prod ？ .env.prod文件在项目根目录下，请确认当前目录为项目根目录 :::
运行poetry run python bot.py启动 Bot

4.9 KiB Raw Blame History Unescape Escape