Skip to content
Snippets Groups Projects
README 3.4 KiB
Newer Older
Dependencies
============
Knot DNS has several dependencies:
* libtool
* autoconf > 2.65
* gnutls >= 3.0
* jansson >= 2.3
Embedded libraries:
* lmdb               (system library is preferred)

Optional packages:
* libcap-ng >= 0.6.4 (for POSIX 1003.1e capabilities(7))
* libidn             (for IDNA2003 support in Knot utilities)
* libsystemd         (for systemd init system support)

Dependencies for building documentation:
Jan Mercl's avatar
Jan Mercl committed
Installation
============
Daniel Salzman's avatar
Daniel Salzman committed
Knot DNS may already be included in your operating system distribution and
therefore can be installed from packages (Linux), ports (BSD) or via
Homebrew (Mac). This is always preferred unless you want to test the latest
features, contribute to Knot development, or you just know what you are doing.

Following sections describe how to build Knot DNS from the source code.

Daniel Salzman's avatar
Daniel Salzman committed
1) Install prerequisites
Jan Mercl's avatar
Jan Mercl committed

Daniel Salzman's avatar
Daniel Salzman committed
Debian based distributions
--------------------------
Update the system:
Jan Mercl's avatar
Jan Mercl committed
$ sudo apt-get update
$ sudo apt-get upgrade
Daniel Salzman's avatar
Daniel Salzman committed
Install prerequisites:
$ sudo apt-get install \
  libtool autoconf make pkg-config liburcu-dev libgnutls28-dev libjansson-dev libedit-dev
Install optional packages to override embedded libraries:
$ sudo apt-get install liblmdb-dev
Install optional packages:
$ sudo apt-get install libcap-ng-dev libsystemd-dev libidn11-dev protobuf-c-compiler libfstrm-dev
Daniel Salzman's avatar
Daniel Salzman committed
Fedora like distributions
-------------------------
# dnf upgrade
Install basic development tools:
# dnf install @buildsys-build

Install prerequisites:
# dnf install \
  libtool autoconf pkgconfig automake userspace-rcu-devel gnutls-devel jansson-devel libedit-devel
Install optional packages to override embedded libraries:
# dnf install lmdb-devel
Daniel Salzman's avatar
Daniel Salzman committed
Install optional packages:
# dnf install libcap-ng-devel systemd-devel libidn-devel protobuf-c-devel fstrm-devel
When compiling on RHEL based system, the Fedora EPEL repository has to be
enabled. Also for RHEL 6, forward compatibility package gnutls30-devel
with newer GnuTLS is required instead of gnutls-devel.

Daniel Salzman's avatar
Daniel Salzman committed
2) Install Knot DNS

Knot DNS requires compiler to support atomic intrinsics.
GCC version at least 4.1 supports legacy atomic builtins, however 4.7
or newer is preferred. Clang supports atomics since version 2.9.
Daniel Salzman's avatar
Daniel Salzman committed

Get the source code:
$ git clone git://git.nic.cz/knot-dns.git
Or extract source package to knot-dns directory

Compile Knot
$ cd knot-dns
$ autoreconf -if
$ ./configure
$ make

Install Knot DNS into system:
$ sudo make install
$ sudo ldconfig

NOTE: If you want to reduce zscanner compile time, use configure option --disable-fastparser.
1) Each server needs configuration file. Please see samples/knot.sample.conf,
project documentation, or man 5 knot.conf for more details.
Jan Kadlec's avatar
Jan Kadlec committed
Configuration file has to specify:
Daniel Salzman's avatar
Daniel Salzman committed
- storage for PID files, journal files etc.
- network interfaces
- served zones
Marek Vavrusa's avatar
Marek Vavrusa committed

Daniel Salzman's avatar
Daniel Salzman committed
E.g. use the default config file:
$ cd /etc/knot
$ mv knot.sample.conf knot.conf
Modify the config:
$ editor knot.conf
Marek Vavrusa's avatar
Marek Vavrusa committed

Daniel Salzman's avatar
Daniel Salzman committed
2) Prepare working directory
$ mv example.com.zone /var/lib/knot/
Daniel Salzman's avatar
Daniel Salzman committed
3) Start the server. This can be done by running the 'knotd' command.
Daniel Salzman's avatar
Daniel Salzman committed
Alternatively, your distribution should have an init script available, if you've
installed Knot using a binary package.
Start Knot in the foreground to see if it runs:
Daniel Salzman's avatar
Daniel Salzman committed
$ knotd -c myserver.conf
Jan Kadlec's avatar
Jan Kadlec committed

Daniel Salzman's avatar
Daniel Salzman committed
For more information, refer to the user manual or:
$ knotc -h
$ knotd -h
The Gitter Badger's avatar
The Gitter Badger committed

Join the chat at https://gitter.im/CZ-NIC/knot