summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorOndřej Surý <ondrej@sury.org>2013-09-30 15:03:20 +0200
committerOndřej Surý <ondrej@sury.org>2013-09-30 15:06:01 +0200
commit921a382418f140a66cacd9db745d340115f624a5 (patch)
treecb9dbceafc0ac9169e8c49a36cba843199dfd16e /README
parent1a3ad783981998bb4365de5a99f1d06b0198701f (diff)
downloadknot-921a382418f140a66cacd9db745d340115f624a5.tar.gz
New upstream version 1.3.2
Diffstat (limited to 'README')
-rw-r--r--README62
1 files changed, 18 insertions, 44 deletions
diff --git a/README b/README
index 74dea58..2d88034 100644
--- a/README
+++ b/README
@@ -23,7 +23,7 @@ Clang supports atomics since version 2.9.
By default Knot DNS is distributed with a slower zone file parser because of
smaller source file and quick compile time. In most cases it is sufficient.
-If you plan to process large zone files, it is recomended to build Knot DNS
+If you plan to process large zone files, we recommend to build Knot DNS
using ./configure --enable-fastparser. In this case Ragel compiler is required
and it is normal if the C compiler takes much more time (minutes).
@@ -41,7 +41,7 @@ Installation on Debian based distributions
==========================================
The following steps should work (verified in VirtualBox only)
-on the distribution/architecture/release combinations as listed bellow.
+for the distribution/architecture/release combinations as listed bellow.
----------------------------------------------
Debian (AMD64, I386) 6.0.2.1 (squeeze)
@@ -59,30 +59,17 @@ $ sudo apt-get install git-core autoconf libtool flex bison libssl-dev liburcu-d
# Install optional packages (POSIX 1003.1e capabilities)
$ sudo apt-get install libcap-ng-dev
-# If the liburcu-dev package is not present, install directly
-$ wget http://bd.archive.ubuntu.com/ubuntu/pool/universe/libu/liburcu/liburcu0_0.5.4-1_amd64.deb
-$ wget http://bd.archive.ubuntu.com/ubuntu/pool/universe/libu/liburcu/liburcu-dev_0.5.4-1_amd64.deb
-$ sudo dpkg -i liburcu0_0.5.4-1_amd64.deb
-$ sudo dpkg -i liburcu-dev_0.5.4-1_amd64.deb
+# If the liburcu-dev package is not present, install it directly
-# Go for the real thing
+# Get the source code
$ git clone git://git.nic.cz/knot-dns.git
-$ cd knot
+$ cd knot-dns
$ autoreconf -if
$ ./configure
$ make
$ sudo make install
$ sudo ldconfig
-Alternative packages for I386:
-$ # the required version of liburcu is not available in the default package
-$ # sources.
-$
-$ wget http://bd.archive.ubuntu.com/ubuntu/pool/universe/libu/liburcu/liburcu0_0.5.4-1_i386.deb
-$ wget http://bd.archive.ubuntu.com/ubuntu/pool/universe/libu/liburcu/liburcu-dev_0.5.4-1_i386.deb
-$ sudo dpkg -i liburcu0_0.5.4-1_i386.deb
-$ sudo dpkg -i liburcu-dev_0.5.4-1_i386.deb
-
Installation on Fedora
======================
@@ -142,15 +129,10 @@ Installation on OpenBSD/NetBSD
Also works for OS X, if you don't want to install gcc from ports.
Prerequisites:
-- liburcu needs patch for absent compiler TLS capability
- - patch is located in "scripts/urcu-tls-compat.patch"
-- patch compatible with liburcu-0.6.7
-- liburcu >= 0.7.0 works out of the box
- flex and bison from packages
$ mkdir liburcu && cd liburcu
-$ wget "http://lttng.org/files/urcu/userspace-rcu-0.6.7.tar.bz2"
-$ patch -p1 < ../scripts/urcu-tls-compat.patch
+$ wget "http://lttng.org/files/urcu/userspace-rcu-0.8.0.tar.bz2"
$ autoconf && ./configure && make && sudo make install
$ # or follow installation instructions in INSTALL
@@ -175,35 +157,27 @@ Running
First, each server needs configuration file.
Please see samples/knot.sample.conf for reference.
-Minimal configuration can be found in samples/knot.min.conf
-Configuration zone has to specify:
-* storage for PID files, compiled zones etc.
+More examples can be found in samples/knot.full.conf
+Configuration file has to specify:
+* storage for PID files, journal files etc.
* network interfaces
* served zones
-$ cp samples/knot.min.conf myserver.conf
+$ cp samples/knot.sample.conf myserver.conf
$ vim myserver.conf # or your favourite text editor
-$ knotc -h # see what it can do
+$ knotd -h # see what it can do
-Prepare working directory.
+Second, prepare working directory.
$ mkdir -p /tmp/knot-minimal/samples; cp samples/example.com.zone /tmp/knot-minimal/samples/
-Third, lets load server. You can do this by running 'knotd' directly, or with
-'knotc' as well. Server is able to run in daemonized or interactive mode.
-Lets start our server in interactive mode (parameter '-i') to see if it runs.
+Third, let's start the server. This can be done by running the 'knotd' command.
+Alternatively, your distribution should have an init script available, if you've
+installed Knot using a binary package.
-$ knotc -c myserver.conf -i start # start server in interactive mode
+Lets start our server in foreground to see if it runs:
-Running as daemon
-=================
+$ knotd -c myserver.conf
-Controller runs server in daemonized mode as default. Disadvantage is, that
-it closes stdout/stderr so you need to set up either syslog or logging to
-own files in the configuration. Controller parameter '-w' waits for the
-operation to finish. Let's test server functionality.
+For more information, refer to the user manual.
-$ knotc -c myserver.conf -w start # start server
-$ dig @$ADDR -p $PORT example.com # issue a query and see result
-$ ...
-$ knotc -c myserver.conf -w stop # stop server