diff --git a/README.md b/README.md index c001931..f4749ac 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,23 @@ detection works by request counting for designated areas of the page (`[[paths]] - entries can be set to always fail to create "trap paths" (max = 0) - subnets can be blobbed together into one entity, e.g. to catch alibaba's entire /24 subnet of bots +## fail response + +- http mode: signal caddy (or other reverse proxy) to do something special + - e.g. redirect to iocaine or other trap +- file mode: respond with simple http response or html file +- generated mode: + - customizable + - start text + - end text + - char spam in between + - total length can be set + - can be gzipped + - optionally only if client allows it (via Accept-Encoding) + - "gzip chance" from 0 to 100% (of requests) + - "continuous failure" mode where a few links that lead into a maze of more failure + are generated between start text and spam + # config default config is automatically dropped to disk and can also be found at src/bombai.toml