diff --git a/README.md b/README.md index bd2fc78..d26d08d 100644 --- a/README.md +++ b/README.md @@ -14,22 +14,30 @@ 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 + sites: - # - domain: example.com # Domain with SSL - # host: localhost:8080 # Http server host - # ssl_cert: "/path/to/public/certificate.txt" # Ssl public certificate file - # ssl_key: "/path/to/private/key.txt" # Ssl private key file - # support_keep_alive: true # Does server supports keep-alive connections - - # - domain: sub.example.com # Domain with no SSL - # host: localhost:8081 # Http server host - # support_keep_alive: true # Does server supports keep-alive connections - - - domain: localhost - host: localhost:8080 - support_keep_alive: false + - domain: localhost # Site domain + host: localhost:8080 # Http server host + support_keep_alive: false # Does server supports keep-alive connections + # ssl_cert: "/path/to/public/certificate.txt" # Ssl public certificate file (optional) + # ssl_key: "/path/to/private/key.txt" # Ssl private key file (optional) ``` +## How to run + +You need [Rust](https://www.rust-lang.org/) installed with cargo! + Rust features: - use-openssl - use-rustls ([rustls](https://github.com/rustls/rustls) - openssl alternative) + +```sh +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 --release --no-default-features --features FEATURE # Build with feature +``` \ No newline at end of file