Add readme and license

This commit is contained in:
Yulian Kuncheff 2025-03-25 23:24:54 +01:00
parent a68ec6b9cf
commit 6ea2c5c945
No known key found for this signature in database
2 changed files with 47 additions and 0 deletions

15
LICENSE Normal file
View file

@ -0,0 +1,15 @@
ISC License
Copyright (c) 2025 Yulian Kuncheff
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.

32
README.md Normal file
View file

@ -0,0 +1,32 @@
# caddy-anubis
caddy-anubis is a plugin that loads anubis for requests in order to slow down AI and Scraper traffic from destroying infrastucture.
I consider this current implementation more of a Proof-of-Concept. I am not sure how stable or well it works. This is my first Caddy plugin.
One major issue is the very first request after a Caddy start or restart, takes like 5 seconds till anubis kicks in. All subsequent requests, especially after clearing cookies, are near instant.
## Current usage
Just add an `anubis` to your caddyfile in the block you want the protection. currently I have not seen it work properly inside a `route` or `handler` block. But it works outside of those.
There is an optional `target` field you can set if you want to force the redirect elsewhere. It does a 302 redirect.
Example (also check the caddyfile in this repo, it is used for testing):
```caddy
:80 {
anubis
# or
anubis {
target https://qwant.com
}
}
```
## Credits
- [anubis](github.com/TecharoHQ/anubis) - the project that started all of this.