diff --git a/README.md b/README.md index d26d08d..f60f90b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,12 @@ Features: - Request redirection - SSL/TLS support - Keep-alive connections -- Rustls support (not yet) + +TODO: +- Rustls support +- Sending IP in header (X-Forwarded-For) +- Remove panics +- Creating trees of flowgate ## Config @@ -14,13 +19,14 @@ Default `conf.yml`: http_host: localhost:80 # Http server host https_host: localhost:443 # Https server host -threadpool_size: 10 # Threadpool size (count of threads that accept requests) -connection_timeout: 10 # Read and write timeout of connections in seconds +threadpool_size: 10 # Threadpool size (count of threads that accept requests) (optional, default - 10) +connection_timeout: 10 # Read and write timeout of connections in seconds (optional, default - 10) sites: - domain: localhost # Site domain host: localhost:8080 # Http server host - support_keep_alive: false # Does server supports keep-alive connections + enable_keep_alive: true # Enable keep-alive connections (optional, default - true) + support_keep_alive: true # Does server supports keep-alive connections (optional, default - true) # ssl_cert: "/path/to/public/certificate.txt" # Ssl public certificate file (optional) # ssl_key: "/path/to/private/key.txt" # Ssl private key file (optional) ``` @@ -34,10 +40,10 @@ Rust features: - use-rustls ([rustls](https://github.com/rustls/rustls) - openssl alternative) ```sh -cargo run # Run -cargo run --release # Run release +cargo run # --------------------------------- # Run +cargo run --release # ----------------------- # Run release cargo build && sudo ./target/release/flowgate # Run with root -cargo build # Build -cargo build --release # Build release +cargo build # ------------------------------------------------ # Build +cargo build --release # -------------------------------------- # Build release cargo build --release --no-default-features --features FEATURE # Build with feature ``` \ No newline at end of file diff --git a/explaination.png b/explaination.png deleted file mode 100644 index 217957e..0000000 Binary files a/explaination.png and /dev/null differ