Anubis
Docker 应用程序 from grtgbln's Repository
概述
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.
See configuration instructions: https://anubis.techaro.lol/docs/admin/installation/#configuration
要求
Expects a `botPolicy.yaml` file to be mounted at `/mnt/user/appdata/anubis/botPolicy.yaml` before starting the container. See configuration details: https://anubis.techaro.lol/docs/admin/installation/#configuration
运行时参数
- 网络用户界面
http://[IP]:[PORT:8923]/- 网络
bridge- 特权
- false
模板配置
Container Port: 8923
- 目标
- 8923
- 默认值
- 8923
- 价值
- 8923
Container Port: 9090
- 目标
- 9090
- 默认值
- 9090
- 价值
- 9090
The URL of the service that Anubis should forward valid requests to. Supports Unix domain sockets, set this to a URI like so: unix:///path/to/socket.sock.
- 目标
- TARGET
- 默认值
- http://localhost:3923
- 价值
- http://localhost:3923
Path to the bot policy file.
- 目标
- /data/cfg/botPolicy.yaml
- 默认值
- /mnt/user/appdata/anubis/botPolicy.yaml
- 价值
- /mnt/user/appdata/anubis/botPolicy.yaml
If set, adds a global prefix to all Anubis endpoints. For example, setting this to /myapp would make Anubis accessible at /myapp/ instead of /. This is useful when running Anubis behind a reverse proxy that routes based on path prefixes.
- 目标
- BASE_PREFIX
Internal bind port to the host system
- 目标
- BIND
- 默认值
- :8923
- 价值
- :8923
The address family that Anubis listens on
- 目标
- BIND_NETWORK
- 默认值
- tcp
- 价值
- tcp
The domain the Anubis challenge pass cookie should be set to. This should be set to the domain you bought from your registrar (EG: techaro.lol if your webapp is running on anubis.techaro.lol)
- 目标
- COOKIE_DOMAIN
If set to true, automatically set cookie domain fields based on the hostname of the request. EG: if you are making a request to anubis.techaro.lol, the Anubis cookie will be valid for any subdomain of techaro.lol.
- 目标
- COOKIE_DYNAMIC_DOMAIN
- 默认值
- false|true
The amount of time the authorization cookie is valid for.
- 目标
- COOKIE_EXPIRATION_TIME
- 默认值
- 168h
- 价值
- 168h
If set to true, enables the partitioned (CHIPS) flag, meaning that Anubis inside an iframe has a different set of cookies than the domain hosting the iframe.
- 目标
- COOKIE_PARTITIONED
- 默认值
- false|true
If set to true, enables the Secure flag, meaning that the cookies will only be transmitted over HTTPS. If Anubis is used in an unsecure context (plain HTTP), this will be need to be set to false.
- 目标
- COOKIE_SECURE
- 默认值
- true|false
The difficulty of the challenge, or the number of leading zeroes that must be in successful responses.
- 目标
- DIFFICULTY
- 默认值
- 4
- 价值
- 4
The hex-encoded ed25519 private key used to sign Anubis responses. If this is not set, Anubis will generate one for you. This should be exactly 64 characters long. When running multiple instances on the same base domain, the key must be the same across all instances.
- 目标
- ED25519_PRIVATE_KEY_HEX
Internal path to a file containing the hex-encoded ed25519 private key. Only one of this or its sister option may be set.
- 目标
- ED25519_PRIVATE_KEY_HEX_FILE
Internal bind network address that Anubis serves Prometheus metrics on.
- 目标
- METRICS_BIND
- 默认值
- :9090
- 价值
- :9090
The address family that the Anubis metrics server listens on.
- 目标
- METRICS_BIND_NETWORK
- 默认值
- tcp
- 价值
- tcp
The expiration time for the Open Graph tag cache. Prefer using the policy file to configure the Open Graph subsystem.
- 目标
- OG_EXPIRY_TIME
- 默认值
- 24h
- 价值
- 24h
If set to true, Anubis will enable Open Graph tag passthrough. Prefer using the policy file to configure the Open Graph subsystem.
- 目标
- OG_PASSTHROUGH
- 默认值
- false|true
If set to true, Anubis will consider the host in the Open Graph tag cache key. Prefer using the policy file to configure the Open Graph subsystem.
- 目标
- OG_CACHE_CONSIDER_HOST
- 默认值
- false|true
The internal file name containing bot policy configuration. See the bot policy documentation for more details. If unset, the default bot policy configuration is used.
- 目标
- POLICY_FNAME
If set, restrict the domains that Anubis can redirect to when passing a challenge. If unset, Anubis may redirect to any domain which could cause security issues in the unlikely case that an attacker passes a challenge for your browser and then tricks you into clicking a link to your domain. Note, if you are hosting Anubis on a non-standard port, you must also include the port number here.
- 目标
- REDIRECT_DOMAINS
If set true, Anubis will serve a default robots.txt file that disallows all known AI scrapers by name and then additionally disallows every scraper. This is useful if facts and circumstances make it difficult to change the underlying service to serve such a robots.txt file.
- 目标
- SERVE_ROBOTS_TXT
- 默认值
- false|true
If set to true, strips the base prefix from request paths when forwarding to the target server. This is useful when your target service expects to receive requests without the base prefix. For example, with BASE_PREFIX=/foo and STRIP_BASE_PREFIX=true, a request to /foo/bar would be forwarded to the target as /bar.
- 目标
- STRIP_BASE_PREFIX
- 默认值
- false|true
If set to true, Anubis will take the client's IP from the network socket. For production deployments, it is expected that a reverse proxy is used in front of Anubis, which pass the IP using headers, instead.
- 目标
- USE_REMOTE_ADDRESS
If set, shows a contact email address when rendering error pages. This email address will be how users can get in contact with administrators.
- 目标
- WEBMASTER_EMAIL
If set, strip private addresses from X-Forwarded-For headers.
- 目标
- XFF_STRIP_PRIVATE
- 默认值
- true|false
Only used when at least one of the *_BIND_NETWORK variables are set to unix. The socket mode (permissions) for Unix domain sockets.
- 目标
- SOCKET_MODE
详细信息
ghcr.io/techarohq/anubis:latest在Unraid 上运行 Anubis 。
Anubis 已被列入Unraid OS 的社区应用程序。探索Unraid ,构建灵活的家庭服务器、NAS 或家庭实验室。