Skip to content
Projects

network-plane/dnsplane has 60 GitHub stars and 2 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-18 02:12 UTC. Last push 2026-11-14.

How these counts are measured

What you can do

  • Adblock: Load lists from file or URL; merge multiple sources; optional adblock_list_files in config.
  • Full stats: Optional persistent stats DB and TUI statistics commands (full_stats, full_stats_dir).
  • Split DNS: Per-upstream domain_whitelist in dnsservers.json / TUI.
  • Records from URL or Git: Read-only remote sources with a refresh interval.

Measured star growth

in 24h
0
in 7 days
Collecting history
in 15 days
Collecting history
in 1 month
Collecting history

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

DNS Server for labs and home

Developer Tools

README.md

Original

dnsplane

dnsplane

A DNS server with a TUI and REST API. For common record types (A, AAAA, MX, …) answers come from local records, then cache (if enabled), then upstreams queried in parallel; the first successful upstream wins. PTR uses local data (including PTR synthesized from A) first, then the same path on miss.

Documentation

Doc What it covers
docs/resolution.md Resolution behavior: local/cache/upstream order, adblock and whitelist interaction, cache warm/compaction, mermaid flow diagram.
docs/usage.md Server and client commands, flags, config/data paths, TUI overview, demo.
docs/config-files.md JSON files (dnsrecords, dnsservers, cache, dnsplane.json), records source (file/URL/Git), domain whitelist, adblock, main config tables, REST API, curl (upstream health).
docs/logging.md Log directory, severity, rotation; client --log-file.
docs/systemd.md systemd: manual unit (/usr/local/...) vs package unit (/usr/bin/dnsplane).
packaging/README.md RPM / Debian builds, version.sh (BASE-SHORTSHA), local rpmbuild / dpkg-buildpackage.
docs/host-tuning.md Optional Linux OS / host tuning for DNS latency (buffers, limits, containers).
docs/upstream-health.md Upstream health checks: probes, marking servers down, config, logs, curl.
docs/clustering.md Multi-node record sync: TCP peers, cluster_* keys, auth, deployment notes.
docs/zone-files.md BIND zone files as records_source (bind_dir), reload, optional AXFR.
docs/ispconfig.md ISPConfig: typical zone paths, reload workflow with dnsplane.
docs/cpanel.md cPanel / WHM: /var/named, reload, high-level deployment notes.
docs/security-public-dns.md DoT / DoH / DNSSEC when exposing DNS to the internet.
docs/dnsplane.example.json Full annotated example dnsplane.json.
examples/dnsplane-example.json Short starter config (DoT/DoH/DNSSEC present, off by default).
examples/dnsservers-example.json Example dnsservers.json with domain_whitelist.
examples/curl-stats-dashboard.sh curl examples for dashboard endpoints.
examples/README.md Index of example files vs docs/dnsplane.example.json.
TODO.md Upcoming work.

DoT, DoH, and DNSSEC are also summarized in the main config tables in config-files.md.

Features (summary)

  • Adblock: Load lists from file or URL; merge multiple sources; optional adblock_list_files in config.
  • Full stats: Optional persistent stats DB and TUI statistics commands (full_stats, full_stats_dir).
  • Split DNS: Per-upstream domain_whitelist in dnsservers.json / TUI.
  • Records from URL or Git: Read-only remote sources with a refresh interval.
  • TUI server control: server config / set / save, and start/stop for DNS, API, and client listeners.

Recent releases add graceful shutdown timeouts for systemd, statistics in the TUI when full_stats is enabled, and build metadata (version, Go, OS, arch) on stats and health endpoints.

Dependencies & Documentation

Known Vulnerabilities Maintainability

OpenSSF Best Practices OpenSSF Scorecard OpenSSF Baseline

Go CI govulncheck OSV-Scanner ClusterFuzzLite

Go Mod Go Reference Dependencies

SBOM

Contributing

Contributions are welcome. Please follow the Google Go Style Guide. Commits use the Developer Certificate of Origin (DCO)—see CONTRIBUTING.md for sign-off. Roles and decisions are described in GOVERNANCE.md.

Commit Activity

GitHub last commit GitHub commits since latest release GitHub Issues or Pull Requests

Authors

License

Licensed under GPL-2.0-only.

License