Home - FrankoonG/hy2scale GitHub Wiki
π English | δΈζ | νκ΅μ΄
A mesh relay network built on Hysteria 2 QUIC tunnels, managed from a web UI.
Nodes connect to each other directly through QUIC; each node can act as a relay, an exit, and a VPN server (L2TP, IKEv2, WireGuard, SOCKS5, HTTP, Shadowsocks). All configuration is done from the browser; there is no coordination server.
| Docker Hub | frankoong/hy2scale:latest |
| Current version | 1.3.2 |
Full mode (host network β everything enabled, including routing rules):
docker run -d --name hy2scale \
--network host --privileged \
-v hy2scale-data:/data \
--restart unless-stopped \
frankoong/hy2scale:latestBridge mode (VPN + proxies, no routing rules):
docker run -d --name hy2scale \
--cap-add NET_ADMIN --cap-add NET_RAW \
-p 5565:5565/tcp -p 5565:5565/udp \
-p 500:500/udp -p 4500:4500/udp -p 1701:1701/udp -p 51820:51820/udp \
-v hy2scale-data:/data \
--restart unless-stopped \
frankoong/hy2scale:latestOpen http://<host>:5565/scale/ β default login admin / admin. Change the password from Settings β System on first login.
See Installation for other deployment modes.


- Installation β Docker deployment, compose, ports, environment variables
- Nodes β mesh networking, graph view, nested discovery, multi-IP peers
- Proxies β Hysteria 2, SOCKS5, HTTP, Shadowsocks, L2TP, IKEv2, WireGuard
- Users β user management, per-user exit routing, traffic limits
- Rules β IP and domain routing rules
- TLS β certificate management, CA signing
- Settings β system, password, HTTPS, upgrade, backup
- Router Systems β running on stripped-kernel router distros
-
iKuai v4 Installation β
.ipkginstall on iKuai firmware - API Reference β REST endpoints
| Protocol | Auth | Client |
|---|---|---|
| Hysteria 2 | shared or per-user | Hysteria 2 client |
| SOCKS5 | user/password (RFC 1929) | any SOCKS5 client |
| HTTP / HTTPS proxy | Basic auth | any HTTP proxy client |
| Shadowsocks | per-user AEAD key | SS client |
| L2TP/IPsec | MSCHAPv2 | built-in OS VPN |
| IKEv2/IPsec | EAP-MSCHAPv2 or PSK | built-in OS VPN |
| WireGuard | per-peer public key | WireGuard / QR import |
L2TP, IKEv2, and the five application-layer proxies share a single user database; WireGuard uses its own per-peer key store. Per-user exit_via paths apply to every protocol in the first group.