diff --git a/docs/DEVELOPER.md b/docs/DEVELOPER.md index 70abf93..b59f749 100644 --- a/docs/DEVELOPER.md +++ b/docs/DEVELOPER.md @@ -3,10 +3,9 @@ ## Developer guide - +**Table of Contents** -**Table of Contents** - [Local development](#local-development) - [DDEV setup](#ddev-setup) diff --git a/docs/INSTALLATION_GUIDE.md b/docs/INSTALLATION_GUIDE.md index 1e71e1e..f91a788 100644 --- a/docs/INSTALLATION_GUIDE.md +++ b/docs/INSTALLATION_GUIDE.md @@ -5,10 +5,9 @@ ## Installation Guide - +**Table of Contents** -**Table of Contents** - [Requirements](#requirements) - [Installation](#installation) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 2bc08b6..ff4f029 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -3,10 +3,9 @@ ## User Guide - +**Table of Contents** -**Table of Contents** - [Description](#description) - [Features](#features) @@ -71,8 +70,22 @@ Here is the list of available settings that you could define in the `scripts/set - `fallback_remediation`: Select from `bypass` (minimum remediation), `captcha` or `ban` (maximum remediation). Default to 'captcha'. Handle unknown remediations as. + - `appsec_fallback_remediation`: Select from `bypass` (minimum remediation), `captcha` (recommended) or `ban` (maximum remediation). - Default to 'captcha'. Will be used as remediation in case of AppSec failure (timeout). + Default to 'captcha'. Will be used as remediation in case of AppSec failure (timeout). + + +- `appsec_max_body_size_kb`: Maximum body size in KB to send to AppSec. Default to 1024 KB. + If exceeded, the action defined by the `appsec_body_size_exceeded_action` setting below will be applied. + + +- `appsec_body_size_exceeded_action`: Action to take when the request body size exceeds the maximum size defined by the `appsec_max_body_size_kb` setting above. + + Possible values are: + + - `headers_only` (recommended and default value): only the headers of the original request are forwarded to AppSec, not the body. + - `allow` (not recommended): the request is considered as safe and a bypass remediation is returned, without calling AppSec. + - `block`: the request is considered as malicious and a ban remediation is returned, without calling AppSec. - `trust_ip_forward_array`: If you use a CDN, a reverse proxy or a load balancer, set an array of IPs. For other IPs, the bouncer will not trust the X-Forwarded-For header.