Skip to content

Commit d084d54

Browse files
iPythoningclaude
andcommitted
Initial release: S-UI + Cloudflare WARP one-liner deploy
- One-command setup: S-UI (6 protocols) + free WARP exit via wireproxy - Protocols: VLESS Reality, TUIC v5, Hysteria2, gRPC, Trojan, WebSocket - Ultra-low footprint: ~54MB total (S-UI ~50MB + wireproxy ~4MB) - Auto: swap, firewall, DNS, Reality keypair, client links - Includes uninstall script for clean removal Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
0 parents  commit d084d54

4 files changed

Lines changed: 847 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 iPythoning
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
# SUIWARP
2+
3+
**S-UI + Cloudflare WARP in one command.** Deploy a multi-protocol proxy server with clean Cloudflare IP exit in under 2 minutes.
4+
5+
```bash
6+
bash <(curl -sL https://raw.githubusercontent.com/iPythoning/SUIWARP/main/setup.sh)
7+
```
8+
9+
## What It Does
10+
11+
SUIWARP automates the entire setup of a production-ready proxy server:
12+
13+
1. **Installs [S-UI](https://github.com/alireza0/s-ui)** — sing-box management panel with 6 proxy protocols
14+
2. **Registers free Cloudflare WARP** — via [wgcf](https://github.com/ViRb3/wgcf)
15+
3. **Routes traffic through WARP** — via [wireproxy](https://github.com/pufferffish/wireproxy) (userspace WireGuard, ~4MB RAM)
16+
4. **Configures firewall, swap, DNS** — hardened and OOM-proof
17+
18+
## Architecture
19+
20+
```
21+
Client ──→ Your Server (S-UI / sing-box)
22+
23+
├─ VLESS Reality Vision :443/tcp ← daily driver
24+
├─ TUIC v5 :443/udp ← low latency
25+
├─ Hysteria2 :8443/udp ← max speed
26+
├─ VLESS Reality gRPC :2053/tcp ← multiplexed
27+
├─ Trojan Reality :8880/tcp ← classic
28+
└─ VLESS Reality WS :2083/tcp ← CDN compatible
29+
30+
31+
wireproxy (SOCKS5, ~4MB)
32+
33+
34+
Cloudflare WARP (free)
35+
36+
37+
Exit IP: Cloudflare (AS13335)
38+
```
39+
40+
## Why WARP?
41+
42+
| Without WARP | With WARP |
43+
|---|---|
44+
| VPS datacenter IP exposed | Cloudflare clean IP as exit |
45+
| IP easily flagged/blocked | High-reputation IP range |
46+
| Direct attribution to VPS | Traffic blends with Cloudflare CDN |
47+
| Single point of failure | Cloudflare's global network |
48+
49+
## Requirements
50+
51+
- **OS:** Ubuntu 20.04+ / Debian 11+ (x86_64 or ARM64)
52+
- **RAM:** 1GB minimum (512MB usable after OS)
53+
- **Access:** Root SSH
54+
55+
## Quick Start
56+
57+
### 1. Deploy
58+
59+
```bash
60+
bash <(curl -sL https://raw.githubusercontent.com/iPythoning/SUIWARP/main/setup.sh)
61+
```
62+
63+
### 2. Get Client Links
64+
65+
After installation, find your client links at:
66+
67+
```bash
68+
cat /root/suiwarp-client-links.txt
69+
```
70+
71+
Or visit the S-UI panel:
72+
```
73+
http://YOUR_IP:2095/app/
74+
Default: admin / admin ← change immediately!
75+
```
76+
77+
### 3. Connect
78+
79+
Import the links into your preferred client:
80+
81+
| Platform | Recommended Client |
82+
|---|---|
83+
| Windows | [v2rayN](https://github.com/2dust/v2rayN) |
84+
| macOS | [V2Box](https://apps.apple.com/app/id6446814690) |
85+
| iOS | [Shadowrocket](https://apps.apple.com/app/id932747118), [Stash](https://apps.apple.com/app/id1596063349) |
86+
| Android | [v2rayNG](https://github.com/2dust/v2rayNG), [NekoBox](https://github.com/MatsuriDayo/NekoBoxForAndroid) |
87+
| Linux | [nekoray](https://github.com/MatsuriDayo/nekoray) |
88+
89+
## Protocols
90+
91+
| # | Protocol | Port | Transport | Best For |
92+
|---|---|---|---|---|
93+
| 1 | VLESS Reality Vision | 443/tcp | TCP | Daily use (most covert) |
94+
| 2 | TUIC v5 | 443/udp | QUIC | Gaming (low latency) |
95+
| 3 | Hysteria2 | 8443/udp | QUIC | Streaming (max speed) |
96+
| 4 | VLESS Reality gRPC | 2053/tcp | gRPC | Multiplexing (stable) |
97+
| 5 | Trojan Reality | 8880/tcp | TCP | Classic fallback |
98+
| 6 | VLESS Reality WS | 2083/tcp | WebSocket | CDN/firewall bypass |
99+
100+
## Resource Usage
101+
102+
| Component | RAM | Description |
103+
|---|---|---|
104+
| S-UI (sing-box) | ~50MB | Panel + proxy core |
105+
| wireproxy | ~4MB | WARP tunnel |
106+
| **Total** | **~54MB** | Fits on 512MB VPS |
107+
108+
## Management
109+
110+
```bash
111+
# Service status
112+
systemctl status s-ui
113+
systemctl status wireproxy-warp
114+
115+
# View logs
116+
journalctl -u s-ui -f
117+
journalctl -u wireproxy-warp -f
118+
119+
# Restart services
120+
systemctl restart s-ui
121+
systemctl restart wireproxy-warp
122+
123+
# Check WARP exit IP
124+
curl -x socks5h://127.0.0.1:40000 ifconfig.me
125+
126+
# Check direct IP
127+
curl ifconfig.me
128+
```
129+
130+
## Uninstall
131+
132+
```bash
133+
bash <(curl -sL https://raw.githubusercontent.com/iPythoning/SUIWARP/main/uninstall.sh)
134+
```
135+
136+
Or if you have the repo cloned:
137+
138+
```bash
139+
bash uninstall.sh
140+
```
141+
142+
## How It Works
143+
144+
The key insight is using **wireproxy** — a userspace WireGuard implementation that exposes a local SOCKS5 proxy. This avoids:
145+
146+
- Kernel WireGuard module dependency
147+
- TUN device permissions
148+
- sing-box WireGuard compilation flags
149+
- Heavy `warp-cli` daemon (~100MB RAM)
150+
151+
Instead, wireproxy runs a ~4MB process that tunnels traffic through Cloudflare WARP and exposes `127.0.0.1:40000` as a SOCKS5 proxy. S-UI's sing-box is configured to route all outbound traffic through this SOCKS5 proxy, making all client traffic exit through Cloudflare's network.
152+
153+
## Firewall Ports
154+
155+
| Port | Protocol | Service |
156+
|---|---|---|
157+
| 443/tcp | TCP | VLESS Reality Vision |
158+
| 443/udp | UDP | TUIC v5 |
159+
| 8443/udp | UDP | Hysteria2 |
160+
| 2053/tcp | TCP | VLESS Reality gRPC |
161+
| 8880/tcp | TCP | Trojan Reality |
162+
| 2083/tcp | TCP | VLESS Reality WS |
163+
| 2095/tcp | TCP | S-UI Panel |
164+
| 2096/tcp | TCP | Subscription Server |
165+
166+
## Credits
167+
168+
- [S-UI](https://github.com/alireza0/s-ui) — sing-box web panel
169+
- [sing-box](https://github.com/SagerNet/sing-box) — universal proxy platform
170+
- [wireproxy](https://github.com/pufferffish/wireproxy) — userspace WireGuard proxy
171+
- [wgcf](https://github.com/ViRb3/wgcf) — Cloudflare WARP config generator
172+
173+
## License
174+
175+
[MIT](LICENSE)

0 commit comments

Comments
 (0)