Skip to content

Commit

Permalink
docs: add verbose field
Browse files Browse the repository at this point in the history
  • Loading branch information
dwisiswant0 committed Oct 3, 2023
1 parent b3e11b4 commit b7e7ed0
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ https://github.com/kitabisa/teler-proxy/assets/25837540/340dd31f-9686-4935-8522-
* [Development](#development)
* [In Memory](#in-memory)
* [FalcoSidekick URL](#falcosidekick-url)
* [Verbose](#verbose)
* [Demo](#demo)
* [Community](#community)
* [License](#license)
Expand Down Expand Up @@ -163,6 +164,7 @@ no_update_check: false
development: false
in_memory: false
falcosidekick_url: ""
verbose: false
```
Or the equivalent in JSON format:
Expand All @@ -183,7 +185,8 @@ Or the equivalent in JSON format:
"no_update_check": false,
"development": false,
"in_memory": false,
"falcosidekick_url": ""
"falcosidekick_url": "",
"verbose": false
}
```

Expand Down Expand Up @@ -256,6 +259,10 @@ FalcoSidekick URL (**falcosidekick_url**) is the URL of the FalcoSidekick endpoi

This field should be set to the URL of your FalcoSidekick instance, including the protocol & port (e.g. "http://localhost:2801"). Please refer to the [docs](https://github.com/kitabisa/teler-waf#falco-sidekick).

### Verbose

Verbose (**verbose**) is a boolean flag that controls whether verbose logging is enabled. When set to `true`, it enables detailed and informative logging messages.

## Demo

To experience the power of the teler WAF Proxy in action, simply follow these steps to set up and run the demo located in the [demo/](/demo) directory.
Expand Down
3 changes: 2 additions & 1 deletion teler-waf.conf.example.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@
"no_update_check": false,
"development": false,
"in_memory": false,
"falcosidekick_url": ""
"falcosidekick_url": "",
"verbose": false
}
3 changes: 2 additions & 1 deletion teler-waf.conf.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ no_stderr: false
no_update_check: false
development: false
in_memory: false
falcosidekick_url: ""
falcosidekick_url: ""
verbose: false

0 comments on commit b7e7ed0

Please sign in to comment.