anubis

README

Anubis

Sponsors

Anubis is brought to you by sponsors and donors like:

Overview

Anubis weighs the soul of your connection using a proof-of-work challenge in order to protect upstream resources from scraper bots.

This program is designed to help protect the small internet from the endless storm of requests that flood in from AI companies. Anubis is as lightweight as possible to ensure that everyone can afford to protect the communities closest to them.

Anubis is a bit of a nuclear response. This will result in your website being blocked from smaller scrapers and may inhibit "good bots" like the Internet Archive. You can configure bot policy definitions to explicitly allowlist them and we are working on a curated set of "known good" bots to allow for a compromise between discoverability and uptime.

In most cases, you should not need this and can probably get by using Cloudflare to protect a given origin. However, for circumstances where you can't or won't use Cloudflare, Anubis is there for you.

If you want to try this out, connect to anubis.techaro.lol.

Support

If you run into any issues running Anubis, please open an issue. Please include all the information I would need to diagnose your issue.

For live chat, please join the Patreon and ask in the Patron discord in the channel #anubis.

Star History

Packaging Status

Contributors

Made with contrib.rocks.

Documentation

Overview

Package anubis contains the version number of Anubis.

Index

• Constants
• Variables

Constants

const APIPrefix = "/.within.website/x/cmd/anubis/api/"

APIPrefix is the location where all Anubis API endpoints are located.

const CookieDefaultExpirationTime = 7 * 24 * time.Hour

CookieDefaultExpirationTime is the amount of time before the cookie/JWT expires.

const CookieName = "techaro.lol-anubis-auth"

CookieName is the name of the cookie that Anubis uses in order to validate access.

const DefaultDifficulty = 4

DefaultDifficulty is the default "difficulty" (number of leading zeroes) that must be met by the client in order to pass the challenge.

const StaticPath = "/.within.website/x/cmd/anubis/"

StaticPath is the location where all static Anubis assets are located.

const TestCookieName = "techaro.lol-anubis-cookie-test-if-you-block-this-anubis-wont-work"

const WithDomainCookieName = "techaro.lol-anubis-auth-for-"

WithDomainCookieName is the name that is prepended to the per-domain cookie used when COOKIE_DOMAIN is set.

Variables

var BasePrefix = ""

BasePrefix is a global prefix for all Anubis endpoints. Can be emptied to remove the prefix entirely.

var Version = "devel"

Version is the current version of Anubis.

This variable is set at build time using the -X linker flag. If not set, it defaults to "devel".