Skip to content

Commit

Permalink
提交,修改 README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xiwangly2 committed Jan 21, 2025
1 parent 754b5e1 commit f0b84a8
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 34 deletions.
69 changes: 37 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,62 +6,67 @@

~~早知道就用 Nonebot 了,何必自己造轮子~~

## 开始
## 快速开始

您可以使用 [Docker](#使用docker) 安装,安装前请配置 go-cqhttp 和 MySQL 的连接信息(MySQL 可能需要自己部署)
### 使用 Docker 部署

目前在 dev 更多数据库的支持,……咕咕咕
运行以下命令,即可拉取镜像并运行,您需要拷贝 `config/config_example.yml``$PWD/xwbot/config/config.yml` 并修改配置

或者是自己手动部署

下面的内容请根据使用的实际情况修改,不建议直接照抄

## 使用Docker

以下方法多选一

### (一)自己 Build

先克隆本仓库

`docker build -t xiwangly/xwbot .`

### (二)从 ghcr 拉取镜像

(推荐使用,ghcr会实时根据更改构建镜像)
```sh
docker run -itd -v $PWD/xwbot/config:/app/config --name=xwbot --net=host --restart=always ghcr.io/xiwangly2/xwbot:main
数据库可能需要额外安装并配置,初始化数据库请查看 `sql` 文件夹
```shell
docker run -itd -v $PWD/xwbot/config/config.yml:/app/config/config.yml --name=xwbot --pull=always --restart=always ghcr.io/xiwangly2/xwbot:main
```

其实你可用不用 host 网络,但是我懒得改了,自己映射要用的端口

### (三)从 DockerHub 拉取镜像

```sh
docker run -itd -v $PWD/xwbot/config:/app/config --name=xwbot --net=host --restart=always xiwangly/xwbot
`ghcr.io/xiwangly2/xwbot:main` 镜像同时安装了多种数据库的依赖支持,如果您想要更精简,可以自行构建镜像

## 配置说明
配置文件在`config/config_example.yml`,您需要将`config/config_example.yml`复制到`config/config.yml`并编辑其中的设置
```yaml
# 使用正向 Websocket
# OneBot WebSocket 服务器地址
host: '127.0.0.1' # 如果支持 OneBot 的机器人框架运行同在一台 1Panel 服务器上且均使用 Docker部署,可以使用 172.18.0.1
# OneBot WebSocket 服务器端口
port: '6700'
# 访问令牌
access_token: '' # 这个配置默认为空,如果您的 OneBot WebSocket 服务器自行配置了访问令牌,请填写
# 调试模式
debug: false # 这个配置默认为 false,如果您需要调试,请设置为 true,这将会输出详尽的日志信息
# 写日志
write_log: true # 这个配置默认为 true,如果您不需要写日志,请设置为 false,写日志会将所有对话记录写入到数据库中
# 遇到错误自动重启
auto_reconnect: false # 这个配置默认为 false,如果 Docker 容器的重启策略是 自动重启,建议保持设置为 false,这对于独立部署的程序且没有守护进程的情况下,可以保证程序不会因为错误而终止
# 选择数据库
select_database: 'postgresql' # 目前支持的选项有 mysql、postgresql、sqlite,mongo,您可以根据自己的需求选择

# 管理员列表
admin: # 这些列表决定了谁可以使用管理员命令和一些危险的命令,填写 QQ 号
- '1000'
- '1001'
```
我们建议将支持 OneBot 的机器人框架、数据库和本程序运行在同一个内网环境中,以减少网络延迟
### 更新/卸载
移除容器和镜像
`docker stop xwbot || docker rm xwbot || docker rmi ghcr.io/xiwangly2/xwbot:main`

要更新的话就再执行一遍安装步骤

##手动部署
## 手动部署

您需要自己安装 Python 环境,然后然后`pip install -r requirements.txt`,安装依赖
您需要自行安装 Python 环境,然后然后`pip install -r requirements.txt`,安装依赖


首次使用请将`config/config_example.yml`复制到`config/config.yml`
并编辑其中的设置,并且正确的配置 正向 websocket 通信

现在已适配 OneBot 11,目前我测试了 go-cqhttp 和 NapCat 都没问题

另外,还需要MySQL的存储支持,自己看着办吧
另外,还需要数据库的存储支持,自己看着办吧

别忘了导入数据库完成初始化,在`sql`文件夹里

自动化的部署脚本在写了……

> 如果 go-cqhttp 和数据库配置正常的话,您需要在分别在不同的群聊、私聊回复`/on`开启机器人(需要配置管理员QQ),这有效的避免了对一些无关的群聊的骚扰~~这样可以有效的潜伏在正常的群里面~~
> 如果 go-cqhttp 和数据库配置正常的话,您需要在分别在不同的群聊、私聊回复`/on`开启机器人(需要配置管理员QQ),这有效地避免了对一些无关的群聊的骚扰,~~这样可以有效地潜伏在正常的群里面~~
4 changes: 2 additions & 2 deletions config/config_example.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 使用正向websocket
# go-cqhttp 服务器地址
# 使用正向 Websocket
# OneBot WebSocket 服务器地址
host: 'localhost'
# OneBot WebSocket 服务器端口
port: '6700'
Expand Down

0 comments on commit f0b84a8

Please sign in to comment.