]> git.ipfire.org Git - thirdparty/pdns.git/blob - README.md
Merge pull request #6642 from rgacogne/rec41-fix-error-string
[thirdparty/pdns.git] / README.md
1 PowerDNS is copyright © 2001-2018 by PowerDNS.COM BV and lots of
2 contributors, using the GNU GPLv2 license (see NOTICE for the
3 exact license and exception used).
4
5 All documentation can be found on http://doc.powerdns.com/
6
7 This file may lag behind at times. For most recent updates, always check
8 https://doc.powerdns.com/md/changelog/.
9
10 Another good place to look for information is:
11 https://doc.powerdns.com/md/appendix/compiling-powerdns/
12
13 To file bugs, head towards:
14 https://github.com/PowerDNS/pdns/issues
15
16 But please check if the issue is already reported there first.
17
18 SOURCE CODE / GIT
19 -----------------
20 Source code is available on GitHub:
21
22 ```
23 $ git clone https://github.com/PowerDNS/pdns.git
24 ```
25
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,
29 .deb and .rpm.
30
31 COMPILING Authoritative Server
32 ------------------------------
33 The PowerDNS Authoritative Server depends on Boost, OpenSSL and requires a
34 compiler with C++-2011 support.
35
36 On Debian 8.0, the following is useful:
37
38 ```
39 $ apt-get install g++ libboost-all-dev libtool make pkg-config libmysqlclient-dev libssl-dev
40 ```
41
42 When building from git, the following packages are also required: autoconf, automake,
43 ragel, bison and flex, then generate the configure file:
44
45 ```
46 $ ./bootstrap
47 ```
48
49 To compile a very clean version, use:
50
51 ```
52 $ ./configure --with-modules="" --without-lua
53 $ make
54 # make install
55 ```
56
57 This generates a PowerDNS Authoritative Server binary with no modules built in.
58
59 When `./configure` is run without `--with-modules`, the bind and gmysql module are
60 built-in by default and the pipe-backend is compiled for runtime loading.
61
62 To add multiple modules, try:
63
64 ```
65 $ ./configure --with-modules="bind gmysql gpgsql"
66 ```
67
68 Note that you will need the development headers for PostgreSQL as well in this case.
69
70 See https://doc.powerdns.com/md/appendix/compiling-powerdns/ for more details.
71
72 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.
73
74 On macOS, you may need to `brew install openssl` and set `PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig` during configure.
75
76 COMPILING THE RECURSOR
77 ----------------------
78 See the README in pdns/recursordist.
79
80 COMPILING DNSDIST
81 ----------------------
82 See the README in pdns/dnsdistdist.
83
84 SOLARIS NOTES
85 -------------
86 Use a recent gcc. OpenCSW is a good source, as is Solaris 11 IPS.
87
88 If you encounter problems with the Solaris make, gmake is advised.
89
90 FREEBSD NOTES
91 -------------
92 You need to compile using gmake - regular make only appears to work, but doesn't in fact. Use gmake, not make.
93
94 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.
95
96 export CXXFLAGS=-std=c++11
97
98 MAC OS X NOTES
99 --------------
100 PowerDNS Authoritative Server is available through Homebrew:
101
102 ```
103 $ brew install pdns
104 ```
105
106 If you want to compile yourself, the dependencies can be installed using
107 Homebrew:
108
109 ```
110 $ brew install boost lua pkg-config ragel
111 ```
112
113 For PostgreSQL support:
114
115 ```
116 $ brew install postgresql
117 ```
118
119 For MySQL support:
120
121 ```
122 $ brew install mariadb
123 ```
124
125 LINUX NOTES
126 -----------
127 None really.