README.md 4.15 KB
Newer Older
1 2
# Knot DNS Resolver

3 4
[![Build Status](https://gitlab.labs.nic.cz/knot/knot-resolver/badges/master/pipeline.svg?x)](https://gitlab.labs.nic.cz/knot/knot-resolver/commits/master)
[![Coverage Status](https://gitlab.labs.nic.cz/knot/knot-resolver/badges/master/coverage.svg?x)](https://knot.pages.labs.nic.cz/knot-resolver/)
Marek Vavruša's avatar
Marek Vavruša committed
5
[![Coverity](https://img.shields.io/coverity/scan/3912.svg)](https://scan.coverity.com/projects/3912)
Marek Vavruša's avatar
Marek Vavruša committed
6
[![Documentation Status](https://readthedocs.org/projects/knot-resolver/badge/?version=latest)](https://readthedocs.org/projects/knot-resolver/?badge=latest)
7
[![Join the chat at gitter.im/CZ-NIC/knot-resolver](https://badges.gitter.im/Join%20Chat.svg?x)](https://gitter.im/CZ-NIC/knot-resolver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
8

9

Vladimír Čunát's avatar
Vladimír Čunát committed
10 11
Knot DNS Resolver is a caching full resolver implementation written in C and [LuaJIT][luajit], both a resolver library and a daemon. The core architecture is tiny and efficient, and provides a foundation and
a state-machine like API for extensions. There are four of those built-in - *iterator*, *validator* and two caching modules. Most of the [rich features](https://knot-resolver.readthedocs.io/en/latest/modules.html) are written in Lua(JIT) and C. Batteries are included, but optional.
Marek Vavruša's avatar
Marek Vavruša committed
12

Vladimír Čunát's avatar
Vladimír Čunát committed
13
The LuaJIT modules, support DNS privacy and DNSSEC, and persistent cache with low memory footprint make it a great personal DNS resolver or a research tool to tap into DNS data. TL;DR it's the [OpenResty][openresty] of DNS.
Marek Vavruša's avatar
Marek Vavruša committed
14

Vladimír Čunát's avatar
Vladimír Čunát committed
15
Several cache backends (LMDB, Redis and Memcached), strong filtering rules, and auto-configuration with etcd make it a great large-scale resolver solution.
16

17
The server adopts a [different scaling strategy][scaling] than the rest of the DNS recursors - no threading, shared-nothing architecture (except MVCC cache that may be shared) that allows you to pin instances on available CPU cores and grow by self-replication. You can start and stop additional nodes depending on the contention without downtime.
Marek Vavruša's avatar
Marek Vavruša committed
18

Marek Vavrusa's avatar
Marek Vavrusa committed
19 20 21 22
It also has strong support for DNS over TCP, notably TCP Fast-Open, query pipelining and deduplication, and response reordering.

### Packages

Vladimír Čunát's avatar
Vladimír Čunát committed
23 24 25 26 27 28 29
Knot Resolver is packaged for
[Debian](https://packages.debian.org/sid/knot-resolver),
[Fedora](https://apps.fedoraproject.org/packages/knot-resolver/),
[Ubuntu](https://packages.ubuntu.com/zesty/knot-resolver),
[Homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/knot-resolver.rb) and
[NixOS/Nixpkgs](https://hydra.nixos.org/search?query=knot-resolver).
You can also find it as the default DNS resolver in our open-source router [Turris Omnia](https://omnia.turris.cz).
30
See the [Knot-resolver homepage](https://www.knot-resolver.cz/download/) for more information.
Vladimír Čunát's avatar
Vladimír Čunát committed
31 32

<!-- [openSUSE](https://build.opensuse.org/package/show/server:dns/knot-resolver), (it seems to be in a bad shape) -->
Marek Vavrusa's avatar
Marek Vavrusa committed
33

Marek Vavruša's avatar
Marek Vavruša committed
34 35
### Building from sources

Vladimír Čunát's avatar
Vladimír Čunát committed
36
Knot DNS Resolver mainly [depends][depends] on Knot DNS libraries, [LuaJIT][luajit] and [libuv][libuv].
Marek Vavruša's avatar
Marek Vavruša committed
37
See the [Building project][depends] documentation page for more information.
Marek Vavruša's avatar
Marek Vavruša committed
38 39 40 41

### Docker image

This is simple and doesn't require any dependencies or system modifications, just run:
42 43

```
Pavel Valach's avatar
Pavel Valach committed
44
$ docker run -it cznic/knot-resolver
45 46
```

47
See the build page [hub.docker.com/r/cznic/knot-resolver](https://hub.docker.com/r/cznic/knot-resolver/) for more information and options.
Marek Vavruša's avatar
Marek Vavruša committed
48 49

### Running
50

Marek Vavrusa's avatar
Marek Vavrusa committed
51
The project builds a resolver library in the `lib` directory, and a daemon in the `daemon` directory. It requires no configuration or parameters to run a server on localhost.
52 53

```
Marek Vavrusa's avatar
Marek Vavrusa committed
54
$ kresd
55
```
Marek Vavruša's avatar
Marek Vavruša committed
56

57
See the documentation at [knot-resolver.readthedocs.io][doc] for more options.
Marek Vavruša's avatar
Marek Vavruša committed
58

59 60 61
[depends]: https://knot-resolver.readthedocs.io/en/latest/build.html
[doc]: https://knot-resolver.readthedocs.io/en/latest/index.html
[scaling]: https://knot-resolver.readthedocs.io/en/latest/daemon.html#scaling-out
Marek Vavruša's avatar
Marek Vavruša committed
62
[deckard]: https://gitlab.labs.nic.cz/knot/deckard
Vladimír Čunát's avatar
Vladimír Čunát committed
63 64
[luajit]: https://luajit.org/
[libuv]: http://libuv.org
Marek Vavruša's avatar
Marek Vavruša committed
65
[openresty]: https://openresty.org/
The Gitter Badger's avatar
The Gitter Badger committed
66 67 68 69

### Contacting us

[![Join the chat at https://gitter.im/CZ-NIC/knot-resolver](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/CZ-NIC/knot-resolver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)