Xboard

项目简介

Xboard 是基于 Laravel 11 构建的现代化面板系统，专注于提供简洁高效的使用体验。

功能特性

• 基于 Laravel 12 + Octane，显著提升性能
• 全新后台界面（React + Shadcn UI）
• 现代化用户前端（Vue3 + TypeScript）
• 开箱即用的 Docker 部署方案
• 优化系统架构，提升可维护性

快速开始

git clone -b compose --depth 1 https://github.com/Micah123321/Xboard && \
cd Xboard && \
docker compose run -it --rm \
    -e ENABLE_SQLITE=true \
    -e ENABLE_REDIS=true \
    -e ADMIN_ACCOUNT=admin@demo.com \
    xboard php artisan xboard:install && \
docker compose up -d

安装完成后访问： http://SERVER_IP:7001
请务必保存安装过程中显示的管理员凭据

文档

升级说明

重要： 此版本包含较大变更。升级前请严格遵循升级文档并备份数据库。请注意，“升级”与“迁移”是不同流程，不要混淆。

开发指南

• 插件开发指南 - Xboard 插件开发完整说明
• 开发者指南（ZH-CN） - 本地开发、测试、运行与构建指南
• V2bX 对接指南（ZH-CN） - Xboard 到 V2bX 的完整对接指南

部署指南

• 使用 1Panel 部署
• 使用 Docker Compose 部署
• 使用 aaPanel 部署
• 使用 aaPanel + Docker 部署（推荐）

迁移指南

• 从 v2board dev 迁移
• 从 v2board 1.7.4 迁移
• 从 v2board 1.7.3 迁移
• 从 new-dev 升级到最新 Docker 版本

技术栈

• 后端：Laravel 11 + Octane
• 管理后台：React + Shadcn UI + TailwindCSS
• 用户前端：Vue3 + TypeScript + NaiveUI
• 部署方式：Docker + Docker Compose
• 缓存：Redis + Octane Cache

预览

免责声明

本项目仅供学习与交流使用。使用本项目所产生的任何后果由使用者自行承担。

维护说明

本项目当前处于轻度维护状态。我们将：

• 修复关键 bug 与安全问题
• 审核并合并重要的 Pull Request
• 提供必要的兼容性更新

但新功能开发可能会相对有限。

重要提示

1. 修改后台路径后需要重启：

docker compose restart

2. 使用 aaPanel 安装时，请重启 Octane 守护进程

参与贡献

欢迎提交 Issue 和 Pull Request 来共同改进项目。

Star 历史