Skip to content

Commit

Permalink
docs(readme): update: heroku 等
Browse files Browse the repository at this point in the history
  • Loading branch information
yiyungent committed Apr 14, 2022
1 parent 33f53f1 commit cda4034
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 20 deletions.
52 changes: 32 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<h1 align="center">QQBotHub</h1>

> QQ 机器人 | 基于 Konata.Core | 一键免费部署
> QQ 机器人 | 基于 [Konata.Core](https://github.com/KonataDev/Konata.Core) | 一键免费部署
[![repo size](https://img.shields.io/github/repo-size/yiyungent/QQBotHub.svg?style=flat)]()
[![LICENSE](https://img.shields.io/github/license/yiyungent/QQBotHub.svg?style=flat)](https://github.com/yiyungent/QQBotHub/blob/master/LICENSE)
Expand All @@ -10,7 +10,7 @@

## Introduce

QQ 机器人 | 基于 Konata.Core | 一键免费部署
QQ 机器人 | 基于 [Konata.Core](https://github.com/KonataDev/Konata.Core) | 一键免费部署

- **Web 可视化** 无需再在 Console 上操作
- **插件化架构** 轻松使用插件扩展
Expand All @@ -19,16 +19,21 @@ QQ 机器人 | 基于 Konata.Core | 一键免费部署
## 功能

- [x] 在线登录
- [x] 在线 QQ 登录
- [x] 其它大部分功能由 插件提供

## Screenshots

![qq_online.png](./screenshots/qq_online.png)

## Quick Start

### 部署

#### 方式1: 使用 Railway 免费 一键部署

> 点击下方按钮 一键部署
> - 点击下方按钮 一键部署
> - Railway 每月有 `$5` 免费额度, 若只跑本项目完全够用
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/A3JY-J?referralCode=8eKBDA)

Expand All @@ -39,47 +44,56 @@ QQ 机器人 | 基于 Konata.Core | 一键免费部署
| --------------------------- | ---- | ----------------------- |
| `PLUGINCORE_ADMIN_USERNAME` || PluginCore Admin 用户名 |
| `PLUGINCORE_ADMIN_PASSWORD` || PluginCore Admin 密码 |
| `BOT_QQ` || 机器人 QQ |
| `BOT_PASSWORD` || 机器人 QQ 密码 |


> 注意:
> - Railway 修改环境变量 会 触发 重新 Deploy
> - Railway 重新 Deploy 后会删除数据, 你安装的所有插件及数据都将清空。
#### 方式2: 使用 Heroku 免费 一键部署

> - 点击下方按钮 一键部署
> - Heroku 每月有免费时长
> - Heroku 应用一段时间不访问会自动休眠, 因此为了保证存活, 请使用第三方监控保活, 例如: [UptimeRobot: Free Website Monitoring Service](https://uptimerobot.com/)
[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/yiyungent/QQBotHub)



##### Heroku 环境变量

| 环境变量名称 | 必填 | 备注 |
| --------------------------- | ---- | ----------------------- |
| `PLUGINCORE_ADMIN_USERNAME` || PluginCore Admin 用户名 |
| `PLUGINCORE_ADMIN_PASSWORD` || PluginCore Admin 密码 |



#### 方式2: 使用 Docker

#### 方式3: 使用 Docker

```bash
docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name qqbothub yiyungent/qqbothub
```

```bash
docker exec -it qqbothub bash

# 或者使用 docker cp , 从宿主机复制进容器, 或者 run 时就用挂载
apt-get update
apt-get install vim
vi /app/settings.json
```

> 进入容器, 修改 `/app/settings.json`,
> 若没有此文件, 则 使用 [settings.json](https://github.com/yiyungent/QQBotHub/blob/main/deploy/railway/settings.json) 此示例, 修改为你的机器人 QQ 和密码
> 现在访问: <http://localhost:5004/PluginCore/Admin>


### QQ 登录

> 部署完成后
> > 一定要先登录 `PluginCore Admin`
> > 一定要先登录 `PluginCore Admin`, 因为 `QQ登录页面``PluginCore Admin` 使用相同权限
> 1. 访问: <https://your-domain/PluginCore/Admin> 进入 `PluginCore Admin`
> 2. 访问: <https://your-domain/login> 进行 QQ机器人 登录
> 2. 访问: <https://your-domain> 进行 QQ机器人 登录
> 若为 `短信验证` , 则直接输入收到的验证码, 点击 `提交验证` 即可
> 若为 `滑动验证` , 则 `点击前往验证`, 浏览器在 `滑动验证` 页面 `F12`, 再选择 `Network`, 通过滑动验证后, 复制 `ticket` 如下 (不要包括双引号), 将 `ticket` 粘贴到输入框, 点击 `提交验证` 即可
> 若为 `滑动验证` , 则 `点击前往验证`, 浏览器在 `滑动验证` 页面 `F12`, 再选择 `Network`, 通过滑动验证后, 复制 `ticket` 如下 (不要包括双引号), 将 `ticket` 粘贴到输入框, 点击 `提交验证` 即可
![login_slide.png](./screenshots/login_slide.png)

Expand All @@ -99,8 +113,6 @@ vi /app/settings.json
> 然后直接 `上传 -> 安装 -> 文档 -> 设置 -> 启用 -> 文档` 即可

## Screenshots




Expand Down
Binary file added screenshots/qq_online.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cda4034

Please sign in to comment.