update README

This commit is contained in:
Bastian Gruber 2025-07-22 13:51:55 +02:00
parent dd80e6b831
commit 2ce5b5fd67
No known key found for this signature in database
GPG key ID: D2DF996A188CFBA2

View file

@ -10,6 +10,7 @@ OHTTP enables clients to make HTTP requests without revealing their identity to
## Architecture ## Architecture
```
Client -> Relay -> Gateway -> Target Server Client -> Relay -> Gateway -> Target Server
| | | |
| v | v
@ -18,7 +19,7 @@ Client -> Relay -> Gateway -> Target Server
| [Encrypt Response] | [Encrypt Response]
| | | |
<--------+ <--------+
```
This implementation serves as the Gateway component, handling: This implementation serves as the Gateway component, handling:
- HPKE-encrypted request decapsulation - HPKE-encrypted request decapsulation
@ -43,7 +44,7 @@ The gateway is configured via environment variables:
### Basic Configuration ### Basic Configuration
```bash ```bash
LISTEN_ADDR=0.0.0.0:8080 # Server bind address PORT="8080" # Server port
BACKEND_URL=http://localhost:8080 # Default backend URL BACKEND_URL=http://localhost:8080 # Default backend URL
REQUEST_TIMEOUT=30 # Request timeout in seconds REQUEST_TIMEOUT=30 # Request timeout in seconds
MAX_BODY_SIZE=10485760 # Maximum request body size (10MB) MAX_BODY_SIZE=10485760 # Maximum request body size (10MB)