tcjlj/Xboard
1
0
Fork 0
mirror of https://github.com/cedar2025/Xboard.git synced 2025-01-22 18:48:14 -05:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
xboard 2025-01-16 01:10:00 +08:00
parent 414da3cb1f
commit 0799f81709
6 changed files with 117 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
README.md
View File

@ -1,39 +1,32 @@
# Xboard New # Xboard
[English](README.md) | [中文](README_CN.md) <div align="center">
[![Telegram Channel](https://img.shields.io/badge/Telegram-Channel-blue)](https://t.me/XboardOfficial) [![Telegram](https://img.shields.io/badge/Telegram-Channel-blue)](https://t.me/XboardOfficial)
![PHP](https://img.shields.io/badge/PHP-8.2+-green.svg)
![MySQL](https://img.shields.io/badge/MySQL-5.7+-blue.svg)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
## About Xboard English | [简体中文](README_CN.md)
Xboard New is a panel system based on Xboard's secondary development, featuring a rewritten admin interface and optimized system architecture to improve maintainability.
## Disclaimer </div>
This project is personally developed and maintained. I do not guarantee any availability or take responsibility for any consequences of using this software.
## Features ## 📖 Introduction
- 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 Xboard is a modern panel system built on Laravel 11, focusing on providing a clean and efficient user experience.
- PHP 8.2+
- Composer
- MySQL 5.7+
- Redis
- Laravel
- Octane
## Quick Start ## ✨ Features
Deploy and experience Xboard quickly using the following commands (based on Docker + SQLite):
- 🚀 Built with Laravel 11 + Octane for significant performance gains
- 🎨 Redesigned admin interface (React + Shadcn UI)
- 📱 Modern user frontend (Vue3 + TypeScript)
- 🐳 Ready-to-use Docker deployment solution
- 🎯 Optimized system architecture for better maintainability
## 🚀 Quick Start
```bash ```bash
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard && \ git clone -b compose --depth 1 https://github.com/cedar2025/Xboard && \
cd Xboard && \ cd Xboard && \
docker compose run -it --rm \ docker compose run -it --rm \
-e ENABLE_SQLITE=true \ -e ENABLE_SQLITE=true \
@ -42,35 +35,49 @@ docker compose run -it --rm \
web php artisan xboard:install && \ web php artisan xboard:install && \
docker compose up -d docker compose up -d
``` ```
After installation, visit http://SERVER_IP:7001
> Note: Admin credentials will be displayed during installation, make sure to save them. > After installation, visit: http://SERVER_IP:7001
> ⚠️ Make sure to save the admin credentials shown during installation
## 📚 Documentation
### Deployment Guides
- [Deploy with 1Panel](./docs/zh-CN/installation/1panel.md)
- [Deploy with Docker Compose](./docs/zh-CN/installation/docker-compose.md)
- [Deploy with aaPanel](./docs/zh-CN/installation/aapanel.md)
- [Deploy with aaPanel + Docker](./docs/zh-CN/installation/aapanel-docker.md) (Recommended)
### Migration Guides
- [Migrate from v2board dev](./docs/zh-CN/migration/v2board-dev.md)
- [Migrate from v2board 1.7.4](./docs/zh-CN/migration/v2board-1.7.4.md)
- [Migrate from v2board 1.7.3](./docs/zh-CN/migration/v2board-1.7.3.md)
- [Migrate from v2board wyx2685](./docs/zh-CN/migration/v2board-wyx2685.md)
## 🛠️ Tech Stack
- Backend: Laravel 11 + Octane
- Admin Panel: React + Shadcn UI + TailwindCSS
- User Frontend: Vue3 + TypeScript + NaiveUI
- Deployment: Docker + Docker Compose
- Caching: Redis + Octane Cache
## 📷 Preview
## Preview
![Dashboard Preview](./docs/images/dashboard.png) ![Dashboard Preview](./docs/images/dashboard.png)
## Documentation ## ⚠️ Disclaimer
### Installation This project is for learning and communication purposes only. Users are responsible for any consequences of using this project.
- [1Panel Installation](./docs/zh-CN/installation/1panel.md)
- [Docker Compose Installation](./docs/zh-CN/installation/docker-compose.md)
- [aapanel + Docker Installation](./docs/zh-CN/installation/aapanel-docker.md)
- [aapanel Installation](./docs/zh-CN/installation/aapanel.md)
### Migration ## 🔔 Important Notes
- [v2board dev Migration](./docs/zh-CN/migration/v2board-dev.md)
- [v2board 1.7.4 Migration](./docs/zh-CN/migration/v2board-1.7.4.md)
- [v2board 1.7.3 Migration](./docs/zh-CN/migration/v2board-1.7.3.md)
- [v2board wyx2685 Migration](./docs/zh-CN/migration/v2board-wyx2685.md)
- [Config Migration](./docs/zh-CN/migration/config.md)
### Development 1. Restart required after modifying admin path:
- [Device Limit Design](./docs/zh-CN/development/device-limit.md)
- [Performance Comparison](./docs/zh-CN/development/performance.md)
## Note
> Modifying admin path requires restart to take effect:
```bash ```bash
docker compose restart docker compose restart
``` ```
> For aapanel installations, restart the webman daemon process
2. For aaPanel installations, restart the Octane daemon process
## 🤝 Contributing
Issues and Pull Requests are welcome to help improve the project.

105
README_CN.md
View File

@ -1,39 +1,32 @@
# Xboard New # Xboard
[English](README.md) | [中文](README_CN.md) <div align="center">
[![Telegram 频道](https://img.shields.io/badge/Telegram-Channel-blue)](https://t.me/XboardOfficial) [![Telegram](https://img.shields.io/badge/Telegram-Channel-blue)](https://t.me/XboardOfficial)
![PHP](https://img.shields.io/badge/PHP-8.2+-green.svg)
![MySQL](https://img.shields.io/badge/MySQL-5.7+-blue.svg)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
## 关于 Xboard [English](README.md) | 简体中文
Xboard New 是基于 Xboard 二次开发的面板系统，重写了管理界面，优化了系统架构，提高了可维护性。
## 免责声明 </div>
本项目为个人开发维护，不保证可用性，使用本软件造成的任何后果由使用者自行承担。
## 特性 ## 📖 简介
- 升级到 Laravel 11
- 添加 Octane 支持
- 使用 React + Shadcn UI + TailwindCSS 重构管理界面
- 使用 Vue3 + TypeScript + NaiveUI + Unocss + Pinia 重构用户前端
- 使用 Docker Compose 作为容器化部署工具
- 使用 Docker 作为容器化工具
- 重构主题管理，支持主题上传和主题暴露
- 使用 Octane Cache 进行设置缓存
- 优化系统架构，提高可维护性
## 系统要求 Xboard 是一个基于 Laravel 11 开发的现代化面板系统，专注于提供简洁、高效的用户体验。
- PHP 8.2+
- Composer
- MySQL 5.7+
- Redis
- Laravel
- Octane
## 快速开始 ## ✨ 特性
使用以下命令快速部署并体验 Xboard（基于 Docker + SQLite）：
- 🚀 基于 Laravel 11 + Octane，性能提升显著
- 🎨 全新设计的管理界面 (React + Shadcn UI)
- 📱 现代化的用户前端 (Vue3 + TypeScript)
- 🐳 开箱即用的 Docker 部署方案
- 🎯 优化的系统架构，提供更好的可维护性
## 🚀 快速开始
```bash ```bash
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard && \ git clone -b compose --depth 1 https://github.com/cedar2025/Xboard && \
cd Xboard && \ cd Xboard && \
docker compose run -it --rm \ docker compose run -it --rm \
-e ENABLE_SQLITE=true \ -e ENABLE_SQLITE=true \
@ -42,35 +35,49 @@ 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
> 注意：管理员账号密码会在安装时显示，请务必保存。 > 安装完成后访问：http://服务器IP:7001
> ⚠️ 请务必保存安装时显示的管理员账号密码
## 预览 ## 📚 使用文档
![仪表盘预览](./docs/images/dashboard.png)
## 文档 ### 部署教程
- [使用 1Panel 部署](./docs/zh-CN/installation/1panel.md)
### 安装指南 - [Docker Compose 部署](./docs/zh-CN/installation/docker-compose.md)
- [1Panel 部署教程](./docs/zh-CN/installation/1panel.md) - [使用 aaPanel 部署](./docs/zh-CN/installation/aapanel.md)
- [Docker Compose 快速部署](./docs/zh-CN/installation/docker-compose.md) - [aaPanel + Docker 部署](./docs/zh-CN/installation/aapanel-docker.md)（推荐）
- [aapanel + Docker 部署（推荐）](./docs/zh-CN/installation/aapanel-docker.md)
- [aapanel 部署教程](./docs/zh-CN/installation/aapanel.md)
### 迁移指南 ### 迁移指南
- [v2board dev 版本迁移](./docs/zh-CN/migration/v2board-dev.md) - [从 v2board dev 迁移](./docs/zh-CN/migration/v2board-dev.md)
- [v2board 1.7.4 迁移](./docs/zh-CN/migration/v2board-1.7.4.md) - [从 v2board 1.7.4 迁移](./docs/zh-CN/migration/v2board-1.7.4.md)
- [v2board 1.7.3 迁移](./docs/zh-CN/migration/v2board-1.7.3.md) - [从 v2board 1.7.3 迁移](./docs/zh-CN/migration/v2board-1.7.3.md)
- [v2board wyx2685 迁移](./docs/zh-CN/migration/v2board-wyx2685.md) - [从 v2board wyx2685 迁移](./docs/zh-CN/migration/v2board-wyx2685.md)
- [配置迁移指南](./docs/zh-CN/migration/config.md)
### 开发文档 ## 🛠️ 技术栈
- [在线设备限制设计](./docs/zh-CN/development/device-limit.md)
- [性能对比报告](./docs/zh-CN/development/performance.md)
## 注意事项 - 后端：Laravel 11 + Octane
> 修改后台路径需要重启才能生效： - 管理面板：React + Shadcn UI + TailwindCSS
- 用户前端：Vue3 + TypeScript + NaiveUI
- 部署方案：Docker + Docker Compose
- 缓存系统：Redis + Octane Cache
## 📷 界面预览
![仪表盘预览](./docs/images/dashboard.png)
## ⚠️ 免责声明
本项目仅供学习交流使用，使用本项目造成的任何后果由使用者自行承担。
## 🔔 注意事项
1. 修改后台路径后需要重启：
```bash ```bash
docker compose restart docker compose restart
``` ```
> 对于 aapanel 安装，需要重启 webman 守护进程
2. aaPanel 环境下需要重启 Octane 守护进程
## 🤝 参与贡献
欢迎提交 Issue 和 Pull Request 来帮助改进项目。

4
compose.sample.yaml
View File

@ -1,6 +1,6 @@
services: services:
web: web:
image: ghcr.io/cedar2025/xboard:new image: ghcr.io/cedar2025/xboard:latest
volumes: volumes:
- ./.docker/.data/redis/:/data/ - ./.docker/.data/redis/:/data/
- ./:/www/ - ./:/www/
@ -12,7 +12,7 @@ services:
command: php artisan octane:start --port=7001 --host=0.0.0.0 command: php artisan octane:start --port=7001 --host=0.0.0.0
restart: on-failure restart: on-failure
horizon: horizon:
image: ghcr.io/cedar2025/xboard:new image: ghcr.io/cedar2025/xboard:latest
volumes: volumes:
- ./.docker/.data/redis/:/data/ - ./.docker/.data/redis/:/data/
- ./:/www/ - ./:/www/

2
docs/en/installation/1panel.md
View File

@ -62,7 +62,7 @@ apt update && apt install -y git
yum update && yum install -y git yum update && yum install -y git
# Clone repository # Clone repository
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard ./ git clone -b compose --depth 1 https://github.com/cedar2025/Xboard ./
# Configure Docker Compose # Configure Docker Compose
``` ```

2
docs/zh-CN/installation/1panel.md
View File

@ -87,7 +87,7 @@ apt update && apt install -y git
yum update && yum install -y git yum update && yum install -y git
# 克隆项目 # 克隆项目
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard ./ git clone -b compose --depth 1 https://github.com/cedar2025/Xboard ./
``` ```
#### 4.2 配置 Docker Compose #### 4.2 配置 Docker Compose

2
docs/zh-CN/installation/docker-compose.md
View File

@ -17,7 +17,7 @@ systemctl start docker
1. 获取项目文件： 1. 获取项目文件：
```bash ```bash
git clone -b compose-new --depth 1 https://github.com/cedar2025/Xboard git clone -b compose --depth 1 https://github.com/cedar2025/Xboard
cd Xboard cd Xboard
``` ```