diff options
| author | Xe Iaso <me@xeiaso.net> | 2025-01-24 20:52:10 -0500 |
|---|---|---|
| committer | Xe Iaso <me@xeiaso.net> | 2025-01-24 20:52:10 -0500 |
| commit | cd00641150ebf27dd09a8da99d75b25815030cfd (patch) | |
| tree | a4263444393a21cdba9847709d57eadf2200d37b | |
| parent | 1257d8c10cd1ec5b275a1692e8dcc0cac29fa944 (diff) | |
| download | x-cd00641150ebf27dd09a8da99d75b25815030cfd.tar.xz x-cd00641150ebf27dd09a8da99d75b25815030cfd.zip | |
cmd/anubis: document POLICY_FNAME
Signed-off-by: Xe Iaso <me@xeiaso.net>
| -rw-r--r-- | cmd/anubis/README.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/cmd/anubis/README.md b/cmd/anubis/README.md index 60de1de..8b171a1 100644 --- a/cmd/anubis/README.md +++ b/cmd/anubis/README.md @@ -157,13 +157,14 @@ Anubis has very minimal system requirements. I suspect that 128Mi of ram may be Anubis uses these environment variables for configuration: -| Environment Variable | Default value | Explanation | -| :------------------- | :---------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BIND` | `:8923` | The TCP port that Anubis listens on. | -| `DIFFICULTY` | `5` | The difficulty of the challenge, or the number of leading zeroes that must be in successful responses. | -| `METRICS_BIND` | `:9090` | The TCP port that Anubis serves Prometheus metrics on. | -| `SERVE_ROBOTS_TXT` | `false` | 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. | -| `TARGET` | `http://localhost:3923` | The URL of the service that Anubis should forward valid requests to. | +| Environment Variable | Default value | Explanation | +| :------------------- | :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `BIND` | `:8923` | The TCP port that Anubis listens on. | +| `DIFFICULTY` | `5` | The difficulty of the challenge, or the number of leading zeroes that must be in successful responses. | +| `METRICS_BIND` | `:9090` | The TCP port that Anubis serves Prometheus metrics on. | +| `POLICY_FNAME` | `/data/cfg/botPolicy.json` | The file containing [bot policy configuration](./docs/policies.md). See the bot policy documentation for more details. | +| `SERVE_ROBOTS_TXT` | `false` | 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. | +| `TARGET` | `http://localhost:3923` | The URL of the service that Anubis should forward valid requests to. | ### Policies |