conf and readme update
This commit is contained in:
parent
e593decbed
commit
01dda00800
18
README.md
18
README.md
@ -3,22 +3,32 @@ HTTP requests redirection system
|
||||
|
||||
Features:
|
||||
- Request redirection
|
||||
- TLS support
|
||||
- TLS support (via Rustls!)
|
||||
- Keep-alive connections
|
||||
- Sending IP in header (X-Real-IP)
|
||||
- Multiple ip forwarding methods
|
||||
- Accepts incoming ip forwarding
|
||||
|
||||
TODO:
|
||||
- Remove panics
|
||||
- Creating trees of flowgate
|
||||
- Filter by headers
|
||||
- Modify response headers
|
||||
- HTTP/3 full support
|
||||
- HTTP/3 full support (quic/udp)
|
||||
|
||||
## How to use
|
||||
|
||||
Firstly, download it from releases. or build from sources (read BUILD.md) \
|
||||
Just run it and configure in `conf.yml` file.
|
||||
|
||||
### Logging
|
||||
|
||||
To get all logs (with debug ones), set this env var:
|
||||
|
||||
```
|
||||
RUST_LOG=debug
|
||||
```
|
||||
|
||||
Read more: [env_logger](https://docs.rs/env_logger/latest/env_logger/#enabling-logging)
|
||||
|
||||
## Configuration
|
||||
|
||||
### IP forwarding methods
|
||||
|
5
conf.yml
5
conf.yml
@ -1,8 +1,9 @@
|
||||
http_host: localhost:80 # Http server host
|
||||
https_host: localhost:443 # Https server host
|
||||
http_host: localhost:80 # Http server host (optional)
|
||||
https_host: localhost:443 # Https server host (optional)
|
||||
|
||||
connection_timeout: 10 # Read and write timeout of connections in seconds (optional, default - 10)
|
||||
incoming_ip_forwarding: none # Read IP forwarding on incoming connections (optional, default - none)
|
||||
threadpool_size: 10 # Size of the global threadpool (optional, default - 10)
|
||||
|
||||
sites:
|
||||
- domain: localhost # Site domain (use wildcard matching)
|
||||
|
Loading…
Reference in New Issue
Block a user