Skip to content

Commit e40f2e5

Browse files
madeyeclaude
andcommitted
Update README with setup wizard, CLI docs, and quick start section
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0be5948 commit e40f2e5

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ A stealth HTTPS forward proxy in Rust. It auto-obtains TLS certificates via Let'
99
- **CONNECT tunneling** — Full HTTPS tunnel support for proxying TLS traffic
1010
- **HTTP forwarding** — Plain HTTP proxy requests forwarded to upstream servers
1111
- **Multi-user auth** — Basic auth with multiple username/password pairs
12+
- **TUI setup wizard** — Interactive terminal UI to generate `config.yaml`
1213

1314
## Build
1415

@@ -46,11 +47,24 @@ stealth:
4647
| `users` | List of authorized proxy credentials |
4748
| `stealth.server_name` | `Server` header in fake 404 responses |
4849

50+
## Quick Start
51+
52+
```bash
53+
# Generate config interactively
54+
./target/release/https_proxy setup
55+
56+
# Or copy and edit the example
57+
cp config.example.yaml config.yaml
58+
```
59+
4960
## Usage
5061

5162
```bash
5263
# Start the proxy (requires port 443 and a DNS record pointing to this server)
53-
./target/release/https_proxy --config config.yaml
64+
./target/release/https_proxy run --config config.yaml
65+
66+
# Or just run with default config.yaml
67+
./target/release/https_proxy
5468
5569
# Use as HTTPS proxy
5670
curl --proxy https://alice:hunter2@proxy.example.com:443 https://httpbin.org/ip
@@ -64,6 +78,16 @@ curl --proxy https://wrong:creds@proxy.example.com:443 https://example.com
6478
# => 404 Not Found
6579
```
6680

81+
## CLI
82+
83+
```
84+
https-proxy [COMMAND]
85+
86+
Commands:
87+
setup Interactive TUI to create config.yaml
88+
run Start the proxy server (default if no command given)
89+
```
90+
6791
## How It Works
6892
6993
1. All connections terminate TLS with a valid Let's Encrypt certificate

0 commit comments

Comments
 (0)