1 PowerDNS is copyright © 2001-2019 by PowerDNS.COM BV and lots of
2 contributors, using the GNU GPLv2 license (see NOTICE for the
3 exact license and exception used).
5 All documentation can be found on https://doc.powerdns.com/
7 This file may lag behind at times. For most recent updates, always check
8 https://doc.powerdns.com/md/changelog/.
10 Another good place to look for information is:
11 https://doc.powerdns.com/md/appendix/compiling-powerdns/
13 To file bugs, head towards:
14 https://github.com/PowerDNS/pdns/issues
16 But please check if the issue is already reported there first.
20 Source code is available on GitHub:
23 git clone https://github.com/PowerDNS/pdns.git
26 This repository contains the sources for the PowerDNS Recursor, the PowerDNS
27 Authoritative Server, and dnsdist (a powerful DNS loadbalancer). All three can
28 be built from this repository. However, all three released separately as .tar.bz2,
31 The different releases can be built by the help of pdns-builder, which uses a
32 docker-based build process. To get started with this, run these commands in the root
41 This will bring up a USAGE-page which will explain how to build the different releases.
43 COMPILING Authoritative Server
44 ------------------------------
45 The PowerDNS Authoritative Server depends on Boost, OpenSSL and requires a
46 compiler with C++-2011 support.
48 On Debian 9, the following is useful:
51 apt install g++ libboost-all-dev libtool make pkg-config default-libmysqlclient-dev libssl-dev virtualenv libluajit-5.1-dev
54 When building from git, the following packages are also required:
57 apt install autoconf automake ragel bison flex
60 For Ubuntu 18.04 (Bionic Beaver), the following packages should be installed:
63 apt install libcurl4-openssl-dev luajit lua-yaml-dev libyaml-cpp-dev libtolua-dev lua5.3 autoconf automake ragel bison flex g++ libboost-all-dev libtool make pkg-config libssl-dev virtualenv lua-yaml-dev libyaml-cpp-dev libluajit-5.1-dev libcurl4 gawk
64 # For DNSSEC ed25519 (algorithm 15) support with --with-libsodium
65 apt install libsodium-dev
66 # If using the gmysql (Generic MySQL) backend
67 apt install default-libmysqlclient-dev
68 # If using the gpgsql (Generic PostgreSQL) backend
69 apt install postgresql-server-dev-10
70 # If using --enable-systemd (will create the service scripts so it can be managed with systemctl/service)
71 apt install libsystemd0 libsystemd-dev
72 # If using the geoip backend
73 apt install libmaxminddb-dev libmaxminddb0 libgeoip1 libgeoip-dev
76 Then generate the configure file:
82 To compile a very clean version, use:
85 ./configure --with-modules="" --disable-lua-records
90 This generates a PowerDNS Authoritative Server binary with no modules built in.
92 See https://doc.powerdns.com/authoritative/backends/index.html for a list of available modules.
94 When `./configure` is run without `--with-modules`, the bind and gmysql module are
95 built-in by default and the pipe-backend is compiled for runtime loading.
97 To add multiple modules, try:
100 ./configure --with-modules="bind gmysql gpgsql"
103 Note that you will need the development headers for PostgreSQL as well in this case.
105 See https://doc.powerdns.com/authoritative/appendices/compiling.html for more details.
107 If you run into C++11-related symbol trouble, please try passing `CPPFLAGS=-D_GLIBCXX_USE_CXX11_ABI=0` (or 1) to `./configure` to make sure you are compatible with the installed dependencies.
109 Compiling the Recursor
110 ----------------------
111 See [README.md](pdns/recursordist/README.md) in `pdns/recursordist/`.
115 See [README-dnsdist.md](pdns/README-dnsdist.md) in `pdns/`.
117 Building the HTML documentation
118 -------------------------------
120 The HTML documentation (as seen [on the PowerDNS docs site](https://doc.powerdns.com/authoritative/)) is built from ReStructured Text (rst) files located in `docs`. They are compiled into HTML files using [Sphinx](http://www.sphinx-doc.org/en/master/index.html), a documentation generator tool which is built in Python.
122 **Using a normal Python installation**
124 For those simply contributing to the documentation, this avoids needing to install the various build
125 tools and other dependencies.
127 Install Python 2.7 or Python 3 (preferable) if you don't yet have it installed. On some operating
128 systems you may also have to install `python3-pip` or similarly named.
134 apt install python3 python3-pip python3-venv
137 macOS (using homebrew)
143 Update your `pip` and install/update `virtualenv` to avoid problems:
146 # for python2, use "pip" instead of "pip3"
148 pip3 install -U virtualenv
151 Enter the repository's `docs` folder, set up the virtualenv, and install the requirements
155 # for python2, use "virtualenv .venv" instead
156 python3 -m venv .venv
157 source .venv/bin/activate
158 # The virtualenv may use an older pip, so upgrade it again
159 pip3 install -U pip setuptools setuptools-git
160 # Now you can install the requirements
161 pip3 install -r requirements.txt
164 Finally, you can build the documentation:
167 sphinx-build . html-docs
170 Note: If your shell has problems finding sphinx-build, try using `.venv/bin/sphinx-build` instead.
172 The HTML documentation is now available in `html-docs`.
174 **Using the build tools**
176 This method is preferable for those who already have a working build environment for PowerDNS.
178 Install the dependencies under "COMPILING", and run autoreconf if you haven't already:
184 Enter the `docs` folder, and use make to build the HTML docs.
191 The HTML documentation will now be available in `html-docs`.
195 Use a recent gcc (and other build tools), possibly from Solaris 11 IPS.
197 If you encounter problems with the Solaris make, gmake is advised.
201 You need to compile using gmake - regular make only appears to work, but doesn't in fact. Use gmake, not make.
203 The clang compiler installed through FreeBSD's package manager does not expose all of the C++11 features needed under `std=gnuc++11`. Force the compiler to use `std=c++11` mode instead.
206 export CXXFLAGS=-std=c++11
211 PowerDNS Authoritative Server is available through Homebrew:
217 If you want to compile yourself, the dependencies can be installed using
218 Homebrew. You need to tell configure where to find OpenSSL, too.
221 brew install boost lua pkg-config ragel openssl
222 ./configure --with-modules="" PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig
226 Additionally, for PostgreSQL support, run `brew install postgresql` and add `--with-modules="gpgsql"` to `./configure`.
227 For MySQL support, run `brew install mariadb` and add `--with-modules="gmysql"` to `./configure`.