xref: /netbsd-src/external/bsd/nsd/dist/README.md (revision aef5eb5f59cdfe8314f1b5f78ac04eb144e44010)
1# NSD
2
3[![Travis Build Status](https://travis-ci.org/NLnetLabs/nsd.svg?branch=master)](https://travis-ci.org/NLnetLabs/nsd)
4[![Cirrus Build Status](https://api.cirrus-ci.com/github/NLnetLabs/nsd.svg)](https://cirrus-ci.com/github/NLnetLabs/nsd)
5[![Packaging status](https://repology.org/badge/tiny-repos/nsd.svg)](https://repology.org/project/nsd/versions)
6[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1462/badge)](https://bestpractices.coreinfrastructure.org/projects/1462)
7
8The NLnet Labs Name Server Daemon (NSD) is an authoritative DNS name server.
9It has been developed for operations in environments where speed,
10reliability, stability and security are of high importance.  If you
11have any feedback, we would love to hear from you. Don’t hesitate to
12[create an issue on Github](https://github.com/NLnetLabs/nsd/issues/new)
13or post a message on the
14[NSD mailing list](https://lists.nlnetlabs.nl/mailman/listinfo/nsd-users).
15You can learn more about NSD by reading our
16[documentation](https://nsd.docs.nlnetlabs.nl/).
17
18## Compiling
19
20Make sure you have the following installed:
21  * C toolchain (the set of tools to compile C such as a compiler, linker, and assembler)
22  * OpenSSL, with its include files (usually these are included in the "dev" version of the library)
23  * libevent, with its include files (usually these are included in the "dev" version of the library)
24  * flex
25  * bison
26
27The repository does not contain `./configure`, but you can generate it like
28this (note that the `./configure` is included in release tarballs so they do not have to be generated):
29
30```
31aclocal && autoconf && autoheader
32```
33
34NSD can be compiled and installed using:
35
36```
37./configure && make && make install
38```
39
40## NSD configuration
41
42The configuration options for NSD are described in the man pages, which are
43installed (use `man nsd.conf`) and are available on the NSD
44[documentation page](https://nsd.docs.nlnetlabs.nl/).
45
46An example configuration file is located in
47[nsd.conf.sample](https://github.com/NLnetLabs/nsd/blob/master/nsd.conf.sample.in).
48