nxdns/docs/README.md

nxdns documentation

New to nxdns? Start with Get started. It runs nxdns from a scratch directory and blocks a real ad domain, and you can delete everything afterwards.

Tutorial

• Get started — download nxdns, resolve a name, add a blocklist and watch it block, then clean up.

How-to guides

• Verify a release — check the signature and checksums before you run anything.
• Install with systemd — a system service on Linux, including a Raspberry Pi.
• Install with Docker — the published image with Docker Compose.
• Install with Nix — the flake and its services.nxdns NixOS module.
• Upgrade — move to a new release, and back if you must.
• Enable DoH and DoT — serve encrypted DNS to your devices.
• Set up admin authentication — put a password on the web interface.
• Back up and restore — export the configuration and load it back.

Reference

• Configuration — every setting and list, with defaults and allowed values.
• Command line — every command, flag and exit code.
• Files and directories — what nxdns keeps where, and the query history database.

Explanation

• The configuration model — database mode and file mode, and which to choose.