From 12ebb96a1440837ad81581bf75cda68e434f0cb7 Mon Sep 17 00:00:00 2001 From: Dwi Siswanto Date: Thu, 3 Aug 2023 14:01:19 +0700 Subject: [PATCH] docs(README): update config doc --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bbc6a79..90be3b9 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,11 @@ teler-proxy -h ## Configuration -If you don't provide a teler WAF configuration file (`-c`/`--conf`), the default configuration will be applied. The default configuration options are presented below in YAML format: +The configuration is provides a comprehensive set of options to fine-tune and tailor the behavior of the teler Web Application Firewall (WAF). Through the use of the teler WAF configuration (`-c`/`--conf`), you gain full control over how the WAF operates and responds to incoming traffic. + +In case you opt not to provide a custom configuration file, the teler WAF will seamlessly apply a default configuration, ensuring that your application remains protected with sensible and reasonable settings. + +The default configuration options are presented below in YAML format: ```yaml excludes: [] @@ -154,6 +158,8 @@ Or the equivalent in JSON format: } ``` +By leveraging this versatile teler WAF configuration, you can fine-tune the WAF to perfectly align with your specific security requirements, ensuring maximum protection for your web service while enjoying the flexibility and power of teler WAF. + ### Excludes Excludes (**excludes**) is a list of threat types (`[]int`) to exclude from the security checks. Please refer to the [docs](https://pkg.go.dev/github.com/kitabisa/teler-waf@v1.0.4/threat#Threat).