mirror of
https://github.com/cedar2025/Xboard.git
synced 2025-01-22 18:48:14 -05:00
update readme
This commit is contained in:
xboard
parent
9ae6fbaaa7
commit
bc0c8a93a0
86
README.md
86
README.md
@ -1,32 +1,34 @@
|
|||||||
# 关于Xboard
|
# Xboard New
|
||||||
Xboard New是基于Xboard二次开发，重写后台管理并优化系统架构的**面板，提升可维护性
|
|
||||||
|
|
||||||
# 免责声明
|
[English](README.md) | [中文](README_CN.md)
|
||||||
本项目只是本人个人学习开发并维护，本人不保证任何可用性，也不对使用本软件造成的任何后果负责。
|
|
||||||
|
|
||||||
# Xboard New 特点
|
## About Xboard
|
||||||
基于Xboard 二次开发，增加了以下特性
|
Xboard New is a panel system based on Xboard's secondary development, featuring a rewritten admin interface and optimized system architecture to improve maintainability.
|
||||||
- 升级Laravel11
|
|
||||||
- 增加Octane支持
|
|
||||||
- 使用React + Shadcn UI + TailwindCSS重构后台管理
|
|
||||||
- 使用Vue3 + TypeScript + NaiveUI + Unocss + Pinia重构用户前端
|
|
||||||
- 使用Docker Compose作为容器化部署工具
|
|
||||||
- 使用Docker作为容器化部署工具
|
|
||||||
- 重构主题管理，增加主题上传，并且只暴露激活主题
|
|
||||||
- 使用Octane Cache作为设置的缓存
|
|
||||||
- 优化系统架构，提升可维护性
|
|
||||||
# **系统架构**
|
|
||||||
|
|
||||||
- PHP8.2+
|
## Disclaimer
|
||||||
|
This project is personally developed and maintained. I do not guarantee any availability or take responsibility for any consequences of using this software.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Upgraded to Laravel 11
|
||||||
|
- Added Octane support
|
||||||
|
- Rebuilt admin interface using React + Shadcn UI + TailwindCSS
|
||||||
|
- Rebuilt user frontend using Vue3 + TypeScript + NaiveUI + Unocss + Pinia
|
||||||
|
- Using Docker Compose as containerization deployment tool
|
||||||
|
- Using Docker as containerization tool
|
||||||
|
- Restructured theme management with theme upload support and active theme exposure
|
||||||
|
- Using Octane Cache for settings caching
|
||||||
|
- Optimized system architecture for better maintainability
|
||||||
|
|
||||||
|
## System Requirements
|
||||||
|
- PHP 8.2+
|
||||||
- Composer
|
- Composer
|
||||||
- MySQL5.7+
|
- MySQL 5.7+
|
||||||
- Redis
|
- Redis
|
||||||
- Laravel
|
- Laravel
|
||||||
- Octane
|
- Octane
|
||||||
|
|
||||||
## 快速体验
|
## Quick Start
|
||||||
|
Deploy and experience Xboard quickly using the following commands (based on Docker + SQLite):
|
||||||
使用以下命令快速部署并体验 Xboard（基于 Docker + SQLite）：
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard && \
|
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard && \
|
||||||
@ -38,31 +40,31 @@ docker compose run -it --rm \
|
|||||||
web php artisan xboard:install && \
|
web php artisan xboard:install && \
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
安装完成后访问 http://服务器IP:7001
|
After installation, visit http://SERVER_IP:7001
|
||||||
|
|
||||||
> 提示：安装过程中会显示管理员账号密码，请务必保存。
|
> Note: Admin credentials will be displayed during installation, make sure to save them.
|
||||||
|
|
||||||
## 页面展示
|
## Preview
|
||||||
|
|
||||||
|
|
||||||
## 安装 / 更新 / 回滚
|
## Installation / Update / Rollback
|
||||||
你可以点击查看下列方式的**安装、更新**步骤
|
Click to view installation and update steps for:
|
||||||
- [1panel 部署](./docs/1panel安装指南.md)
|
- [1panel Deployment](./docs/1panel安装指南.md)
|
||||||
- [Docker Compose 纯命令行快速部署](./docs/docker-compose安装指南.md)
|
- [Docker Compose Quick Deployment](./docs/docker-compose安装指南.md)
|
||||||
- [aapanel + Docker Compose (推荐)](./docs/aapanel+docker安装指南.md)
|
- [aapanel + Docker Compose (Recommended)](./docs/aapanel+docker安装指南.md)
|
||||||
- [aapanel 部署](./docs/aapanel安装指南.md)
|
- [aapanel Deployment](./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)
|
|
||||||
|
|
||||||
|
## Migration from Other Versions
|
||||||
|
### Database Migration
|
||||||
|
**Check the corresponding migration guide based on your version:**
|
||||||
|
- v2board dev 23/10/27 version [Migration Guide](./docs/v2b_dev迁移指南.md)
|
||||||
|
- v2board 1.7.4 [Migration Guide](./docs/v2b_1.7.4迁移指南.md)
|
||||||
|
- v2board 1.7.3 [Migration Guide](./docs/v2b_1.7.3迁移指南.md)
|
||||||
|
- v2board wyx2685 [Migration Guide](./docs/v2b_wyx2685迁移指南.md)
|
||||||
|
|
||||||
### 注意
|
## Note
|
||||||
> 修改后台路径需要重启才能生效
|
> Modifying admin path requires restart to take effect:
|
||||||
```
|
```bash
|
||||||
docker compose restart
|
docker compose restart
|
||||||
```
|
```
|
||||||
> 如果是是aapanel安装则需要重启 webman守护进程
|
> For aapanel installations, restart the webman daemon process
|
||||||
70
README_CN.md
Normal file
70
README_CN.md
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
# Xboard New
|
||||||
|
|
||||||
|
[English](README.md) | [中文](README_CN.md)
|
||||||
|
|
||||||
|
# 关于Xboard
|
||||||
|
Xboard New是基于Xboard二次开发，重写后台管理并优化系统架构的面板，提升可维护性。
|
||||||
|
|
||||||
|
# 免责声明
|
||||||
|
本项目只是本人个人学习开发并维护，本人不保证任何可用性，也不对使用本软件造成的任何后果负责。
|
||||||
|
|
||||||
|
# Xboard New 特点
|
||||||
|
- 升级Laravel11
|
||||||
|
- 增加Octane支持
|
||||||
|
- 使用React + Shadcn UI + TailwindCSS重构后台管理
|
||||||
|
- 使用Vue3 + TypeScript + NaiveUI + Unocss + Pinia重构用户前端
|
||||||
|
- 使用Docker Compose作为容器化部署工具
|
||||||
|
- 使用Docker作为容器化部署工具
|
||||||
|
- 重构主题管理，增加主题上传，并且只暴露激活主题
|
||||||
|
- 使用Octane Cache作为设置的缓存
|
||||||
|
- 优化系统架构，提升可维护性
|
||||||
|
|
||||||
|
# 系统要求
|
||||||
|
- PHP8.2+
|
||||||
|
- Composer
|
||||||
|
- MySQL5.7+
|
||||||
|
- Redis
|
||||||
|
- Laravel
|
||||||
|
- Octane
|
||||||
|
|
||||||
|
## 快速体验
|
||||||
|
使用以下命令快速部署并体验 Xboard（基于 Docker + SQLite）：
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard && \
|
||||||
|
cd Xboard && \
|
||||||
|
docker compose run -it --rm \
|
||||||
|
-e ENABLE_SQLITE=true \
|
||||||
|
-e ENABLE_REDIS=true \
|
||||||
|
-e ADMIN_ACCOUNT=admin@demo.com \
|
||||||
|
web php artisan xboard:install && \
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
安装完成后访问 http://服务器IP:7001
|
||||||
|
|
||||||
|
> 提示：安装过程中会显示管理员账号密码，请务必保存。
|
||||||
|
|
||||||
|
## 页面展示
|
||||||
|
|
||||||
|
|
||||||
|
## 安装 / 更新 / 回滚
|
||||||
|
你可以点击查看下列方式的安装、更新步骤：
|
||||||
|
- [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)
|
||||||
|
|
||||||
|
### 注意
|
||||||
|
> 修改后台路径需要重启才能生效：
|
||||||
|
```bash
|
||||||
|
docker compose restart
|
||||||
|
```
|
||||||
|
> 如果是aapanel安装则需要重启 webman守护进程
|
||||||
Loading…
Reference in New Issue
Block a user