Knot Resolver

Welcome to Knot Resolver’s documentation! Knot Resolver is an open-source implementation of a caching validating DNS resolver. Modular architecture keeps the core tiny and efficient, and it also provides a state-machine like API for extensions.

If you are a completely new user or new to version 6, please start with chapters for getting started and upgrading guide.

Getting Started

• Installation
• Startup
• Configuration

Configuration

• Configuration Overview
  • Validation
  • JSON Schema
    • Getting the JSON Schema
    • Interactive visualization
• Networking and protocols
  • Server (communication with clients)
    • Addresses and services
    • DoT and DoH (encrypted DNS)
  • Client (retrieving answers from servers)
    • IPv4 and IPv6 usage
    • Forwarding
  • DNS protocol tweaks
    • DNS protocol tweaks
• Performance and resiliency
  • Cache
    • Sizing
    • Persistence
    • Configuration reference
  • Multiple workers
  • Prefetching records
    • Expiring records
    • Prediction
    • Configuration
    • Exported metrics
  • Cache prefilling
    • Dependencies
  • Serve stale
    • Running
  • Root on loopback (RFC 7706)
  • Priming
  • EDNS keepalive
• Policy, access control, data manipulation
  • Views and ACLs
    • Conditions
    • Actions
  • Local Data and RPZ
  • Forwarding
  • DNS64
    • Advanced options
  • IP address renumbering
    • Example configuration
  • Answer reordering
  • Rebinding protection
  • Refuse queries without RD bit
  • Tags
• Logging, monitoring, diagnostics
  • DNSSEC validation failure logging
  • Statistics collector
    • Prometheus metrics endpoint
    • Graphite/InfluxDB/Metronome
  • Name Server Identifier (NSID)
  • Dnstap (traffic collection)
  • Sentinel for Detecting Trusted Root Keys
  • Signaling Trust Anchor Knowledge in DNSSEC
  • System time skew detector
  • Detect discontinuous jumps in the system time
  • Debugging options
• DNSSEC, data verification
• Lua Scripting
• Experimental features
  • Experimental DNS-over-TLS Auto-discovery
    • How it works
    • Generating NS target names
    • Caveats
    • Dependencies

Deployment

• Systemd
• Manual
• Docker
• Advanced

Management

• HTTP API
• kresctl utility

For operators

• Upgrading to version 6.x
• Upgrading
• Release notes

For developers

• Manager’s development guide
  • Development environment
  • Code structure
  • Packaging
  • Testing
• Internal Lua configuration
  • Syntax
  • Documentation Conventions
  • Modules
  • Networking and protocols
  • Performance and resiliency
  • Policy, access control, data manipulation
  • Logging, monitoring, diagnostics
  • DNSSEC, data verification
  • Experimental features
• System architecture
  • Knot Resolver startup
  • Failure handling
  • Individual components
• Building from sources
  • Building with apkg
  • Building with Meson
  • Tests
  • Documentation
  • Tarball
  • Packaging
  • Docker image
• Knot Resolver library
  • Requirements
  • For users
  • For developers
  • Writing layers
  • APIs in Lua
  • API reference
• Modules API reference
  • Supported languages
  • The anatomy of an extension
  • Writing a module in Lua
  • Writing a module in C
  • Configuring modules
  • Exposing C module properties
• Worker API reference
• Custom HTTP services
  • Custom RESTful services

Indices and tables

• Index

• Module Index

• Search Page