docs: add server quickstart, stealth setup guide, and download table
This commit is contained in:
24
README.md
24
README.md
@@ -40,20 +40,36 @@ Most VPNs treat TCP as a fallback. Konduit is designed for TCP from the ground u
|
||||
|
||||
## Download
|
||||
|
||||
Releases are published on the [Releases](../../releases) page.
|
||||
Releases are published on the [Releases](../../releases) page. Each release includes:
|
||||
|
||||
| Binary | Purpose |
|
||||
|---|---|
|
||||
| `konduit-server` | VPN server |
|
||||
| `konduit` | CLI client (Linux) |
|
||||
| `konduit-ctl` | Server provisioning tool |
|
||||
|
||||
### Linux (CLI)
|
||||
|
||||
```bash
|
||||
# Download konduit-cli from the Releases page, then:
|
||||
chmod +x konduit-cli
|
||||
./konduit-cli connect --server vpn.example.com:443 --peer-id mydevice --psk YOUR_PSK
|
||||
# Download konduit and konduit-ctl from the Releases page, then:
|
||||
chmod +x konduit konduit-ctl
|
||||
|
||||
# Bootstrap a server
|
||||
echo "your secret mantra" | ./konduit-ctl bootstrap -l vpn.example.com:443 -p -
|
||||
|
||||
# Connect a client
|
||||
./konduit connect --config client.toml
|
||||
```
|
||||
|
||||
### macOS · Android · iOS
|
||||
|
||||
Coming soon.
|
||||
|
||||
## Server Setup
|
||||
|
||||
- [Server Quickstart](docs/server-quickstart.md) — install, provision, NAT setup for iptables and firewalld
|
||||
- [Stealth Mode Setup](docs/stealth-setup.md) — HAProxy TCP passthrough + camouflage configuration
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user