README.md

lazydns Documentation

Welcome to the lazydns documentation. This docs/ folder contains guides, references, and examples to help you use, operate, and develop for lazydns.

Start with the Quickstart to run lazydns locally, or browse the sidebar/SUMMARY to explore the docs.

---

Quick Navigation

Use the site sidebar (en/SUMMARY.md) or the quick links below to jump to common pages:

• Introduction
• Quickstart
• Installation & Updates
• Configuration (Core)
  • Server Settings
    • UDP/TCP Listener
    • DNS over TLS (DoT) Listener
    • DNS over HTTPS (DoH) Listener
    • DNS over QUIC (DoQ) Listener
  • Logging
• Plugins Guide (User)
  • Forward
  • Cache
  • ACL
  • Cron
  • Domain Validator
  • DataSet Plugins
    • Hosts
    • Domain Set
    • Ip Set
    • GeoIP & GeoSite
    • Arbitrary
  • Executable Plugins
    • Sequence
    • Black Hole
    • Collector
    • Debug Print
    • Downloader
    • Drop Resp
    • Dual Selector
    • ECS
    • EDNS0 Options
    • Fallback
    • IpSet (exec)
    • Mark
    • NftSet
    • Query Summary
    • Rate Limit
    • Redirect
    • Reverse Lookup
    • RouterOS AddrList
    • Sleep
    • TTL
  • Flow Control Plugins
    • Goto
    • Jump
    • Accept
    • Reject
    • Return
    • Prefer_IPv4
    • Prefer_IPv6
• Writing Plugins (Developer)
• Datasets & Formats
• Changelog

Notes for developers / maintainers

These files live at the docs/ root (non-recursive) and cover targeted topics useful for maintainers and operators:

• CACHE_CONFIG_GUIDE — Deep-dive guide for cache tuning and options.
• ENV_OVERRIDE — How to override configuration via environment variables.
• IMPLEMENTATION — Design notes and implementation details.
• IP_MATCHING_RULES — IP/CIDR matching rules and examples.
• DOMAIN_MATCHING_RULES — Domain matching and suffix rules.
• PLUGINS_AUDIT_PLUGINS — Guidance for auditing and reviewing plugins.
• PLUGIN_DOWNLOADER — How the plugin downloader works and how to use it.
• UPSTREAM_FEATURES — List of upstream (mosdns) features and differences.
• BREAKING_CHANGE_REQUESTCONTEXT — Migration notes for RequestContext breaking changes.