diff --git a/README.md b/README.md index 2920a8c..93c2a7c 100644 --- a/README.md +++ b/README.md @@ -82,10 +82,11 @@ This is an HTTP handler module, so it can be used wherever `http.handlers` modul "window": "", "max_events": 0 }, - "storage": {}, "jitter": 0.0, "sweep_interval": "" - } + }, + "log_key": false, + "storage": {}, "distributed": { "write_interval": "", "read_interval": "", @@ -99,6 +100,8 @@ All fields are optional, but to be useful, you'll need to define at least one zo To enable distributed RL, set `distributed` to a non-null object. The default read and write intervals are 5s, but you should tune these for your individual deployments. +To log the key when a rate limit is hit, set `log_key` to `true`. + Storage customizes the storage module that is used. Like normal Caddy convention, all instances with the same storage configuration are considered to be part of a cluster. Jitter is an optional percentage that adds random variance to the Retry-After time to avoid stampeding herds. @@ -133,6 +136,7 @@ rate_limit { write_interval purge_age } + log_key storage jitter sweep_interval