README.md

   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 [![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
   9 Unbound is a validating, recursive, caching DNS resolver. It is designed to be
  10 fast and lean and incorporates modern features based on open standards. If you
  11 have 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)
  13 or post a message on the [Unbound mailing list](https://lists.nlnetlabs.nl/mailman/listinfo/unbound-users).
  14 You can learn more about Unbound by reading our
  15 [documentation](https://unbound.docs.nlnetlabs.nl/).
  16
  17 ## Compiling
  18
  19 Make sure you have the C toolchain, OpenSSL and its include files, and libexpat
  20 installed. Unbound can be compiled and installed using:
  21
  22 ```
  23 ./configure && make && make install
  24 ```
  25
  26 You can use libevent if you want. libevent is useful when using many (10000)
  27 outgoing ports. By default max 256 ports are opened at the same time and the
  28 builtin alternative is equally capable and a little faster.
  29
  30 Use the `--with-libevent=dir` configure option to compile Unbound with libevent
  31 support.
  32
  33 ## Unbound configuration
  34
  35 All of Unbound's configuration options are described in the man pages, which
  36 will be installed and are available on the Unbound
  37 [documentation page](https://unbound.docs.nlnetlabs.nl/).
  38
  39 An example configuration file is located in
  40 [doc/example.conf](https://github.com/NLnetLabs/unbound/blob/master/doc/example.conf.in).