Skip to content

Commit f998cb0

Browse files
docs(User Guide): Mention appsec max body size settings
1 parent 36eb37d commit f998cb0

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

docs/DEVELOPER.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33

44
## Developer guide
55

6-
6+
**Table of Contents**
77
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
88
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
9-
**Table of Contents**
109

1110
- [Local development](#local-development)
1211
- [DDEV setup](#ddev-setup)

docs/INSTALLATION_GUIDE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@
55

66
## Installation Guide
77

8-
8+
**Table of Contents**
99
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1010
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
11-
**Table of Contents**
1211

1312
- [Requirements](#requirements)
1413
- [Installation](#installation)

docs/USER_GUIDE.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33

44
## User Guide
55

6-
6+
**Table of Contents**
77
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
88
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
9-
**Table of Contents**
109

1110
- [Description](#description)
1211
- [Features](#features)
@@ -71,8 +70,22 @@ Here is the list of available settings that you could define in the `scripts/set
7170

7271
- `fallback_remediation`: Select from `bypass` (minimum remediation), `captcha` or `ban` (maximum remediation). Default to 'captcha'. Handle unknown remediations as.
7372

73+
7474
- `appsec_fallback_remediation`: Select from `bypass` (minimum remediation), `captcha` (recommended) or `ban` (maximum remediation).
75-
Default to 'captcha'. Will be used as remediation in case of AppSec failure (timeout).
75+
Default to 'captcha'. Will be used as remediation in case of AppSec failure (timeout).
76+
77+
78+
- `appsec_max_body_size_kb`: Maximum body size in KB to send to AppSec. Default to 1024 KB.
79+
If exceeded, the action defined by the `appsec_body_size_exceeded_action` setting below will be applied.
80+
81+
82+
- `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.
83+
84+
Possible values are:
85+
86+
- `headers_only` (recommended and default value): only the headers of the original request are forwarded to AppSec, not the body.
87+
- `allow` (not recommended): the request is considered as safe and a bypass remediation is returned, without calling AppSec.
88+
- `block`: the request is considered as malicious and a ban remediation is returned, without calling AppSec.
7689

7790

7891
- `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.

0 commit comments

Comments
 (0)