Commit 9259b273 authored by Marek Vavrusa's avatar Marek Vavrusa

pre-release cleanup

parent addf898e
marek.vavrusa@nic.cz
jan.vcelak@nic.cz
Marek Vavrusa <marek@vavrusa.com>
Ondřej Surý <ondrej.sury@nic.cz>
Jan Vcelak <jan.vcelak@nic.cz>
Grigorii Demidov <grigorii.demidov@nic.cz>
Karel Slany <karel.slany@nic.cz>
Daniel Salzman <daniel.salzman@nic.cz>
Pavel Valach <valach.pavel@gmail.com>
Tomas Hozza <thozza@redhat.com>
Daniel Kahn Gillmor <dkg@fifthhorseman.net>
# Change Log
All notable changes to this project will be documented in this file.
## [Unreleased][unreleased]
### Changed
## Unreleased changes
* N/A
## 1.0.0
- Written documentation
- Resolver daemon with scriptable interface
- Resolver library with basic interface
- Pluggable modules written in C/Go
* First release
......@@ -15,6 +15,13 @@ Several cache backends (LMDB, Redis and Memcached), strong filtering rules, and
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.
It also has strong support for DNS over TCP, notably TCP Fast-Open, query pipelining and deduplication, and response reordering.
### Packages
Knot Resolver is packaged for Debian, Fedora, Ubuntu and [openSUSE](https://build.opensuse.org/package/show/server:dns/knot-resolver).
See [project page](https://www.knot-resolver.cz/pages/try.html) for more information.
### Building from sources
The Knot DNS Resolver [depends][depends] on the 2.1 version of the Knot DNS library, [LuaJIT][luajit] and [libuv][libuv].
......@@ -32,13 +39,13 @@ See the build page [hub.docker.com/r/cznic/knot-resolver](https://hub.docker.com
### Running
The project builds a resolver library in the `lib` directory, and a daemon in the `daemon` directory.
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.
```
$ kresd -h
$ kresd
```
See the documentation at [knot-resolver.readthedocs.org][doc].
See the documentation at [knot-resolver.readthedocs.org][doc] for more options.
[depends]: http://knot-resolver.readthedocs.org/en/latest/build.html
[doc]: http://knot-resolver.readthedocs.org/en/latest/index.html
......
Building project
================
The resolver isn't yet available in the repositories, so you can either build it from sources or use
official `Docker images`_.
Installing from packages
------------------------
The resolver is packaged for Debian, Fedora, Ubuntu and openSUSE Linux distributions.
Refer to `project page <https://www.knot-resolver.cz/pages/try.html>`_ for information about
installing from packages. If packages are not available for your OS, see following sections
to see how you can build it from sources (or package it), or use official `Docker images`_.
Platform considerations
-----------------------
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment