Skip to main content

A lightweight, JSON-configurable DNS server for internal networks

Project description

NanoDNS

A lightweight, zero-dependency DNS server for internal networks — configured with a single JSON file.

Features

  • 🚀 Zero dependencies — pure Python standard library only
  • 📝 JSON config — human-readable, hot-reloadable configuration
  • 🔄 Upstream forwarding — forwards unknown queries to public DNS
  • 💾 LRU Cache — configurable in-memory response cache
  • 🌐 Record types — A, AAAA, CNAME, MX, TXT, PTR, NS, SOA
  • 🃏 Wildcard records*.example.internal support
  • 🚫 Rewrites / blocking — NXDOMAIN any domain
  • ♻️ Hot reload — config changes applied without restart
  • Async — built on Python asyncio

Installation

pip install nanodns-server

Quick Start

# 1. Generate an example config
nanodns init

# 2. Edit nanodns.json to your needs

# 3. Start the server (port 53 needs root, or use port 5353)
sudo nanodns start --config nanodns.json

# Or on a high port for testing:
nanodns start --config nanodns.json --port 5353

Configuration

{
  "server": {
    "host": "0.0.0.0",          // Listen address
    "port": 53,                  // Listen port
    "upstream": ["8.8.8.8", "1.1.1.1"],  // Fallback DNS servers
    "upstream_timeout": 3,       // Seconds before trying next upstream
    "upstream_port": 53,
    "cache_enabled": true,
    "cache_ttl": 300,            // Max TTL to cache (seconds)
    "cache_size": 1000,          // Max cached entries
    "log_level": "INFO",         // DEBUG | INFO | WARNING | ERROR
    "log_queries": true,         // Log every query
    "hot_reload": true           // Watch config file for changes
  },

  "zones": {
    "internal.lan": {
      "soa": {
        "mname": "ns1.internal.lan",
        "rname": "admin.internal.lan",
        "serial": 2024010101,
        "refresh": 3600,
        "retry": 900,
        "expire": 604800,
        "minimum": 300
      },
      "ns": ["ns1.internal.lan"]
    }
  },

  "records": [
    { "name": "web.internal.lan",  "type": "A",     "value": "192.168.1.100", "ttl": 300 },
    { "name": "db.internal.lan",   "type": "A",     "value": "192.168.1.101", "ttl": 300 },
    { "name": "api.internal.lan",  "type": "CNAME", "value": "web.internal.lan" },
    { "name": "internal.lan",      "type": "MX",    "value": "mail.internal.lan", "priority": 10 },
    { "name": "internal.lan",      "type": "TXT",   "value": "v=spf1 ip4:192.168.1.0/24 ~all" },
    { "name": "ipv6.internal.lan", "type": "AAAA",  "value": "fd00::1" },
    {
      "name": "app.internal.lan",
      "type": "A",
      "value": "192.168.1.200",
      "wildcard": true,
      "comment": "Matches *.app.internal.lan"
    }
  ],

  "rewrites": [
    { "match": "ads.doubleclick.net", "action": "nxdomain" },
    { "match": "*.tracker.example",   "action": "nxdomain" }
  ]
}

CLI Reference

nanodns start [--config FILE] [--host HOST] [--port PORT] [--log-level LEVEL] [--no-cache]
nanodns init  [OUTPUT]        # Generate example config
nanodns check CONFIG          # Validate a config file
nanodns --version

Record Types

Type value field Extra fields
A IPv4 address
AAAA IPv6 address
CNAME Target hostname
MX Mail server hostname priority (int)
TXT Text string
PTR Pointer hostname
NS Nameserver hostname

All records support: ttl (default 300), wildcard (bool), comment (string).

Running as a Service (systemd)

# /etc/systemd/system/nanodns.service
[Unit]
Description=NanoDNS Server
After=network.target

[Service]
ExecStart=/usr/local/bin/nanodns start --config /etc/nanodns/nanodns.json
Restart=on-failure
User=root

[Install]
WantedBy=multi-user.target
sudo systemctl enable --now nanodns

High Port (No Root Required)

nanodns start --config nanodns.json --port 5353

Then configure clients to use <server-ip>:5353, or use iptables to redirect:

sudo iptables -t nat -A PREROUTING -p udp --dport 53 -j REDIRECT --to-port 5353

Testing

# Query your local server
dig @127.0.0.1 -p 5353 web.internal.lan A

# With nslookup
nslookup web.internal.lan 127.0.0.1

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nanodns-0.1.1.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nanodns-0.1.1-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file nanodns-0.1.1.tar.gz.

File metadata

  • Download URL: nanodns-0.1.1.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for nanodns-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3859c6f71d06ace293e501ca066133ef2fb80b0f9132445dc36e475b9abc963c
MD5 aa06b6257d01bdc954c5ff1b7564b7f6
BLAKE2b-256 110493e9b91b93f0f0898bb3ebf078278294736e37a46840b2cf97bf2f1a35be

See more details on using hashes here.

File details

Details for the file nanodns-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nanodns-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for nanodns-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 01fb15f69af06e2b8d9b053fa932d1a951761a5fe2075056fffdb6dc320fd194
MD5 2f65c0e34fc384e6547e4195bf28bfcf
BLAKE2b-256 47472e7398a946e1e7bdb0d2ff6b7b026e11f92d525eb82e8d4270ca1917eb34

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page