Skip to content

Commit

Permalink
doc: update new defaults
Browse files Browse the repository at this point in the history
  • Loading branch information
troyxmccall committed Feb 25, 2024
1 parent 2c2cc6a commit 5bc9fd4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ time.
*NEW*: Caching modsecurity responses helps to minimize the overhead of processing every request and improves
performance. By generating cache keys based on various factors like the request method, host, request URI, headers, and
remote address, we can ensure that different requests are treated uniquely, while similar requests can be served from
the plugins cache. This approach helps in reducing the load on the modsecurity instance and improves response times for
the plugins modsecurity response cache. This approach helps in reducing the load on the modsecurity instance and improves response times for
requests. You can tune this to your liking but we recommend the following options:

## Configuration
Expand All @@ -75,11 +75,11 @@ This plugin supports these configuration:

* `cacheKeyIncludeHost`: (optional) Specifies if the host should be included in the cache key. (default true)
* `cacheKeyIncludeRemoteAddress`: (optional) Speifics if the remote request address should be included in the cache
key (default false)
* `cacheKeyIncludeHeaders`: (optional) Specifies if the headers should be included in the cache key. (default false)
* `cacheKeyHeaders`: (optional) An array of specific headers to be included in the cache key when CacheKeyIncludeHeaders is true. (ie: ["User-Agent"])
key (default true)
* `cacheKeyIncludeHeaders`: (optional) Specifies if the headers should be included in the cache key. (default true)
* `cacheKeyHeaders`: (optional) An array of specific headers to be included in the cache key when CacheKeyIncludeHeaders is true. (ie: the default ["User-Agent"])

note some headers are ALWAYS blacklisted, and even if you list
**Note**: some headers are ALWAYS blacklisted, and even if you list
them here, they will still not be cached:
```
Authorization: *, Set-Cookie: *, Cache-Control: no-store, Pragma: no-cache, Expires: -1 (date in the past)
Expand Down

0 comments on commit 5bc9fd4

Please sign in to comment.