xref: /freebsd/contrib/unbound/README.md (revision 103ba509e72e3949d22485666949e9705d4af8cd)
1# Unbound
2
3[![Github Build Status](https://github.com/NLnetLabs/unbound/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/NLnetLabs/unbound/actions)
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[![Documentation Status](https://readthedocs.org/projects/unbound/badge/?version=latest)](https://unbound.readthedocs.io/en/latest/?badge=latest)
7[![Mastodon Follow](https://img.shields.io/mastodon/follow/109262826617293067?domain=https%3A%2F%2Ffosstodon.org&style=social)](https://fosstodon.org/@nlnetlabs)
8
9Unbound is a validating, recursive, caching DNS resolver. It is designed to be
10fast and lean and incorporates modern features based on open standards. 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/unbound/issues/new)
13or post a message on the [Unbound mailing list](https://lists.nlnetlabs.nl/mailman/listinfo/unbound-users).
14You can learn more about Unbound by reading our
15[documentation](https://unbound.docs.nlnetlabs.nl/).
16
17## Compiling
18
19Make sure you have the C toolchain, OpenSSL and its include files, and libexpat
20installed.
21If building from the repository source you also need flex and bison installed.
22Unbound can be compiled and installed using:
23
24```
25./configure && make && make install
26```
27
28You can use libevent if you want. libevent is useful when using many (10000)
29outgoing ports. By default max 256 ports are opened at the same time and the
30builtin alternative is equally capable and a little faster.
31
32Use the `--with-libevent` configure option to compile Unbound with libevent
33support.
34
35## Unbound configuration
36
37All of Unbound's configuration options are described in the man pages, which
38will be installed and are available on the Unbound
39[documentation page](https://unbound.docs.nlnetlabs.nl/).
40
41An example configuration file is located in
42[doc/example.conf](https://github.com/NLnetLabs/unbound/blob/master/doc/example.conf.in).
43