Commit d7f6ed09 authored by Daniel Salzman's avatar Daniel Salzman

doc: update some sections

parent 80a157c7
......@@ -69,7 +69,8 @@ Installation from the sources
=============================
You can find the source files for the latest release on `www.knot-dns.cz <https://www.knot-dns.cz>`_.
Alternatively, you can fetch the sources from git repository `<git://git.nic.cz/knot-dns.git>`_.
Alternatively, you can fetch the sources from git repository
`git://git.nic.cz/knot-dns.git <https://gitlab.labs.nic.cz/labs/knot/tree/master>`_.
After unpacking the sources, the compilation and installation is a
quite straightforward process using autotools.
......@@ -79,10 +80,14 @@ quite straightforward process using autotools.
Configuring and generating Makefiles
------------------------------------
If you want to compile from Git sources, you need to bootstrap the ``./configure`` file first.::
If you want to compile from Git sources, you need to bootstrap the ``./configure`` file first::
$ autoreconf -i -f
In most cases you can just run configure without any options::
$ ./configure
For all available configure options run::
$ ./configure --help
......@@ -106,47 +111,39 @@ verbosity as ``brief, verbose, details``.
For example::
$ ./configure --enable-debug=server,packet --enable-debuglevel=brief
$ ./configure --enable-debug=server,packet --enable-debuglevel=verbose
For more detailed information, see :ref:`Debug messages`. ##TODO
In most simple case you can just run configure without any options::
$ ./configure
For more detailed information, see :ref:`Debug messages`.
Compilation
-----------
(After running ``./configure`` you can compile Knot DNS by running
After running ``./configure`` you can compile Knot DNS by running
``make`` command, which will produce binaries and other related
files::
$ make
Knot DNS build process is safe to parallelize using ``make -j N``,
where N is number of concurrent processes. Using this option can
increase speed of the compilation.
For example to use maximum 8 concurrent processes you would use::
$ make -j 8
where N is a number of concurrent processes. Using this the compilation speed
can be increased.
Installation
------------
When you have finished building the Knot DNS, it's time to install the
When you have finished building Knot DNS, it's time to install the
binaries and configuration files into the operation system hierarchy.
You can do so by executing ``make install`` command. When installing
as a non-root user you might have to gain elevated privileges by
switching to root user, e.g. ``sudo make install`` or ``su -c 'make install'``::
You can do so by executing::
$ make install
When installing as a non-root user you might have to gain elevated privileges by
switching to root user, e.g. ``sudo make install`` or ``su -c 'make install'``.
Installation from packages
==========================
In addition to providing the packages in .DEB and .RPM format, the
In addition to providing the packages in .DEB and .RPM format,
Knot DNS might already be available in your favourite distribution, or
in a ports tree.
......@@ -163,12 +160,12 @@ be used by adding::
to your ``/etc/apt/sources.list`` or into separate file in
``/etc/apt/sources.list.d/``.
As an example, for Debian squeeze (current stable) the Knot DNS
packages can be added by executing following command as the root user::
As an example, for Debian wheezy the Knot DNS packages can be added by
executing following command as the root user::
$ cat >/etc/apt/sources.list.d/knot.list <<EOF
deb http://deb.knot-dns.cz/debian/ <codename> main
deb-src http://deb.knot-dns.cz/debian/ <codename> main
deb http://deb.knot-dns.cz/debian/ wheezy main
deb-src http://deb.knot-dns.cz/debian/ wheezy main
EOF
$ apt-get update
$ apt-get install knot
......@@ -176,17 +173,12 @@ packages can be added by executing following command as the root user::
Installing Knot DNS packages on Ubuntu
--------------------------------------
Prepackaged version of the Knot DNS can be found in Ubuntu from
Prepackaged version of Knot DNS can be found in Ubuntu from
version 12.10 (Quantal Quetzal). In addition to the package included
in the main archive, we provide Personal Package Archive (PPA) as an
option to upgrade to last stable version of the Knot DNS or to install
option to upgrade to the last stable version of Knot DNS or to install
it on older versions of Ubuntu Linux.
We typically provide packages for all supported versions of Ubuntu
Linux including 5 year support for `LTS <https://wiki.ubuntu.com/LTS>`_
versions of Ubuntu Linux. At the time of writing this manual this
includes Ubuntu 10.04 LTS, 11.04, 11.10 and 12.04 LTS.
Adding official PPA repository for Knot DNS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -209,30 +201,7 @@ repositories since Fedora 18 (Spherical Cow). Look for ``knot``
package in your package manager. To install the package using Yum, run
a following command as the root user::
# yum install knot
Using official distribution repository is highly recommended, however you may
want to run ``Knot DNS`` on older releases of Fedora. In this case you can
set up an unofficial repository by creating :file:`/etc/yum.repos.d/knot.conf`
file with the following content::
[knot]
name=Network.CZ Repository
baseurl=ftp://repo.network.cz/pub/redhat/
enabled=1
gpgcheck=0
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-network.cz
After performing this action, you can install ``knot`` package the same way
as described above. Please note that the unofficial repository contains only
builds for i686 and x86_64 architecture.
When upgrading to Fedora 18 or higher, backup the configuration and
switch to the latest package provided in the official repository by running the
following command as the root user::
# yum distro-sync knot
$ yum install knot
Installing Knot DNS from ports on FreeBSD
-----------------------------------------
......
......@@ -28,6 +28,8 @@ Knot DNS supports the following DNS features:
* DNSSEC, including NSEC3
* NSID
* Unknown RR types
* Dynamic updates
* Response Rate Limiting
Server features:
......@@ -38,11 +40,9 @@ Server features:
For more info and downloads see `www.knot-dns.cz <https://www.knot-dns.cz>`_.
Git repository: `git://git.nic.cz/knot-dns.git <git://git.nic.cz/knot-dns.git>`_
Git repository: `git://git.nic.cz/knot-dns.git <https://gitlab.labs.nic.cz/labs/knot/tree/master>`_
Git repository browser: `gitlab.labs.nic.cz/knot/tree/master <https://gitlab.labs.nic.cz/knot/tree/master>`_
Knot DNS issue tracker: `gitlab.labs.nic.cz/knot/issues <https://gitlab.labs.nic.cz/knot/issues>`_
Knot DNS issue tracker: `gitlab.labs.nic.cz/labs/knot/issues <https://gitlab.labs.nic.cz/labs/knot/issues>`_
Knot DNS users mailing list: `knot-dns-users@lists.nic.cz <mailto:knot-dns-users@lists.nic.cz>`_
......
......@@ -28,7 +28,7 @@ Memory requirements
Knot DNS implementation focuses on performance and thus can be quite
demanding for memory. The rough estimate for memory requirements is
5-7 times of the size of the zone in text format. Again this is only
3 times of the size of the zone in text format. Again this is only
an estimate and you are advised to do your own measurements before
deploying Knot DNS into production.
......@@ -42,6 +42,5 @@ Supported operating system
Knot DNS itself is written in a portable way, but it depends on
several libraries. Namely userspace-rcu, which could be a constraint
when it comes to the operating system support. As far as we know the
Knot DNS can be compiled and run on Linux, FreeBSD, OpenBSD, NetBSD
and Mac OS X.
when it comes to the operating system support. Knot DNS can be compiled
and run on most of UNIX-like systems, such as Linux, *BSD and Mac OS X.
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