# Xboard New [English](README.md) | [中文](README_CN.md) ## About 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. ## 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 - MySQL 5.7+ - Redis - Laravel - Octane ## Quick Start Deploy and experience Xboard quickly using the following commands (based on 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 ``` After installation, visit http://SERVER_IP:7001 > Note: Admin credentials will be displayed during installation, make sure to save them. ## Preview ![Dashboard Preview](./docs/images/dashboard.png) ## Installation / Update / Rollback Click to view installation and update steps for: - [1panel Deployment](./docs/1panel安装指南.md) - [Docker Compose Quick Deployment](./docs/docker-compose安装指南.md) - [aapanel + Docker Compose (Recommended)](./docs/aapanel+docker安装指南.md) - [aapanel Deployment](./docs/aapanel安装指南.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 ``` > For aapanel installations, restart the webman daemon process