iKuai v4 Installation - FrankoonG/hy2scale GitHub Wiki

🌐 English | δΈ­ζ–‡

iKuai v4 Installation

Hy2Scale can be installed on iKuai v4 (Enterprise Edition) through the built-in Application Store using the .ipkg package format.

Important: This guide is for iKuai v4.x only. Verify your version under Syetem settings β†’ Version upgrade before proceeding.

iKuai v4 Version

Prerequisites

  • iKuai Free or Enterprise Edition v4.0.0 or later
  • iKev2 work on iKuai Enterprise Edition required
  • Application Store enabled
  • The .ipkg package file β€” download from GitHub Releases

Installation

Step 1: Upload the Package

Navigate to Applications β†’ Application Store and click Local installation in the top-right corner.

Local Installation

Drag and drop the hy2scale-x.x.x.ipkg file into the upload area, or click to select it.

Step 2: Configure Ports

After uploading, the Quick installation dialog appears. Configure the ports under the Application configuration tab:

Port Protocol Default Description
Web/API Port TCP 5565 Management UI and relay server
Relay Port UDP 5565 Hysteria2 QUIC relay

Quick Install Config

The Installation Instructions tab shows the application description and feature list.

Install Instructions

Click Install and start to complete the installation.

Step 3: Access the Web UI

Once installed, open the plugin details page and click Open, or navigate directly to:

http://<ikuai-ip>:<web-port>/scale/

Plugin Details

The default username is admin. Set your password on first login.

Runtime Mode

On iKuai v4, Hy2Scale runs in compat mode β€” the version badge will show Compat. This is expected because iKuai's minimal Linux kernel does not support standard iptables. Hy2Scale automatically uses TUN capture + xfrm bridge for L2TP/IKEv2 functionality.

IKEv2 Setup

Import iKuai CA Certificate

iKuai's built-in IKEv2 client requires a trusted CA certificate for server authentication, and Hy2Scale needs the matching private key so it can mint a server certificate signed by that CA on startup.

Open Settings β†’ TLS β†’ Import Certificate and paste both the certificate and the private key below, using ID ikuai:

Certificate (ikuai.crt):

-----BEGIN CERTIFICATE-----
MIIFpTCCA42gAwIBAgIJAKEUL8FqICNlMA0GCSqGSIb3DQEBCwUAMGkxCzAJBgNV
BAYTAklLMRAwDgYDVQQIDAdiZWlqaW5nMRAwDgYDVQQHDAdiZWlqaW5nMQ4wDAYD
VQQKDAVpa3VhaTEOMAwGA1UECwwFaWt1YWkxFjAUBgNVBAMMDWlrdWFpdGVzdC5j
b20wHhcNMjIxMjI3MDE1OTU4WhcNNDIwMjI1MDE1OTU4WjBpMQswCQYDVQQGEwJJ
SzEQMA4GA1UECAwHYmVpamluZzEQMA4GA1UEBwwHYmVpamluZzEOMAwGA1UECgwF
aWt1YWkxDjAMBgNVBAsMBWlrdWFpMRYwFAYDVQQDDA1pa3VhaXRlc3QuY29tMIIC
IjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtE42lFJmB/nMs4eIVsX3tOTB
liA9V5BdwXmTAxwlNfC72KQXJSUNtCJT20Q/u2dTR7aonLScD9EYC4iYaPyL9dsD
6/O4fYncf9qdOBRuvskExE30ARMt3an9QHlEAcjc9aWD13iDiFjopeTqprO79Jw3
R99JeAA9Cg5zyt84mlkFiZp1QvU/eioRN/Qy64FM3ske13PZnhO6zerxy2UO6nEw
3Ii5/bofRsTxrr72Xz1LKK0FZn0dpXBrXOpkCVDc+MXT6gs4xsuRGiksLu2bMeSY
Chl47IeELao5ELy/C8dZEatHqZovfk4tyRPzoy7CHRQF4gY4rQi9t+MiA+GTNigL
hnYS6T8QmCi1g03+ByySZ7+U0iH4t8V1C8qNRfFUMxen9iUsstb4cdcYh2u51Vjp
0OsyBbGfdspmkszGFHG7ZIpryTxtUZM+cdjZ2yTymbk/23wapRL4QvvyzeC8UWBf
UrJ0qPDRCeyxOKQh3iCZjaZfXR8lodo0cc9K5jFTPA3GXB60eAku2iPtxhGZFNZS
xH9lfaBeVQyDWtpOMm23hLLW6i+5pKZKkmpzFmbZPL5/U7SXh52urMtk1SQ2x24M
/PUeNzWwk7eEmBDn9+oHtvSGFkxnHWkwmvLmnVJwFU846BeJ0iUjNxYQaLovZHLK
UAn30G9z+TsVHziU4ZkCAwEAAaNQME4wHQYDVR0OBBYEFKeBnbrmY7UvE6ynLGsc
c00P2Xp+MB8GA1UdIwQYMBaAFKeBnbrmY7UvE6ynLGscc00P2Xp+MAwGA1UdEwQF
MAMBAf8wDQYJKoZIhvcNAQELBQADggIBAFhP5zlsdqLUM+ubEDDKSF36CAH6cra4
hvbm+J2GIRivuUfycpDrX6bkzTNDAf+lVkDRZgcCgpx7m523KVwbfSlSdg9MJOKu
3+n3M4w5heQbu0SJ55HsInSRHQ41ovCzOiAPbvj/aSuM9qzpC8/YkYcKoFFSRNR8
ppKMufH98os5lfUOW7UEvhcpIr3jbWYCB16EOcYTvjeqLx8XbNnm5lbz8Kb7N27M
OiqxYOjoNmvoBYVatUESlNsKOEwkGFmEXMr07cL1ZUI3gPLEGRaMhKNJP4kn7Rwv
n1Bwjgps4p7MGmuiyRj8qIDEu69b3wiB6GP/Hhl/RxfG6bVzhPCkNcsqUzLpGcV/
gewjqI0LMOyl/GT+McCkXe9QwFByRg+oBYXwsm5be2C92+hI0EuDrZlntysQtMkG
0DobdpJNWN0gFUTXzk4ztDDatIcr9Ipuf6i7xHksIQjPdvUquYqlo+/td80XIf3n
SVTcNSsv9ivjCiQ0omwVCkWYD7nZLeO85lClZDAEwqL26VSYQz8o+0VjIr05Gvg4
iP4Liaj2siLvD9xd9N3dswQ50M/Utmur2GORHsNkvuqNVeAyyVCPr/F7uVihhb2e
hFQcP2X16OVb0Q//blTBszDjEeqEUuxXm47nP/yYMcsbR0zknEcwbqBVsT7OfvUO
02E5mtp9AjU0
-----END CERTIFICATE-----

Private key (ikuai.key):

-----BEGIN RSA PRIVATE KEY-----
MIIJKQIBAAKCAgEAtE42lFJmB/nMs4eIVsX3tOTBliA9V5BdwXmTAxwlNfC72KQX
JSUNtCJT20Q/u2dTR7aonLScD9EYC4iYaPyL9dsD6/O4fYncf9qdOBRuvskExE30
ARMt3an9QHlEAcjc9aWD13iDiFjopeTqprO79Jw3R99JeAA9Cg5zyt84mlkFiZp1
QvU/eioRN/Qy64FM3ske13PZnhO6zerxy2UO6nEw3Ii5/bofRsTxrr72Xz1LKK0F
Zn0dpXBrXOpkCVDc+MXT6gs4xsuRGiksLu2bMeSYChl47IeELao5ELy/C8dZEatH
qZovfk4tyRPzoy7CHRQF4gY4rQi9t+MiA+GTNigLhnYS6T8QmCi1g03+ByySZ7+U
0iH4t8V1C8qNRfFUMxen9iUsstb4cdcYh2u51Vjp0OsyBbGfdspmkszGFHG7ZIpr
yTxtUZM+cdjZ2yTymbk/23wapRL4QvvyzeC8UWBfUrJ0qPDRCeyxOKQh3iCZjaZf
XR8lodo0cc9K5jFTPA3GXB60eAku2iPtxhGZFNZSxH9lfaBeVQyDWtpOMm23hLLW
6i+5pKZKkmpzFmbZPL5/U7SXh52urMtk1SQ2x24M/PUeNzWwk7eEmBDn9+oHtvSG
FkxnHWkwmvLmnVJwFU846BeJ0iUjNxYQaLovZHLKUAn30G9z+TsVHziU4ZkCAwEA
AQKCAgEAjTVL7XFy0wBB3sBgeITmcFdPfUGWiQNZSfLqvd7HDa2RkCNCtSaFyvOv
dOPIff537IwTFVclegWprS63HlHbUxrJwXrInBjiBYey5X6rFOPdxde/JzBcFWPS
ITJXnoYu9ns/+/o4GQp4eaQEWbYdl37YlIM8yKx3IW8cJGAZtlfNzGyZNW1Y31Ye
0hF/540GJNyiON5UKkcNX8OGxmJJAjbPq4exEhM393a6SL7puMEKIbsPpaqLE0wt
6UDwQ5N+254jTwKm3poC89gW8FHJ35NFt3Mnjya60ACmXINVo+Xlzb60ixFj7KlR
lk732m7+O0O5L8DrlihoXKGXvC5n2Qtjt8fQDTrCUSxMITM5xV3eh+47fNXXXZDR
WIBNf87fKa8i9ZDMW0uXzCCn1nZApNkdDVpfRiy7FPC9c4Sl/uGoOBLDoOlDkCPN
IScYG7LUksZk6jbbE5V1GetltaIwSYP/olJN6kBf/YjplZZ0IR7tjmGISqCd0SCp
mADWIglcZ/Cg7a33nQqaWFYQcpZMeh0/54iLw6Pt0xUA8vPLLg0HUrLxg3bZZ7O3
kd+6LP/pml/q4BufFfvSWkST7iNE92VCv9z1AEp53UPGtDHxqBcadc4hC+b//8Gp
DVZx9dcBTBOe18kCXjHWOMt9VOEU613h20ozb4lRpzGrkZYI6gECggEBAN4HhWw/
Zp2jt44Rz1sGXRzbsFYbjxeBsioJNYPPWg7LrKFcu3S2L24wUNC9VmCKb86s1B13
ph9DSOjMQctvP35d4QA6LPX1zdMM2lUIiqDBNqeSLV5ye/qgDhnGzF53udIKj8CN
boZI1U0kokPt0UDTWVOmz7urcsX+e3rB9SWDt5i8zrXQRu9jVaBkQCdX1dzwIjXz
/jWXQy6EIg4DLd7st3wPSAHvxolvXkt2ZxP+POEIUwFrU6HqO6/b52ulu90yvF1r
r1Neh7reO/mQAk1ClQyyJ66oY8bc9aoFXmuFPSMIG35Z5knRNbgUIV/jalF5wYqi
xYdLvZ0it+1qBqECggEBAM/kciRzl1NZhnuW4IM8z6kgb/Gub4jkjij/jpCHwRGD
SQ09Ou4PzjxEDjBc7oRXaaQgAaofXLBUfWLxSoVMADdFzbPQF5FAHS0mNIHn8eJz
GOWRi9x9pJk2yC2yqMw01RAtAfro7mRL0xlGJfPIFABUqtDqv3sTtRY2VoV2vfRT
gY8jhFZrnQ3T16rJZIYEJ35Jwt/bUP4tc+loofcqt9NYu9NQQ+YpFJ96e9FwCY+n
IC2PveHAh67Vwj5EtoA4QBhtnTI2eta6bmWDDodg7VvggrHG0HCyRaGavuTozkEh
MfysRz9Ov9qetqHq62q6NB0KASAAz6s7LHe3l4lxD/kCggEACRG7lHlegq/uToJR
uwEeipA6urmzdZ1ZnrfzlKfCoPoW2hyEl7bdZx3YHz6sqZLeEE4k9/MsOPixoLi/
M0UfDdVd3HmD3qQkvSs4O+L2bqyVw/CHo+T/RXSGPu1M6crwLzE5P/9G9XtCIz2M
10N+maxIaM9Wiu7s6EOF3bTQg7DGrhmARBL24s5m7/9IU5MV7EluzE9kIeJE30CM
d5APrpxyvkGNim616GVBL8ntWfa3m+WQJm2w49tChuNvp4kEjHuHEDXW2ovw9WQg
hQgp3+gJWJRqZIsCUFw0OLaxbajqn2S0YsvfSUKfdB52YolSjXNwwW32rZkdbK6/
XpZHIQKCAQEArYGjRgr3LEhWtkVpIf8Z7bS12UbVrbHbeBo6OSQkHeKtkJAe49tr
K9883F5jby6pa6KO4RaFvGD3uSFbKb8Rmw/2K3Gsibyx3SG6xwT3WyDmkYsU6LQw
MPOIxKMMwEoD3RlDQs8vT6P9DmX+fOTq1I/VdMHHiAgdpek58u/0f7tGMVnaNGpi
TM0WfWLSNAu5jmwvabfYdBspV4/NRcVwYML5F9cwpCJ7JNMMDfNs92jrsTr7pjOS
ynd7Q48DpiXMUNcDUIopoZc9Vhm4gYKC96B8U7Vz9+rBtKu7UL+AjNkQqCp82Dh4
ZRT7pk2zp4K6xdW4tKYYrHeZmF0w6zPiuQKCAQAl4Q0maJx4ACdcduEokP8BDxOJ
gUIL38zNCyzkeEpb4u4eK7FwWpyAvujYqllTjbCEODidclkaJ8N81/pp0bPKm/MN
57FgIRGA26cyUm3LMuI4QrlkVUlsEPLzp6uEcd1U2JHYEVM6vV05f6bBy9l3TBCj
hP6XIIiUYk8e0bYgJatoglvqVbW19k4fnFr4oIDpQDvWcdTZgfdyFWycnZ3TrnCN
pHyPHnXNAIg1CgKGsXsaFnBoK9mYC5MpxLZNTs85ltCst17lg/Y51+d3dWaXnBtn
K/RZgke/IHYtAHFOK5LhVdwlJ7ZrIUSPjmoqrWHepX7W2spFimrbRz3+FSEC
-----END RSA PRIVATE KEY-----

Configure Hy2Scale IKEv2 Server

On the Hy2Scale Proxies page, enable IKEv2 with:

  • Mode: MSCHAPv2
  • Certificate: ikuai
  • Pool: e.g. 192.168.26.1/24

Create a user on the Users page with a username and password for the IKEv2 client.

Configure iKuai IKEv2 Client

On the iKuai side, navigate to Network Settings β†’ VPN Client β†’ IKEv2/IPSec and add a new client:

  • Dial-up name: must start with iked_ (e.g. iked_test)
  • Server address: the Hy2Scale container IP on the doc_app_default network
  • Auth type: MSCHAPv2
  • Username / Password: the user created in Hy2Scale
  • Right ID: the Hy2Scale node ID (shown on the dashboard)

Once connected, the client will show a green status indicator and a local IP assigned from the pool.

IKEv2 Connected

⚠️ **GitHub.com Fallback** ⚠️