README.md 4.36 KB
Newer Older
1
# Knot Resolver
2

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

8
Knot 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
Vladimír Čunát's avatar
Vladimír Čunát committed
9
a state-machine like API for extensions. There are three modules built-in - *iterator*, *validator*, *cache*, and a few more are loaded by default. 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.
10

Vladimír Čunát's avatar
Vladimír Čunát committed
11
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.
12

Vladimír Čunát's avatar
Vladimír Čunát committed
13
Strong filtering rules, and auto-configuration with etcd make it a great large-scale resolver solution.
14

15
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.
16

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

### Packages

21 22 23 24 25 26 27 28 29 30 31 32 33 34
The latest stable packages for various distributions are available in our
[upstream repository](https://build.opensuse.org/package/show/home:CZ-NIC:knot-resolver-latest/knot-resolver).
Follow the
[installation instructions](https://software.opensuse.org//download.html?project=home%3ACZ-NIC%3Aknot-resolver-latest&package=knot-resolver)
to add this repository to your system.

Knot Resolver is also available from the following distributions' repositories.

* [Fedora and Fedora EPEL](https://apps.fedoraproject.org/packages/knot-resolver)
* [Debian stable](https://packages.debian.org/stable/knot-resolver),
  [Debian testing](https://packages.debian.org/testing/knot-resolver),
  [Debian unstable](https://packages.debian.org/sid/knot-resolver)
* [Ubuntu](https://packages.ubuntu.com/bionic/knot-resolver)
* [Arch Linux (AUR)](https://aur.archlinux.org/packages/knot-resolver)
Marek Vavrusa's avatar
Marek Vavrusa committed
35

36 37
### Building from sources

38
Knot Resolver mainly [depends][depends] on Knot DNS libraries, [LuaJIT][luajit] and [libuv][libuv].
39
See the [Building project][depends] documentation page for more information.
Marek Vavruša's avatar
Marek Vavruša committed
40 41 42 43

### Docker image

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

```
46
$ docker run -it cznic/knot-resolver
47 48
```

49
See the build page [hub.docker.com/r/cznic/knot-resolver](https://hub.docker.com/r/cznic/knot-resolver/) for more information and options.
50
The images are meant as an easy way to try knot-resolver, and they're not designed for production use.
Marek Vavruša's avatar
Marek Vavruša committed
51 52

### Running
53

Marek Vavrusa's avatar
Marek Vavrusa committed
54
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.
55 56

```
Marek Vavrusa's avatar
Marek Vavrusa committed
57
$ kresd
58
```
Marek Vavruša's avatar
Marek Vavruša committed
59

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

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

### Contacting us

Vladimír Čunát's avatar
Vladimír Čunát committed
72 73 74 75
- [GitLab issues](https://gitlab.labs.nic.cz/knot/knot-resolver/issues) (you may authenticate via GitHub)
- [mailing list](https://lists.nic.cz/cgi-bin/mailman/listinfo/knot-resolver-users)
- [![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)