-
Notifications
You must be signed in to change notification settings - Fork 621
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
xboard
committed
Jan 22, 2025
1 parent
7acae3d
commit 6c67cbf
Showing
1 changed file
with
46 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,64 +1,64 @@ | ||
# 关于Xboard | ||
Xboard是基于V2board二次开发,在性能上和功能上都有大部分增强的**面板 | ||
# About Xboard | ||
Xboard is a panel based on V2board's secondary development, with significant enhancements in both performance and functionality. | ||
|
||
# 免责声明 | ||
本项目只是本人个人学习开发并维护,本人不保证任何可用性,也不对使用本软件造成的任何后果负责。 | ||
# Disclaimer | ||
This project is personally developed and maintained by me for learning purposes. I do not guarantee any availability and am not responsible for any consequences resulting from the use of this software. | ||
|
||
# Xboard 特点 | ||
基于V2board 二次开发,增加了以下特性 | ||
- 升级Laravel10 | ||
- 适配Laravels (提升至10+倍并发) | ||
- 适配Webman (比laravels快50%左右) | ||
- 修改配置从数据库中获取 | ||
- 支持Docker部署、分布式部署 | ||
- 支持根据用户IP归属地来下发订阅 | ||
- 增加Hy2支持 | ||
- 增加sing-box下发 | ||
- 支持直接从cloudflare获取访问者真实IP | ||
- 支持根据客户端版本自动下发新协议 | ||
- 支持线路筛选(订阅地址后面增加 &filter=香港|美国) | ||
- 支持Sqlite安装(代替Mysql,自用用户福音) | ||
- 使用Vue3 + TypeScript + NaiveUI + Unocss + Pinia重构用户前端 | ||
- 修复大量BUG | ||
# Xboard Features | ||
Based on V2board's secondary development, with the following added features: | ||
- Upgraded to Laravel 10 | ||
- Adapted to Laravels (10+ times concurrent improvement) | ||
- Adapted to Webman (about 50% faster than laravels) | ||
- Modified configuration retrieval from database | ||
- Support for Docker deployment and distributed deployment | ||
- Support for subscription distribution based on user IP location | ||
- Added Hy2 support | ||
- Added sing-box distribution | ||
- Support for obtaining real visitor IP directly from Cloudflare | ||
- Support for automatic new protocol distribution based on client version | ||
- Support for route filtering (add &filter=HongKong|USA after subscription URL) | ||
- Support for Sqlite installation (alternative to MySQL, great for personal use) | ||
- User frontend rebuilt using Vue3 + TypeScript + NaiveUI + Unocss + Pinia | ||
- Fixed numerous bugs | ||
|
||
# **系统架构** | ||
# **System Architecture** | ||
|
||
- PHP8.1+ | ||
- Composer | ||
- MySQL5.7+ | ||
- Redis | ||
- Laravel | ||
|
||
## 性能对比 [查看详情](./docs/性能对比.md) | ||
> xboard 无论前端还是后端性能都有巨大的提升 | ||
## Performance Comparison [View Details](./docs/性能对比.md) | ||
> xboard shows tremendous performance improvements in both frontend and backend | ||
|场景 | php-fpm(传统) | php-fpm(传统开启opcache) | laravels | webman(docker)| | ||
|---- | ---- |---- |----| ---| | ||
|首页 | 6请求/秒 | 157请求/秒 | 477请求/秒 | 803请求/秒 | | ||
|用户订阅 | 6请求/秒 | 196请求/秒 | 586请求/秒 | 1064请求/秒 | | ||
|用户首页延迟| 308ms | 110ms | 101ms | 98ms | | ||
|Scenario | php-fpm(traditional) | php-fpm(traditional with opcache) | laravels | webman(docker)| | ||
|---- | ---- |---- |---- | ---| | ||
|Homepage | 6 req/s | 157 req/s | 477 req/s| 803 req/s| | ||
|User Subscription| 6 req/s | 196 req/s | 586 req/s| 1064 req/s| | ||
|User Homepage Latency| 308ms | 110ms | 101ms | 98ms| | ||
|
||
## 页面展示 | ||
 | ||
## Page Display | ||
 | ||
|
||
## 安装 / 更新 / 回滚 | ||
你可以点击查看下列方式的**安装、更新**步骤 | ||
- [1panel 部署](./docs/1panel安装指南.md) | ||
- [Docker Compose 纯命令行快速部署](./docs/docker-compose安装指南.md) | ||
- [aapanel + Docker Compose (推荐)](./docs/aapanel+docker安装指南.md) | ||
- [aapanel 部署](./docs/aapanel安装指南.md) | ||
### 从其他版本迁移 | ||
#### 数据库迁移 | ||
**根据你的版本查看对应的迁移指南进行迁移** | ||
- v2board dev 23/10/27的版本 [点击跳转迁移指南](./docs/v2b_dev迁移指南.md) | ||
- v2board 1.7.4 [点击跳转迁移指南](./docs/v2b_1.7.4迁移指南.md) | ||
- v2board 1.7.3 [点击跳转迁移指南](./docs/v2b_1.7.3迁移指南.md) | ||
- v2board wyx2685 [点击跳转迁移指南](./docs/v2b_wyx2685迁移指南.md) | ||
## Installation / Update / Rollback | ||
You can click to view the **installation and update** steps for the following methods: | ||
- [1panel Deployment](./docs/1panel安装指南.md) | ||
- [Docker Compose Command-line Quick Deployment](./docs/docker-compose安装指南.md) | ||
- [aapanel + Docker Compose (Recommended)](./docs/aapanel+docker安装指南.md) | ||
- [aapanel Deployment](./docs/aapanel安装指南.md) | ||
|
||
### Migrating from Other Versions | ||
#### Database Migration | ||
**Check the corresponding migration guide according to your version** | ||
- v2board dev version 23/10/27 [Jump to Migration Guide](./docs/v2b_dev迁移指南.md) | ||
- v2board 1.7.4 [Jump to Migration Guide](./docs/v2b_1.7.4迁移指南.md) | ||
- v2board 1.7.3 [Jump to Migration Guide](./docs/v2b_1.7.3迁移指南.md) | ||
- v2board wyx2685 [Jump to Migration Guide](./docs/v2b_wyx2685迁移指南.md) | ||
|
||
### 注意 | ||
> 修改后台路径需要重启才能生效 | ||
### Note | ||
> Modifying the admin path requires a restart to take effect | ||
``` | ||
docker compose restart | ||
``` | ||
> 如果是是aapanel安装则需要重启 webman守护进程 | ||
> If using aapanel installation, you need to restart the webman daemon process |