xref: /openbsd/usr.sbin/unbound/README.md (revision 274d7c50) 
1# Unbound
2
3[![Travis Build Status](https://travis-ci.org/NLnetLabs/unbound.svg?branch=master)](https://travis-ci.org/NLnetLabs/unbound)
4[![Packaging status](https://repology.org/badge/tiny-repos/unbound.svg)](https://repology.org/project/unbound/versions)
5
6Unbound is a validating, recursive, caching DNS resolver. It is designed to be
7fast and lean and incorporates modern features based on open standards. If you
8have any feedback, we would love to hear from you. Don’t hesitate to
9[create an issue on Github](https://github.com/NLnetLabs/unbound/issues/new)
10or post a message on the [Unbound mailing list](https://nlnetlabs.nl/mailman/listinfo/unbound-users).
11You can lean more about Unbound by reading our
12[documentation](https://nlnetlabs.nl/documentation/unbound/).
13
14## Compiling
15
16Make sure you have the C toolchain, OpenSSL and its include files, and libexpat
17installed. Unbound can be compiled and installed using:
18
19```
20./configure && make && make install
21```
22
23You can use libevent if you want. libevent is useful when using many (10000)
24outgoing ports. By default max 256 ports are opened at the same time and the
25builtin alternative is equally capable and a little faster.
26
27Use the `--with-libevent=dir` configure option to compile Unbound with libevent
28support.
29
30## Unbound configuration
31
32All of Unbound's configuration options are described in the man pages, which
33will be installed and are available on the Unbound
34[documentation page](https://nlnetlabs.nl/documentation/unbound/).
35
36An example configuration file is located in
37[doc/example.conf](https://github.com/NLnetLabs/unbound/blob/master/doc/example.conf.in).
38# Unbound
39
40[![Travis Build Status](https://travis-ci.org/NLnetLabs/unbound.svg?branch=master)](https://travis-ci.org/NLnetLabs/unbound)
41[![Packaging status](https://repology.org/badge/tiny-repos/unbound.svg)](https://repology.org/project/unbound/versions)
42
43Unbound is a validating, recursive, caching DNS resolver. It is designed to be
44fast and lean and incorporates modern features based on open standards. If you
45have any feedback, we would love to hear from you. Don’t hesitate to
46[create an issue on Github](https://github.com/NLnetLabs/unbound/issues/new)
47or post a message on the [Unbound mailing list](https://nlnetlabs.nl/mailman/listinfo/unbound-users).
48You can lean more about Unbound by reading our
49[documentation](https://nlnetlabs.nl/documentation/unbound/).
50
51## Compiling
52
53Make sure you have the C toolchain, OpenSSL and its include files, and libexpat
54installed. Unbound can be compiled and installed using:
55
56```
57./configure && make && make install
58```
59
60You can use libevent if you want. libevent is useful when using many (10000)
61outgoing ports. By default max 256 ports are opened at the same time and the
62builtin alternative is equally capable and a little faster.
63
64Use the `--with-libevent=dir` configure option to compile Unbound with libevent
65support.
66
67## Unbound configuration
68
69All of Unbound's configuration options are described in the man pages, which
70will be installed and are available on the Unbound
71[documentation page](https://nlnetlabs.nl/documentation/unbound/).
72
73An example configuration file is located in
74[doc/example.conf](https://github.com/NLnetLabs/unbound/blob/master/doc/example.conf.in).
75