update readme
This commit is contained in:
parent
1b7616be8d
commit
8c5e10a93e
34
README.md
34
README.md
@ -14,22 +14,30 @@ Default `conf.yml`:
|
|||||||
http_host: localhost:80 # Http server host
|
http_host: localhost:80 # Http server host
|
||||||
https_host: localhost:443 # Https 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:
|
sites:
|
||||||
# - domain: example.com # Domain with SSL
|
- domain: localhost # Site domain
|
||||||
# host: localhost:8080 # Http server host
|
host: localhost:8080 # Http server host
|
||||||
# ssl_cert: "/path/to/public/certificate.txt" # Ssl public certificate file
|
support_keep_alive: false # Does server supports keep-alive connections
|
||||||
# ssl_key: "/path/to/private/key.txt" # Ssl private key file
|
# ssl_cert: "/path/to/public/certificate.txt" # Ssl public certificate file (optional)
|
||||||
# support_keep_alive: true # Does server supports keep-alive connections
|
# ssl_key: "/path/to/private/key.txt" # Ssl private key file (optional)
|
||||||
|
|
||||||
# - 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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## How to run
|
||||||
|
|
||||||
|
You need [Rust](https://www.rust-lang.org/) installed with cargo!
|
||||||
|
|
||||||
Rust features:
|
Rust features:
|
||||||
- use-openssl
|
- use-openssl
|
||||||
- use-rustls ([rustls](https://github.com/rustls/rustls) - openssl alternative)
|
- 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
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user