docs: 修改文档目录

This commit is contained in:
xboard
2023-11-19 15:18:32 +08:00
parent 6773c87d8e
commit 7392165189
6 changed files with 62 additions and 3 deletions
+27
View File
@@ -0,0 +1,27 @@
## V2borad 1.7.3版本迁移指南
### 迁移脚本会对你的数据库做以下更改
- v2_stat_order 更名为 v2_stat
- 字段 `order_amount` 修改为 `order_total`
- 字段 `commission_amount` 修改为 `commission_total`
- 添加 `paid_count` 字段 类型 integer nullable
- 添加 `paid_total` 字段 类型 integer nullable
- 添加 `register_count` 字段 类型 integer nullable
- 添加 `invite_count` 字段 类型 integer nullable
- 添加 `transfer_used_total` 字段 类型 string 长度 32 nullable
- 添加 v2_log 数据表
- 添加 v2_server_hysteria 数据表
- 添加 v2_server_vless 数据表
### 迁移命令
```
php artisan migratefromv2b 1.7.3
```
>如果你是docker-compose 部署
```
docker compose down
docker compose run -it --rm xboard php artisan migratefromv2b 1.7.3
docker compose up -d
```
+19
View File
@@ -0,0 +1,19 @@
## V2borad 1.7.4版本迁移指南
### 迁移脚本会对你的数据库做以下更改
- 添加 v2_server_vless 数据表
### 迁移命令
#### 手动部署(aapanel)
> 如果你是手动(aapanel)部署的,执行以下命令
```
php artisan migratefromv2b 1.7.4
```
#### docker部署
> 如果你是使用的docker 部署,清执行以下命令
```
docker compose down
docker compose run -it --rm xboard php artisan migratefromv2b 1.7.4
docker compose up -d
```
+27
View File
@@ -0,0 +1,27 @@
## V2borad Dev版本迁移指南
> 请先按照官方升级指导升级到 2023/10/27的版本后再执行迁移操作
### 迁移脚本会对你的数据库做以下更改
- v2_order
- 添加 `surplus_order_ids` 字段 类型 text nullable 折抵订单
- v2_plan(影响功能:周期价值、 流量价值)
- 删除 `daily_unit_price` 字段
- 删除 `transfer_unit_price` 字段
- v2_server_hysteria (影响:Ignore Client Bandwidth 配置和混淆类型配置)
- 删除 `ignore_client_bandwidth` 字段
- 删除 `obfs_type` 字段
### 迁移命令
#### 手动部署(aapanel)
> 如果你是手动(aapanel)部署的,执行以下命令
```
php artisan migratefromv2b dev231027
```
#### docker部署
> 如果你是使用的docker 部署,清执行以下命令
```
docker compose down
docker compose run -it --rm xboard php artisan migratefromv2b dev231027
docker compose up -d
```
+29
View File
@@ -0,0 +1,29 @@
## V2borad wyx2685版本迁移指南
> 此迁移指南写于 2023/11/17 , 其他时间的版本可能会迁移失败
- wyx2685 添加了设备限制的功能,如果你迁移过来你会失去这个功能
- 你会失去wyx2685佬添加的 trojan的 **(我也不知道) 功能
- 你的hysteria2 线路需要重新配置
### 迁移脚本会对你的数据库做以下更改
- v2_plan
- 删除字段 `device_limit` nullable
- v2_server_hysteria
- 删除字段 `version`
- 删除字段 `obfs`
- 删除字段 `obfs_password`
- v2_server_trojan
- 删除字段 `network`
- 删除字段 `network_settings`
- v2_user
- 删除字段 `device_limit`
### 迁移命令
```
php artisan migratefromv2b wyx2685
```
>如果你是docker-compose 部署
```
docker compose down
docker compose run -it --rm xboard php artisan migratefromv2b wyx2685
docker compose up -d
```
+59
View File
@@ -0,0 +1,59 @@
# 在线设备数限制
1. 在订阅上添加客户端连接数限制
2. 用户订阅的时候将客户端限制附加到用户表字段上
3. 后端获取用户信息的时候增加客户端显示字段显示
4. 获取在线用户IP,判断是否达到了限制数量,当达到了限制IP数量拒绝新的IP连接 , 当有新的IP连接的时候立刻上报到xboard后端
5. 上报用户流量时附带IP
#### xboard 需要增加接口
1. 获取节点用户列表
```
{
"id": 1,
"uuid":"cd692137-3f7b-47fb-b7a3-037a203d6489",
"speed_limit": null,
"device_limit": 10,
"online_ips": ['1.1.1.1', '2.2.2.2']
}
```
2. 后端上报新的在线用户IP (后端获取到在线数量没达到用户在线限制才会上报)
```
{
"id": 1,
"new_online_ip": "3.3.3.3"
}
```
上报成功返回 ```{ "data":true }```
当达到用户在线数量限制就返回,面板的在线用户的IPs
```
{
"data": ['1.1.1.1','2.2.2.2','3.3.3.3','4.4.4.4','5.5.5.5']
}
```
3. 后端上报用户流量(IP,ID,流量,三要素)
```
{
"id":1,
"u": 100,
"d": 100,
"ip": "1.1.1.1"
}
```
#### 安全设计
1、为了不泄漏用户的在线IP, ip使用Hash加密处理, 后端有用户连接时,对用户的连接IP使用 hash验证
#### 界面反馈
##### 后台界面
- 在订阅界面增加用户设备限制
- 编辑用户时增加用户设备限制
- 在用户列表显示在线用户量
- 在订阅列表显示当前订阅在线用户、IP数量
- 在节点页面显示在线用户数量和IP数
##### 用户前端
- 首页增加在线链接设备数(旁边增加重置订阅按钮)
#### 后续性能优化
- 后端上报用户流量使用 brotli压缩,减少体积
- 后端上报新的用户IP接口使用websocet或者grpc