]> git.ipfire.org Git - thirdparty/pdns.git/blob - README.md
Merge pull request #3882 from Habbie/override-python
[thirdparty/pdns.git] / README.md
1 PowerDNS is copyright © 2002-2016 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 COMPILING THE RECURSOR
73 ----------------------
74 See the README in pdns/recursordist.
75
76 COMPILING DNSDIST
77 ----------------------
78 See the README in pdns/dnsdistdist.
79
80 SOLARIS NOTES
81 -------------
82 Use a recent gcc. OpenCSW is a good source, as is Solaris 11 IPS.
83
84 If you encounter problems with the Solaris make, gmake is advised.
85
86 FREEBSD NOTES
87 -------------
88 You need to compile using gmake - regular make only appears to work, but doesn't in fact. Use gmake, not make.
89
90 MAC OS X NOTES
91 --------------
92 PowerDNS Authoritative Server is available through Homebrew:
93
94 ```
95 $ brew install pdns
96 ```
97
98 If you want to compile yourself, the dependencies can be installed using
99 Homebrew:
100
101 ```
102 $ brew install boost lua pkg-config ragel
103 ```
104
105 For PostgreSQL support:
106
107 ```
108 $ brew install postgresql
109 ```
110
111 For MySQL support:
112
113 ```
114 $ brew install mariadb
115 ```
116
117 LINUX NOTES
118 -----------
119 None really.