Warning

This documentation is intended to help with advanced fine-tuning and development of Knot Resolver! If you are looking for help with day-to-day use without the need to involve yourself with C and/or Lua programming languages, please see the user documentation.

Knot Resolver developer documentation

Welcome to Knot Resolver’s documentation for developers and advanced users!

Building from sources

• Cloning the repository
• Building with apkg
• Building with Meson
• Testing infrastructure
• Installing the manager from source
• Docker image
• Manager development environment

Architecture

• System architecture
• Manager code structure
• Layered protocols

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
• Custom HTTP services

C API

• Knot Resolver library
• Modules API reference
• Worker API reference
• Logging API reference

Infrastructure

• Documentation in GitLab Pages

Indices and tables

• Index

• Module Index

• Search Page