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