Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lissy93/adguardian-term/llms.txt

Use this file to discover all available pages before exploring further.

AdGuardian Term can be installed in six ways. Docker is the quickest path if you already have Docker — no Rust toolchain needed and the image is only 12 MB. Pre-built binaries are the best choice for machines without Docker or Rust, since the executable has zero runtime dependencies. Cargo (cargo install adguardian) is ideal if you already have the Rust toolchain. Scoop covers Windows users who prefer a package manager. The AUR package targets Arch Linux. Finally, the one-liner quick-start script auto-detects your OS and architecture, downloads the right binary, and launches it — perfect for a fast first run on any Unix-like system.
Not sure which method to choose?
  • Docker is the easiest but requires the Docker daemon and adds a small layer of overhead (the image is 12 MB).
  • Pre-built binary has no dependencies at all — download, chmod +x, and run.
  • Cargo is straightforward if you already have Rust installed, and keeps the binary in your ~/.cargo/bin PATH automatically.
  • Build from source is required if your system architecture isn’t listed below, or if you want to run a fork or apply local modifications.

Installation Methods

Pull and run the latest image from Docker Hub with a single command:
docker run -it lissy93/adguardian
If you encounter issues with Docker Hub, or prefer a different registry, the same image is published to the GitHub Container Registry:
docker run -it ghcr.io/lissy93/adguardian
To build the image yourself from source (for example, to apply local changes or pin a specific commit):
docker buildx build -t adguardian .
docker run -it adguardian
To pass your AdGuard Home credentials at runtime, use -e flags — see the Quickstart for a full example with all environment variables.

Build docs developers (and LLMs) love