xref: /freebsd/contrib/ldns/README (revision aa24f48b361effe51163877d84f1b70d32b77e04)
1
2Contents:
3	REQUIREMENTS
4	INSTALLATION
5		libdns
6		examples
7		drill
8	INFORMATION FOR SPECIFIC OPERATING SYSTEMS
9		Mac OS X
10		Solaris
11	KNOWN ISSUES
12		pyldns
13        Your Support
14
15Project page:
16http://www.nlnetlabs.nl/ldns/
17On that page you can also subscribe to the ldns mailing list.
18
19* Development
20ldns is mainly developed on Linux and FreeBSD. It is regularly tested to
21compile on other systems like Solaris and Mac OS X.
22
23REQUIREMENTS
24- OpenSSL (Optional, but needed for features like DNSSEC)
25  - OpenSSL >= 0.9.7f for DANE support
26  - OpenSSL >= 1.0.0  for ECDSA and GOST support
27- libpcap (Optional, but needed for examples/ldns-dpa)
28- (GNU) libtool (in OSX, that's glibtool, not libtool)
29- GNU make
30
31INSTALLATION
321. Unpack the tarball
332. cd ldns-<VERSION>
343. ./configure --with-examples --with-drill
35   (optionally compile python bindings too with: --with-pyldns)
364. make
375. make install
38
39
40* Building from repository
41
42If you are building from the repository you will need to have (gnu)
43autotools like libtool and autoreconf installed. A list of all the commands
44needed to build everything can be found in README.git. Note that the actual
45commands may be a little bit different on your machine. Most notable, you'll need to run libtoolize (or glibtoolize), if you skip this step, you'll get an error about missing config.sub.
46
47* Developers
48ldns is developed by the ldns team at NLnet Labs. This team currently
49consists of:
50  o Willem Toorop
51  o Wouter Wijngaards
52  o Matthijs Mekking
53
54Former main developers:
55  o Jelte Jansen
56  o Miek Gieben
57
58* Credits
59We have received patches from the following people, thanks!
60  o Bedrich Kosata
61  o Erik Rozendaal
62  o Håkan Olsson
63  o Jakob Schlyter
64  o Paul Wouters
65  o Simon Vallet
66  o Ondřej Surý
67  o Karel Slany
68  o Havard Eidnes
69  o Leo Baltus
70  o Dag-Erling Smørgrav
71
72
73INFORMATION FOR SPECIFIC OPERATING SYSTEMS
74
75MAC OS X
76
77For MACOSX 10.4 and later, it seems that you have to set the
78MACOSX_DEPLOYMENT_TARGET environment variable to 10.4 before running
79make. Apparently it defaults to 10.1.
80
81This appears to be a known problem in 10.2 to 10.4, see:
82http://developer.apple.com/qa/qa2001/qa1233.html
83for more information.
84
85
86SOLARIS
87
88In Solaris multi-architecture systems (that have both 32-bit and
8964-bit support), it can be a bit taxing to convince the system to
90compile in 64-bit mode. Jakob Schlyter has kindly contributed a build
91script that sets the right build and link options. You can find it in
92contrib/build-solaris.sh
93
94KNOWN ISSUES
95
96A complete list of currently known open issues can be found here:
97http://www.nlnetlabs.nl/projects/ldns/bugs
98
99* pyldns
100Compiling pyldns produces many ``unused parameter'' warnings.  Those are
101harmless and may safely be ignored.
102Also when building with Swig which version is before 2.0.4, compiling
103pyldns produces many ``missing initializer'' warnings. Those are harmless
104too.
105
106Your Support
107NLnet Labs offers all of its software products as open source, most are
108published under a BDS license. You can download them, not only from the
109NLnet Labs website but also through the various OS distributions for
110which NSD, ldns, and Unbound are packaged. We therefore have little idea
111who uses our software in production environments and have no direct ties
112with 'our customers'.
113
114Therefore, we ask you to contact us at users@NLnetLabs.nl and tell us
115whether you use one of our products in your production environment,
116what that environment looks like, and maybe even share some praise.
117We would like to refer to the fact that your organization is using our
118products. We will only do that if you explicitly allow us. In all other
119cases we will keep the information you share with us to ourselves.
120
121In addition to the moral support you can also support us
122financially. NLnet Labs is a recognized not-for-profit charity foundation
123that is chartered to develop open-source software and open-standards
124for the Internet. If you use our software to satisfaction please express
125that by giving us a donation. For small donations PayPal can be used. For
126larger and regular donations please contact us at users@NLnetLabs.nl. Also
127see http://www.nlnetlabs.nl/labs/contributors/.
128
129