Xboard/README.md
xboard 6c67cbf85a
Some checks are pending
Docker Build and Publish / build (push) Waiting to run
update docs
2025-01-22 21:16:51 +08:00

2.9 KiB

About Xboard

Xboard is a panel based on V2board's secondary development, with significant enhancements in both performance and functionality.

Disclaimer

This project is personally developed and maintained by me for learning purposes. I do not guarantee any availability and am not responsible for any consequences resulting from the use of this software.

Xboard Features

Based on V2board's secondary development, with the following added features:

  • Upgraded to Laravel 10
  • Adapted to Laravels (10+ times concurrent improvement)
  • Adapted to Webman (about 50% faster than laravels)
  • Modified configuration retrieval from database
  • Support for Docker deployment and distributed deployment
  • Support for subscription distribution based on user IP location
  • Added Hy2 support
  • Added sing-box distribution
  • Support for obtaining real visitor IP directly from Cloudflare
  • Support for automatic new protocol distribution based on client version
  • Support for route filtering (add &filter=HongKong|USA after subscription URL)
  • Support for Sqlite installation (alternative to MySQL, great for personal use)
  • User frontend rebuilt using Vue3 + TypeScript + NaiveUI + Unocss + Pinia
  • Fixed numerous bugs

System Architecture

  • PHP8.1+
  • Composer
  • MySQL5.7+
  • Redis
  • Laravel

Performance Comparison View Details

xboard shows tremendous performance improvements in both frontend and backend

Scenario php-fpm(traditional) php-fpm(traditional with opcache) laravels webman(docker)
Homepage 6 req/s 157 req/s 477 req/s 803 req/s
User Subscription 6 req/s 196 req/s 586 req/s 1064 req/s
User Homepage Latency 308ms 110ms 101ms 98ms

Page Display

Example Image

Installation / Update / Rollback

You can click to view the installation and update steps for the following methods:

Migrating from Other Versions

Database Migration

Check the corresponding migration guide according to your version

Note

Modifying the admin path requires a restart to take effect

docker compose restart

If using aapanel installation, you need to restart the webman daemon process