+3
日增长
4,868
stars
1,393
forks
34
watchers
238
prs
835
issues
0
releases
README
Xboard
!PHP
!MySQL
📖 Introduction
Xboard is a modern panel system built on Laravel 11, focusing on providing a clean and efficient user experience.
✨ Features
- 🚀 Built with Laravel 12 + 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
git clone -b compose --depth 1 https://github.com/cedar2025/Xboard && \
cd Xboard && \
docker compose run -it --rm \
-e ENABLE_SQLITE=true \
-e ENABLE_REDIS=true \
-e [email protected] \
xboard php artisan xboard:install && \
docker compose up -d
After installation, visit: http://SERVER_IP:7001
⚠️ Make sure to save the admin credentials shown during installation
📖 Documentation
🔄 Upgrade Notice
🚨 Important: This version involves significant changes. Please strictly follow the upgrade documentation and backup your database before upgrading. Note that upgrading and migration are different processes, do not confuse them.
Development Guides
- Plugin Development Guide - Complete guide for developing XBoard plugins
Deployment Guides
PHP 8.2.35 or later is required. Use the latest security patch for your PHP release series. Docker deployments must meet this requirement inside the container.
- Deploy with 1Panel
- Deploy with Docker Compose
- Deploy with aaPanel
- Deploy with aaPanel + Docker (Recommended)
Migration Guides
- Migrate from v2board dev
- Migrate from v2board 1.7.4
- Migrate from v2board 1.7.3
🛠️ 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
!Admin Preview
!User Preview
⚠️ Disclaimer
This project is for learning and communication purposes only. Users are responsible for any consequences of using this project.
❤️ Support The Project
If this project has helped you, donations are appreciated. They help support ongoing maintenance and would make me very happy.
TRC20: TLypStEWsVrj6Wz9mCxbXffqgt5yz3Y4XB
🌟 Maintenance Notice
This project is currently under light maintenance. We will:
- Fix critical bugs and security issues
- Review and merge important pull requests
- Provide necessary updates for compatibility
However, new feature development may be limited.
🔔 Important Notes
1. Restart required after modifying admin path:
bash
docker compose restart
2. For aaPanel installations, restart the Octane daemon process
🤝 Contributing
Issues and Pull Requests are welcome to help improve the project.
📈 Star HistoryTop issues
#1066Bug Report:Xboard node 服务端热重启失效:用户超限后仍可使用订阅节点,且新建节点无法及时生效49 comments · 2026-10-18#1088Bug Report:推荐一下客户端UI 苹果风格:https://github.com/XBWAP/Xboard-themes19 comments · 2026-11-09#919Bug Report:换了无数协议,通过机器模式部署的节点始终不通,14 comments · 2026-04-28#871Feature Request: 客户定制化线路的探讨10 comments · 2026-04-07#963Bug Report:服务器正在对全球大量 IP 发起 SSH 连接(22 端口),搬瓦工会检测并封禁8 comments · 2026-05-28#816Bug Report:clash & clash.meta订阅模板问题7 comments · 2026-03-18#921关于xboard-node 的问题,请好心的能人义士帮忙解答一些6 comments · 2026-04-28#1005Bug Report:我的节点服务器有多个IP,我想指定节点指定出口IP,该如何设置啊,我查看了你们的issue,没有找到5 comments · 2026-07-13