pdns-recursor  4.5.6
About: PowerDNS - a separate release of the PowerDNS Recursor (without the authoritative nameserver).
  Fossies Dox: pdns-recursor-4.5.6.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  

pdns-recursor Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies pdns-recursor-4.5.6.tar.bz2 contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README

PowerDNS Recursor

For full details, please read https://doc.powerdns.com/md/recursor/

Here follow some brief notes that may be useful to get you going.

Compiling

Starting with version 4.0.0, the PowerDNS recursor uses autotools and compiling from the tarball can be as simple as

./configure
make

As for dependencies, Boost (http://boost.org/), OpenSSL (https://openssl.org/), and Lua (https://www.lua.org/) are required.

On most modern UNIX distributions, you can simply install 'boost' or 'boost-dev' or 'boost-devel'. Otherwise, just download boost, and point the compiler at the right directory using CPPFLAGS.

On Debian and Ubuntu, the following will get you the dependencies:

apt-get install libboost-dev libboost-filesystem-dev libboost-serialization-dev \
  libboost-system-dev libboost-thread-dev libboost-context-dev libboost-test-dev \
  libssl-dev libboost-test-dev g++ make pkg-config libluajit-5.1-dev

Compiling from git checkout

Source code is available on GitHub:

git clone https://github.com/PowerDNS/pdns.git

This repository contains the sources for the PowerDNS Recursor, the PowerDNS Authoritative Server, and dnsdist (a powerful DNS loadbalancer). The sources for the recursor are located in the pdns/recursordist subdirectory of the repository.

To compile from a git checkout, install the dependencies above plus ragel, automake, autoconf, libtool, virtualenv and curl. Then run

cd pdns/pdns/recursordist/
autoreconf -vi
./configure
make

macOS Notes

If you want to compile yourself, the dependencies can be installed using Homebrew. You need to tell configure where to find OpenSSL, too.

brew install boost lua pkg-config ragel openssl
./configure --with-lua PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig
make -j4

Lua scripting

To benefit from Lua scripting, as described on https://doc.powerdns.com/md/recursor/scripting/ Install Lua and development headers. PowerDNS supports Lua 5.1, 5.2, 5.3 and LuaJIT. On Debian/Ubuntu, install e.g. liblua5.2-dev to use Lua 5.2.

The configure script will automatically detect the Lua version. If more than one version of Lua is installed, the --with-lua configure flag can be set to the desired version. e.g.:

./configure --with-lua=lua51

(On older versions of Debian/Ubuntu, you'll need to pass --with-lua=lua5.1 instead.)

Documentation

After compiling, run pdns\_recursor --config to view the configuration options and a short description. The full documentation is online at https://doc.powerdns.com/recursor/

Reporting bugs

Bugs can be reported on GitHub: https://github.com/PowerDNS/pdns/issues, please check first if your issue is not fixed in the latest version or has already been reported.

License

PowerDNS is copyright © 2001-2019 by PowerDNS.COM BV and lots of contributors, using the GNU GPLv2 license (see NOTICE for the exact license and exception used).

Third party software

We use code from the following projects:

Protozero

protozero copyright (c) Mapbox.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the
  distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.