From 15d801be7de4cd9eea91bcec177b30d1bc15310b Mon Sep 17 00:00:00 2001 From: "Christian F. Coors" Date: Sat, 22 Mar 2025 11:45:32 +0000 Subject: [PATCH] fix: installation instructions and example (#75) --- docs/docs/CHANGELOG.md | 2 ++ docs/docs/admin/installation.mdx | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md index 8c59f7d..95b82e5 100644 --- a/docs/docs/CHANGELOG.md +++ b/docs/docs/CHANGELOG.md @@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +- Fixed and clarified installation instructions + ## v1.14.2 Livia sas Junius: Echo 2 diff --git a/docs/docs/admin/installation.mdx b/docs/docs/admin/installation.mdx index bd81b74..f716a84 100644 --- a/docs/docs/admin/installation.mdx +++ b/docs/docs/admin/installation.mdx @@ -29,7 +29,7 @@ Anubis uses these environment variables for configuration: | `METRICS_BIND` | `:9090` | The network address that Anubis serves Prometheus metrics on. See `BIND` for more information. | | `METRICS_BIND_NETWORK` | `tcp` | The address family that the Anubis metrics server listens on. See `BIND_NETWORK` for more information. | | `SOCKET_MODE` | `0770` | *Only used when at least one of the `*_BIND_NETWORK` variables are set to `unix`.* The socket mode (permissions) for Unix domain sockets. | -| `POLICY_FNAME` | `/data/cfg/botPolicy.json` | The file containing [bot policy configuration](./policies.md). See the bot policy documentation for more details. | +| `POLICY_FNAME` | unset | The file containing [bot policy configuration](./policies.md). See the bot policy documentation for more details. If unset, the default bot policy configuration is used. | | `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. Supports Unix domain sockets, set this to a URI like so: `unix:///path/to/socket.sock`. | @@ -47,13 +47,15 @@ services: METRICS_BIND: ":9090" SERVE_ROBOTS_TXT: "true" TARGET: "http://nginx" + POLICY_FNAME: "/data/cfg/botPolicy.json" ports: - 8080:8080 + volumes: + - "./botPolicy.json:/data/cfg/botPolicy.json:ro" nginx: image: nginx volumes: - "./www:/usr/share/nginx/html" - - "./botPolicy.json:/data/cfg/botPolicy.json" ``` ## Kubernetes