Files
proxynet/README.md

55 lines
1.3 KiB
Markdown

# Proxynet
Proxy to route regular TCP/UDP traffic through Reticulum.
## Installation
### Pipx
```bash
pipx install git+https://git.quad4.io/Quad4-Software/proxynet.git
```
### Poetry
Requires: Poetry, Git, Python 3.9+
```bash
git clone https://git.quad4.io/Quad4-Software/proxynet.git
cd proxynet
poetry install
```
## Usage
### Pipx
```bash
proxynet --server --identity my_server
proxynet --client --port 1080 --preferred <server_hash>
```
### Poetry
### Server Mode
```bash
# Basic server startup
poetry run proxynet --server --identity my_server
# Verbose server startup
poetry run proxynet --server --identity my_server -v
```
### Client Mode
```bash
# Start SOCKS5 proxy on localhost:1080 with a preferred server
poetry run proxynet --client --port 1080 --preferred <server_hash>
# Start proxy using any discovered servers (decentralized mode)
poetry run proxynet --client --port 1080
```
## Privacy
Traffic over Reticulum is end-to-end encrypted and anonymized between the client and the server using Reticulum's native Link encryption (X25519 and AES-256) and anonymity features. For internet traffic, use HTTPS/TLS to ensure the server operator cannot see your data contents. If operators are using wireshark, they will still be able to see what websites/IP you are connecting to.