What is this?
A script that turns a clean VPS into a ready VPN server in minutes: it installs the official 3X-UI panel, sets up 11 popular protocols, a certificate and a firewall, and gives you one subscription link. No domain needed.
A script that turns a clean VPS into a ready VPN server in minutes: it installs the official 3X-UI panel, sets up 11 popular protocols, a certificate and a firewall, and gives you one subscription link. No domain needed.So is this an app I install on my computer, or something that runs on a server?It's a set of shell scripts you run once on your VPS over SSH — they set up and maintain the server side. Your devices then just import the subscription link into regular client apps.
It's a set of shell scripts you run once on your VPS over SSH — they set up and maintain the server side. Your devices then just import the subscription link into regular client apps.How do I get it running?Connect to the server via SSH as root and run the install script from the README. A couple of minutes later it shows the panel address, login, password and your subscription link with a QR code.
Connect to the server via SSH as root and run the install script from the README. A couple of minutes later it shows the panel address, login, password and your subscription link with a QR code.What kind of server do I need for this?A VPS with Ubuntu 22.04/24.04 or Debian 12/13 and root SSH access. Ports 443 and 80 must be free, which they already are on a fresh server.
A VPS with Ubuntu 22.04/24.04 or Debian 12/13 and root SSH access. Ports 443 and 80 must be free, which they already are on a fresh server.Any catches I should know about?Panel, subscription and all protocols share one TCP port 443, and a random visitor just sees an ordinary site. The project is also made for educational purposes, so make sure your use complies with local laws.
Panel, subscription and all protocols share one TCP port 443, and a random visitor just sees an ordinary site. The project is also made for educational purposes, so make sure your use complies with local laws.Will it work if my server is in Russia?Yes — every protocol was verified with real client apps on the Xray, Mihomo and sing-box cores, including a server located in Russia; the results are in tests/matrix.
Yes — every protocol was verified with real client apps on the Xray, Mihomo and sing-box cores, including a server located in Russia; the results are in tests/matrix.If I paste my subscription link into the router config generator, where does it go?Nowhere — the generator computes everything in your browser and the links are not sent to any server.
Nowhere — the generator computes everything in your browser and the links are not sent to any server.Which protocols does it set up?Eleven: VLESS REALITY, XHTTP, WebSocket, Trojan gRPC, VMess, Shadowsocks 2022, Hysteria2, TUIC, AmneziaWG (classic and 3.1) and MTProto for Telegram — all through the single port 443.
Eleven: VLESS REALITY, XHTTP, WebSocket, Trojan gRPC, VMess, Shadowsocks 2022, Hysteria2, TUIC, AmneziaWG (classic and 3.1) and MTProto for Telegram — all through the single port 443.Which apps can I import the subscription into?Hiddify, Happ, v2rayN, Karing, Clash Verge and FlClash: each gets its own format and only the protocols it actually supports.
Hiddify, Happ, v2rayN, Karing, Clash Verge and FlClash: each gets its own format and only the protocols it actually supports.Can it configure my router as well?Yes — the built-in generator makes ready configs for Keenetic with XKeen (Xray or Mihomo core) and OpenWrt with Nikki (Mihomo, beta), plus one command that places the config on the router itself.
Yes — the built-in generator makes ready configs for Keenetic with XKeen (Xray or Mihomo core) and OpenWrt with Nikki (Mihomo, beta), plus one command that places the config on the router itself.How do I manage users and updates later?One command, kit user add, adds a user to every protocol at once with a shared traffic limit, expiry and device cap. The server updates itself from signed releases, and kit backup saves a full copy with users and keys.
One command, kit user add, adds a user to every protocol at once with a shared traffic limit, expiry and device cap. The server updates itself from signed releases, and kit backup saves a full copy with users and keys.What are similar projects?Open-Box, vpn-configs-for-russia, panda-vpn-pro, nyx, hiddify-app, sing-box-yg, BPB-Worker-Panel, v2ray-agent
Open-Box, vpn-configs-for-russia, panda-vpn-pro, nyx, hiddify-app, sing-box-yg, BPB-Worker-Panel, v2ray-agent