Skip to content

Commit c0b6344

Browse files
committed
docs: add descriptions
Signed-off-by: Felipe Zipitria <[email protected]>
1 parent 1dfcaf0 commit c0b6344

File tree

1 file changed

+20
-23
lines changed

1 file changed

+20
-23
lines changed

README.md

+20-23
Original file line numberDiff line numberDiff line change
@@ -29,42 +29,39 @@ These values control Coraza.
2929

3030
| Variable | Default | Documentation |
3131
| - | - | - |
32-
| CORAZA_ARGUMENTS_LIMIT | Default: `1000` | |
32+
| CORAZA_ARGUMENTS_LIMIT | Default: `1000` | An integer indicating the maximum number of arguments that can be processed before setting the `REQBODY_ERROR` variable |
3333
| CORAZA_AUDIT_ENGINE | Default: `"RelevantOnly"` | |
34-
| CORAZA_AUDIT_LOG | Default: `/dev/stdout` | |
35-
| CORAZA_AUDIT_LOG_FORMAT | Default: `JSON` | |
36-
| CORAZA_AUDIT_LOG_PARTS | Default: `'ABIJDEFHZ'` | |
37-
| CORAZA_AUDIT_LOG_RELEVANT_STATUS | Default: `"^(?:5\|4[0-9][0-35-9])"` | |
34+
| CORAZA_AUDIT_LOG | Default: `/dev/stdout` | A string indicating the path to the main audit log file or the concurrent logging index file |
35+
| CORAZA_AUDIT_LOG_FORMAT | Default: `JSON` | A string indicating the output format of the AuditLogs (Default: `JSON`). Accepted values: `JSON`, `Native`. See [SecAuditLogFormat]() |
36+
| CORAZA_AUDIT_LOG_PARTS | Default: `'ABIJDEFHZ'` | A string that defines which parts of each transaction are going to be recorded in the audit log (Default: `'ABIJDEFHZ'`). See [SecAuditLogParts]() for the accepted values. |
37+
| CORAZA_AUDIT_LOG_RELEVANT_STATUS | Default: `"^(?:5\|4[0-9][0-35-9])"` | A regular expression string that defines the http error codes that are relevant for audit logging (Default: `"^(?:5|4(?!04))"`). See [SecAuditLogRelevantStatus]() |
3838
| CORAZA_AUDIT_LOG_TYPE | Default: `Serial` | |
3939
| CORAZA_AUDIT_STORAGE_DIR | Default: `/var/log/coraza/audit/` | |
4040
| CORAZA_DATA_DIR | Default: `/tmp/coraza/data` | |
4141
| CORAZA_DEBUG_LOG | Default: `/dev/null` | |
42-
| CORAZA_DEFAULT_PHASE1_ACTION | Default: `"phase:1,pass,log,tag:'\${CORAZA_TAG}'"` | |
43-
| CORAZA_DEFAULT_PHASE2_ACTION | Default: `"phase:2,pass,log,tag:'\${CORAZA_TAG}'"` | |
44-
| CORAZA_REQ_BODY_ACCESS | Default: `"On"` | |
42+
| CORAZA_DEFAULT_PHASE1_ACTION | Default: `"phase:1,pass,log,tag:'\${CORAZA_TAG}'"` | String with the contents for the default action in phase 1 |
43+
| CORAZA_DEFAULT_PHASE2_ACTION | Default: `"phase:2,pass,log,tag:'\${CORAZA_TAG}'"` | String with the contents for the default action in phase 2 |
44+
| CORAZA_REQ_BODY_ACCESS | Default: `"On"` | A string value allowing ModSecurity to access request bodies. Allowed values: `On`, `Off`. See [SecRequestBodyAccess]() |
4545
| CORAZA_REQ_BODY_JSON_DEPTH_LIMIT | Default: `1024` | |
46-
| CORAZA_REQ_BODY_LIMIT | Default: `13107200` | |
47-
| CORAZA_REQ_BODY_LIMIT_ACTION | Default: `"Reject"` | |
46+
| CORAZA_REQ_BODY_LIMIT | Default: `13107200` | An integer value indicating the maximum request body size accepted for buffering. See [SecRequestBodyLimit]() |
47+
| CORAZA_REQ_BODY_LIMIT_ACTION | Default: `"Reject"` | A string value for the action when `SecRequestBodyLimit` is reached. Accepted values: `Reject`, `ProcessPartial`. See [SecRequestBodyLimitAction]() |
4848
| CORAZA_REQ_BODY_NOFILES_LIMIT | Default: `524288` | |
49-
| CORAZA_RESP_BODY_ACCESS | Default: `"On"` | |
50-
| CORAZA_RESP_BODY_LIMIT | Default: `1048576` | |
51-
| CORAZA_RESP_BODY_LIMIT_ACTION | Default: `"ProcessPartial"` | |
49+
| CORAZA_RESP_BODY_ACCESS | Default: `"On"` | A string value allowing ModSecurity to access response bodies. Allowed values: `On`, `Off`. See [SecResponseBodyAccess]() |
50+
| CORAZA_RESP_BODY_LIMIT | Default: `1048576` | An integer value indicating the maximum response body size accepted for buffering. |
51+
| CORAZA_RESP_BODY_LIMIT_ACTION | Default: `"ProcessPartial"` | A string value for the action when `SecResponseBodyLimit` is reached. Accepted values: `Reject`, `ProcessPartial`. See [SecResponseBodyLimitAction]() |
5252
| CORAZA_RESP_BODY_MIMETYPE | Default: `"text/plain text/html text/xml"` | |
53-
| CORAZA_RULE_ENGINE | Default: `On` | |
54-
| CORAZA_TAG | Default: `coraza` | |
55-
| CORAZA_TMP_DIR | Default: `/tmp/coraza` | |
56-
| CORAZA_TMP_SAVE_UPLOADED_FILES | Default: `"On"` | |
57-
| CORAZA_UPLOAD_DIR | Default: `/tmp/coraza/upload` | |
58-
| CORAZA_UPLOAD_KEEP_FILES | Default: `Off` | |
53+
| CORAZA_RULE_ENGINE | Default: `On` | A string value enabling Coraza itself. Accepted values: `On`, `Off`, `DetectionOnly`. See [SecRuleEngine]() |
54+
| CORAZA_TAG | Default: `coraza` | A string indicating the default tag action, which will be inherited by the rules in the same configuration context. |
55+
| CORAZA_TMP_DIR | Default: `/tmp/coraza` | A string indicating the path where temporary files will be created |
5956

6057
### CRS Specific
6158

6259
| Variable | Default | Documentation |
6360
| - | - | - |
64-
| PARANOIA | Default: `1` | |
65-
| ANOMALY_INBOUND | Default: `5` | |
66-
| ANOMALY_OUTBOUND | Default: `4` | |
67-
| BLOCKING_PARANOIA | Default: `1` | |
61+
| PARANOIA | Default: `1` | CRS Paranoia Level setting for logging. It could be different from the BLOCKING level, allowing you to log additional information. |
62+
| ANOMALY_INBOUND | Default: `5` | The score used by CRS to block incoming requests. |
63+
| ANOMALY_OUTBOUND | Default: `4` | The score used by CRS to block outgoing requests. |
64+
| BLOCKING_PARANOIA | Default: `1` | CRS Paranoia Level setting used for blocking |
6865

6966
### Caddy Specific
7067

0 commit comments

Comments
 (0)