Skip to content

Commit ff96b37

Browse files
authored
Update README.md
1 parent 7689eeb commit ff96b37

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,30 @@ Client/Server configuration GUI for NaiveProxy and Caddy.
1111
+ Server: /etc/caddy; Service: /etc/systemd/system/caddy.service
1212

1313
![](https://github.com/AKotov-dev/NaiveGUI/blob/main/Screenshot1.png)
14+
15+
## How It Works
16+
1. Rent a VPS located outside your country.
17+
2. Point a domain to your server’s IP address: buy one or use a [free option](https://www.duckdns.org/).
18+
3. Launch NaiveGUI, enter your domain name, username, and password, then click “Create Client and Server”.
19+
Save the generated archive containing:
20+
- **client.json** — client configuration
21+
- **Caddyfile** — server configuration
22+
4. Install the `caddy-forwardproxy-naive` package on your server.
23+
**Important:** this package includes `/etc/caddy` and provides a full web server. It is intended to be the only web server running on your VPS.
24+
5. Upload the `Caddyfile` to the server into `/etc/caddy` and start the service:
25+
```
26+
systemctl restart caddy
27+
```
28+
6. In NaiveGUI, verify that your server is reachable over HTTPS using the **"Check page…"** link.
29+
7. If the domain is accessible, click **"Start"** and verify your proxy [using this test](https://whoer.net/ru).
30+
---
31+
### Connection Modes
32+
33+
The client and server support two modes: **QUIC** and **HTTPS (TCP)**.
34+
35+
In some regions, QUIC may be blocked or unstable, so **HTTPS is usually the preferred option**.
36+
37+
You can test the connection speed in each mode using the **"Check connection speed…"** link in NaiveGUI.
38+
39+
### Useful links
40+
[naiveproxy](https://github.com/klzgrad/naiveproxy?tab=readme-ov-file), [forwardproxy](https://github.com/klzgrad/forwardproxy), [sing-box](https://github.com/SagerNet/sing-box)

0 commit comments

Comments
 (0)