Skip to content

Commit c03f46b

Browse files
committed
updated readme
1 parent 5ed0b96 commit c03f46b

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# Reverse-SOXY
22

3-
A minimal, encrypted SOCKS5 tunnel for securely forwarding traffic between a **Proxy** and an **Agent**. Uses AES-CTR + HMAC to authenticate and encrypt the tunnel, plus SOCKS5 on the Proxy side.
3+
A minimal, encrypted SOCKS5 tunnel for securely forwarding traffic between a **Proxy** and an **Agent** (optionally using a **Relay** server). Uses AES-CTR + HMAC to authenticate and encrypt the tunnel, plus SOCKS5 on the Proxy side.
44

55
## Features
66

77
- **Proxy mode**: exposes a local SOCKS5 endpoint and listens for agent connections on a tunnel port.
88
- **Agent mode**: dials into the proxy over a secure, authenticated, AES-CTR tunnel.
9+
- **Relay mode**: starts a relay server. Useful when the Proxy cannot expose a public port.
10+
- **Proxy via Relay**: registers a Proxy behind NAT with the Relay, then starts the SOCKS5 front-end.
11+
- **Agent via Relay**: dials into the Relay on behalf of the Agent, establishing a secure tunnel via the relay.
912
- Graceful shutdown (SIGINT/SIGTERM) and automatic reconnect/backoff.
1013
- Simple YAML configuration override.
1114
- Zero external dependencies beyond the Go standard library and `gopkg.in/yaml.v3`.
@@ -30,6 +33,16 @@ Starts the SOCKS5 proxy front-end and listens for agent connections.
3033
--secret mySharedSecret
3134
```
3235

36+
### Agent mode
37+
38+
Dials into the proxy over the encrypted tunnel.
39+
40+
```bash
41+
./reverse-soxy \
42+
--tunnel-addr proxy.host:9000 \
43+
--secret mySharedSecret
44+
```
45+
3346
### Relay mode
3447

3548
Starts a public relay server on a VPS. Useful when the Proxy cannot expose a public port.
@@ -64,16 +77,6 @@ Dials into the Relay on behalf of the Agent, establishing a secure tunnel via th
6477
--secret mySharedSecret
6578
```
6679

67-
### Agent mode
68-
69-
Dials into the proxy over the encrypted tunnel.
70-
71-
```bash
72-
./reverse-soxy \
73-
--tunnel-addr proxy.host:9000 \
74-
--secret mySharedSecret
75-
```
76-
7780
### Common flags
7881

7982
| Flag | Description |

0 commit comments

Comments
 (0)