From 01dda00800362829556a8b14e9fd21efd156bf60 Mon Sep 17 00:00:00 2001
From: MeexReay <meexreay@gmail.com>
Date: Sun, 13 Apr 2025 01:22:40 +0300
Subject: [PATCH] conf and readme update

---
 README.md | 18 ++++++++++++++----
 conf.yml  | 21 +++++++++++----------
 2 files changed, 25 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index eab89c1..28da951 100755
--- a/README.md
+++ b/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
diff --git a/conf.yml b/conf.yml
index 8c0f814..ac6f819 100755
--- a/conf.yml
+++ b/conf.yml
@@ -1,15 +1,16 @@
-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)
-    host: localhost:8080                             # Http server host
-    ip_forwarding: simple                            # IP forwarding method type (optional, default - header)
-    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)
-    replace_host: "meex.lol"                         # Replace Host header in requests to server (optional)
\ No newline at end of file
+ - domain: localhost                                # Site domain (use wildcard matching)
+   host: localhost:8080                             # Http server host
+   ip_forwarding: simple                            # IP forwarding method type (optional, default - header)
+   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)
+   replace_host: "meex.lol"                         # Replace Host header in requests to server (optional)
\ No newline at end of file