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