Skip to content

Commit

Permalink
docs(README): update config doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dwisiswant0 committed Aug 3, 2023
1 parent 14fd05f commit 12ebb96
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down Expand Up @@ -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/[email protected]/threat#Threat).
Expand Down

0 comments on commit 12ebb96

Please sign in to comment.