init xboard node

2026-03-15 09:27:24 +08:00
commit 37e6c016cb
40 changed files with 11011 additions and 0 deletions
@@ -0,0 +1,45 @@
+# xboard-node
+
+Dedicated node backend for [Xboard](https://github.com/cedar2025/Xboard). Fully compatible with Xboard API.
+
+> **Disclaimer**: This project is for educational and learning purposes only.
+
+## Install
+
+### Script
+```bash
+bash <(curl -Ls https://raw.githubusercontent.com/cedar2025/xboard-node/dev/install.sh) \
+  -a https://panel.com -t TOKEN -n 1
+```
+
+### Docker
+```bash
+docker run -d --restart=always --network=host \
+  -e apiHost=https://panel.com \
+  -e apiKey=TOKEN \
+  -e nodeID=1 \
+  ghcr.io/cedar2025/xboard-node:latest
+```
+
+## Features
+
+- **Kernels**: sing-box (default) / Xray-core.
+- **Protocols**: Full coverage (V2Ray, Trojan, SS, Hysteria2, TUIC, Naive).
+- **Speed**: Kernel-level rate limiting.
+- **Sync**: Real-time WebSocket + REST fallback.
+- **Dev**: Single Go binary.
+
+## Configuration
+
+`config.yml`:
+```yaml
+panel:
+  url: "https://panel.com"
+  token: "token"
+  node_id: 1
+```
+
+## License
+
+MPL-2.0.
+