]> git.ipfire.org Git - thirdparty/dhcp.git/blame - README
- Documentation cleanup
[thirdparty/dhcp.git] / README
CommitLineData
91da194e 1 Internet Systems Consortium DHCP Distribution
adbef119
DH
2 Version 4.2.0
3 21 December 2012
4650dc25 4
98311e4b 5 README FILE
4650dc25
TL
6
7You should read this file carefully before trying to install or use
8the ISC DHCP Distribution.
9
10 TABLE OF CONTENTS
11
12 1 WHERE TO FIND DOCUMENTATION
13 2 RELEASE STATUS
14 3 BUILDING THE DHCP DISTRIBUTION
986bf898
TL
15 3.1 UNPACKING IT
16 3.2 CONFIGURING IT
17 3.2.1 DYNAMIC DNS UPDATES
38793a26 18 3.2.2 LOCALLY DEFINED OPTIONS
986bf898 19 3.3 BUILDING IT
4650dc25
TL
20 4 INSTALLING THE DHCP DISTRIBUTION
21 5 USING THE DHCP DISTRIBUTION
da411127
TL
22 5.1 FIREWALL RULES
23 5.2 LINUX
24 5.2.1 IF_TR.H NOT FOUND
25 5.2.2 SO_ATTACH_FILTER UNDECLARED
26 5.2.3 PROTOCOL NOT CONFIGURED
27 5.2.4 BROADCAST
28 5.2.6 IP BOOTP AGENT
29 5.2.7 MULTIPLE INTERFACES
30 5.3 SCO
31 5.4 HP-UX
32 5.5 ULTRIX
33 5.6 FreeBSD
34 5.7 NeXTSTEP
35 5.8 SOLARIS
236d3a99
DH
36 5.9 AIX
37 5.10 MacOS X
4650dc25 38 6 SUPPORT
986bf898 39 6.1 HOW TO REPORT BUGS
4650dc25
TL
40
41 WHERE TO FIND DOCUMENTATION
2d1b06e0
TL
42
43Documentation for this software includes this README file, the
44RELNOTES file, and the manual pages, which are in the server, common,
da411127
TL
45client and relay subdirectories. The README file (this file) includes
46late-breaking operational and system-specific information that you
47should read even if you don't want to read the manual pages, and that
48you should *certainly* read if you run into trouble. Internet
802fdea1
TM
49standards relating to the DHCP protocol are listed in the References
50document that is available in html, txt and xml formats in doc/
da411127
TL
51subdirectory. You will have the best luck reading the manual pages if
52you build this software and then install it, although you can read
53them directly out of the distribution if you need to.
2d1b06e0
TL
54
55DHCP server documentation is in the dhcpd man page. Information about
56the DHCP server lease database is in the dhcpd.leases man page.
57Server configuration documentation is in the dhcpd.conf man page as
58well as the dhcp-options man page. A sample DHCP server
4650dc25
TL
59configuration is in the file server/dhcpd.conf. The source for the
60dhcpd, dhcpd.leases and dhcpd.conf man pages is in the server/ sub-
61directory in the distribution. The source for the dhcp-options.5
62man page is in the common/ subdirectory.
2d1b06e0
TL
63
64DHCP Client documentation is in the dhclient man page. DHCP client
65configuration documentation is in the dhclient.conf man page and the
66dhcp-options man page. The DHCP client configuration script is
67documented in the dhclient-script man page. The format of the DHCP
68client lease database is documented in the dhclient.leases man page.
4650dc25
TL
69The source for all these man pages is in the client/ subdirectory in
70the distribution. In addition, the dhcp-options man page should be
71referred to for information about DHCP options.
2d1b06e0 72
4650dc25
TL
73DHCP relay agent documentation is in the dhcrelay man page, the source
74for which is distributed in the relay/ subdirectory.
2d1b06e0
TL
75
76To read installed manual pages, use the man command. Type "man page"
4650dc25
TL
77where page is the name of the manual page. This will only work if
78you have installed the ISC DHCP distribution using the ``make install''
79command (described later).
2d1b06e0
TL
80
81If you want to read manual pages that aren't installed, you can type
82``nroff -man page |more'' where page is the filename of the
83unformatted manual page. The filename of an unformatted manual page
84is the name of the manual page, followed by '.', followed by some
85number - 5 for documentation about files, and 8 for documentation
4650dc25
TL
86about programs. For example, to read the dhcp-options man page,
87you would type ``nroff -man common/dhcp-options.5 |more'', assuming
88your current working directory is the top level directory of the ISC
89DHCP Distribution.
2d1b06e0 90
e021c50c
DH
91Please note that the pathnames of files to which our manpages refer
92will not be correct for your operating system until after you iterate
93'make install' (so if you're reading a manpage out of the source
94directory, it may not have up-to-date information).
2d1b06e0
TL
95
96 RELEASE STATUS
97
95bba8b6 98This is ISC DHCP 4.2.0, which modifies the DDNS code to be asynchronous.
4650dc25 99
fe5b0fdd
DH
100In this release, the DHCPv6 server should be fully functional on Linux,
101Solaris, or any BSD. The DHCPv6 client should be similarly functional
102except on Solaris.
26833160 103
fe5b0fdd
DH
104The DHCPv4 server, relay, and client, should be fully functional
105on Linux, Solaris, any BSD, HPUX, SCO, NextSTEP, and Irix.
26833160 106
da411127
TL
107If you are running the DHCP distribution on a machine which is a
108firewall, or if there is a firewall between your DHCP server(s) and
109DHCP clients, please read the section on firewalls which appears later
110in this document.
111
26833160 112If you wish to run the DHCP Distribution on Linux, please see the
3dcbf508 113Linux-specific notes later in this document. If you wish to run on an
26833160
TL
114SCO release, please see the SCO-specific notes later in this document.
115You particularly need to read these notes if you intend to support
802fdea1
TM
116Windows 95 clients. If you are running HP-UX or Ultrix, please read the
117notes for those operating systems below. If you are running NeXTSTEP,
118please see the notes on NeXTSTEP below.
26833160 119
aa857ee0
TL
120If you start dhcpd and get a message, "no free bpf", that means you
121need to configure the Berkeley Packet Filter into your operating
122system kernel. On NetBSD, FreeBSD and BSD/os, type ``man bpf'' for
123information. On Digital Unix, type ``man pfilt''.
124
a8f3586f 125
26833160
TL
126 BUILDING THE DHCP DISTRIBUTION
127
986bf898
TL
128 UNPACKING IT
129
1409f290
TL
130To build the DHCP Distribution, unpack the compressed tar file using
131the tar utility and the gzip command - type something like:
132
95bba8b6
SR
133 gunzip dhcp-4.2.0.tar.gz
134 tar xvf dhcp-4.2.0.tar
98bf1607 135
986bf898
TL
136 CONFIGURING IT
137
95bba8b6 138Now, cd to the dhcp-4.2.0 subdirectory that you've just created and
6b911c86 139configure the source tree by typing:
1409f290 140
98311e4b 141 ./configure
1409f290
TL
142
143If the configure utility can figure out what sort of system you're
144running on, it will create a custom Makefile for you for that
145system; otherwise, it will complain. If it can't figure out what
146system you are using, that system is not supported - you are on
147your own.
148
986bf898
TL
149 DYNAMIC DNS UPDATES
150
da411127 151A fully-featured implementation of dynamic DNS updates is included in
98bf1607 152this release. It uses libraries from BIND and, to avoid issues with
95bba8b6
SR
153different versions, includes the necessary BIND version. The appropriate
154BIND libraries will be compiled and installed in the bind subdirectory
155as part of the make step. In order to build the necessary libraries you
156will need to have "gmake" available on your build system.
157
986bf898 158
6b3d9544
TL
159There is documentation for the DDNS support in the dhcpd.conf manual
160page - see the beginning of this document for information on finding
161manual pages.
986bf898 162
38793a26
TL
163 LOCALLY DEFINED OPTIONS
164
165In previous versions of the DHCP server there was a mechanism whereby
166options that were not known by the server could be configured using
167a name made up of the option code number and an identifier:
168"option-nnn" This is no longer supported, because it is not future-
169proof. Instead, if you want to use an option that the server doesn't
170know about, you must explicitly define it using the method described
171in the dhcp-options man page under the DEFINING NEW OPTIONS heading.
172
986bf898
TL
173 BUILDING IT
174
1409f290
TL
175Once you've run configure, just type ``make'', and after a while
176you should have a dhcp server. If you get compile errors on one
177of the supported systems mentioned earlier, please let us know.
178If you get warnings, it's not likely to be a problem - the DHCP
179server compiles completely warning-free on as many architectures
180as we can manage, but there are a few for which this is difficult.
181If you get errors on a system not mentioned above, you will need
182to do some programming or debugging on your own to get the DHCP
183Distribution working.
26833160 184
4650dc25
TL
185 INSTALLING THE DHCP DISTRIBUTION
186
68c039d3
TL
187Once you have successfully gotten the DHCP Distribution to build, you
188can install it by typing ``make install''. If you already have an old
189version of the DHCP Distribution installed, you may want to save it
190before typing ``make install''.
3dcbf508 191
4650dc25
TL
192 USING THE DHCP DISTRIBUTION
193
da411127
TL
194 FIREWALL RULES
195
196If you are running the DHCP server or client on a computer that's also
197acting as a firewall, you must be sure to allow DHCP packets through
198the firewall. In particular, your firewall rules _must_ allow packets
199from IP address 0.0.0.0 to IP address 255.255.255.255 from UDP port 68
200to UDP port 67 through. They must also allow packets from your local
201firewall's IP address and UDP port 67 through to any address your DHCP
202server might serve on UDP port 68. Finally, packets from relay agents
203on port 67 to the DHCP server on port 67, and vice versa, must be
204permitted.
205
206We have noticed that on some systems where we are using a packet
207filter, if you set up a firewall that blocks UDP port 67 and 68
208entirely, packets sent through the packet filter will not be blocked.
209However, unicast packets will be blocked. This can result in strange
210behaviour, particularly on DHCP clients, where the initial packet
211exchange is broadcast, but renewals are unicast - the client will
212appear to be unable to renew until it starts broadcasting its
213renewals, and then suddenly it'll work. The fix is to fix the
214firewall rules as described above.
215
216 PARTIAL SERVERS
217
218If you have a server that is connected to two networks, and you only
219want to provide DHCP service on one of those networks (e.g., you are
220using a cable modem and have set up a NAT router), if you don't write
221any subnet declaration for the network you aren't supporting, the DHCP
222server will ignore input on that network interface if it can. If it
223can't, it will refuse to run - some operating systems do not have the
224capability of supporting DHCP on machines with more than one
225interface, and ironically this is the case even if you don't want to
226provide DHCP service on one of those interfaces.
227
26833160
TL
228 LINUX
229
6da19769
TL
230There are three big LINUX issues: the all-ones broadcast address,
231Linux 2.1 ip_bootp_agent enabling, and operations with more than one
3dcbf508
TL
232network interface. There are also two potential compilation/runtime
233problems for Linux 2.1/2.2: the "SO_ATTACH_FILTER undeclared" problem
234and the "protocol not configured" problem.
235
3dcbf508
TL
236 LINUX: PROTOCOL NOT CONFIGURED
237
e021c50c
DH
238If you get the following message, it's because your kernel doesn't
239have the linux packetfilter or raw packet socket configured:
3dcbf508 240
c87fcde1
TL
241 Make sure CONFIG_PACKET (Packet socket) and CONFIG_FILTER (Socket
242 Filtering) are enabled in your kernel configuration
243
244If this happens, you need to configure your Linux kernel to support
e021c50c
DH
245Socket Filtering and the Packet socket, or to select a kernel provided
246by your Linux distribution that has these enabled (virtually all modern
247ones do by default).
2a1ebeee 248
3dcbf508 249 LINUX: BROADCAST
2a1ebeee 250
da411127
TL
251If you are running a recent version of Linux, this won't be a problem,
252but on older versions of Linux (kernel versions prior to 2.2), there
253is a potential problem with the broadcast address being sent
254incorrectly.
255
26833160
TL
256In order for dhcpd to work correctly with picky DHCP clients (e.g.,
257Windows 95), it must be able to send packets with an IP destination
4650dc25
TL
258address of 255.255.255.255. Unfortunately, Linux changes an IP
259destination of 255.255.255.255 into the local subnet broadcast address
da411127
TL
260(here, that's 192.5.5.223).
261
262This isn't generally a problem on Linux 2.2 and later kernels, since
263we completely bypass the Linux IP stack, but on old versions of Linux
2642.1 and all versions of Linux prior to 2.1, it is a problem - pickier
265DHCP clients connected to the same network as the ISC DHCP server or
266ISC relay agent will not see messages from the DHCP server. It *is*
267possible to run into trouble with this on Linux 2.2 and later if you
268are running a verson of the DHCP server that was compiled on a Linux
2692.0 system, though.
7751e60d 270
26833160
TL
271It is possible to work around this problem on some versions of Linux
272by creating a host route from your network interface address to
273255.255.255.255. The command you need to use to do this on Linux
274varies from version to version. The easiest version is:
7751e60d 275
26833160 276 route add -host 255.255.255.255 dev eth0
7751e60d 277
26833160
TL
278On some older Linux systems, you will get an error if you try to do
279this. On those systems, try adding the following entry to your
280/etc/hosts file:
7751e60d 281
26833160 282255.255.255.255 all-ones
7751e60d 283
26833160 284Then, try:
7751e60d 285
26833160 286 route add -host all-ones dev eth0
7751e60d 287
26833160 288Another route that has worked for some users is:
7751e60d 289
26833160 290 route add -net 255.255.255.0 dev eth0
471fe68c 291
26833160
TL
292If you are not using eth0 as your network interface, you should
293specify the network interface you *are* using in your route command.
a8b53b42 294
3dcbf508 295 LINUX: IP BOOTP AGENT
6da19769
TL
296
297Some versions of the Linux 2.1 kernel apparently prevent dhcpd from
298working unless you enable it by doing the following:
299
300 echo 1 >/proc/sys/net/ipv4/ip_bootp_agent
301
302
3dcbf508 303 LINUX: MULTIPLE INTERFACES
2a1ebeee 304
4650dc25
TL
305Very old versions of the Linux kernel do not provide a networking API
306that allows dhcpd to operate correctly if the system has more than one
307broadcast network interface. However, Linux 2.0 kernels with version
308numbers greater than or equal to 2.0.31 add an API feature: the
309SO_BINDTODEVICE socket option. If SO_BINDTODEVICE is present, it is
310possible for dhcpd to operate on Linux with more than one network
cd977bed 311interface. In order to take advantage of this, you must be running a
3dcbf508
TL
3122.0.31 or greater kernel, and you must have 2.0.31 or later system
313headers installed *before* you build the DHCP Distribution.
2a1ebeee 314
cd977bed
TL
315We have heard reports that you must still add routes to 255.255.255.255
316in order for the all-ones broadcast to work, even on 2.0.31 kernels.
317In fact, you now need to add a route for each interface. Hopefully
318the Linux kernel gurus will get this straight eventually.
319
4650dc25
TL
320Linux 2.1 and later kernels do not use SO_BINDTODEVICE or require the
321broadcast address hack, but do support multiple interfaces, using the
322Linux Packet Filter.
323
09c6b1cf
PS
324 LINUX: OpenWrt
325
113e193f
PS
326DHCP 4.1 has been tested on OpenWrt 7.09 and 8.09. In keeping with
327standard practice, client/scripts now includes a dhclient-script file
328for OpenWrt. However, this is not sufficient by itself to run dhcp on
329OpenWrt; a full OpenWrt package for DHCP is available at
330ftp://ftp.isc.org/isc/dhcp/dhcp-4.1.0-openwrt.tar.gz
09c6b1cf 331
88cd8aca
DH
332 LINUX: 802.1q VLAN INTERFACES
333
334If you're using 802.1q vlan interfaces on Linux, it is necessary to
335vconfig the subinterface(s) to rewrite the 802.1q information out of
336packets received by the dhcpd daemon via LPF:
337
338 vconfig set_flag eth1.523 1 1
339
340Note that this may affect the performance of your system, since the
341Linux kernel must rewrite packets received via this interface. For
342more information, consult the vconfig man pages.
343
26833160 344 SCO
a8b53b42 345
41e45067
DH
346ISC DHCP will now work correctly on newer versions of SCO out of the
347box (tested on OpenServer 5.05b, assumed to work on UnixWare 7).
a8b53b42 348
45d545f0 349Older versions of SCO have the same problem as Linux (described earlier).
41e45067
DH
350The thing is, SCO *really* doesn't want to let you add a host route to
351the all-ones broadcast address.
352
353You can try the following:
fcebfc39
TL
354
355 ifconfig net0 xxx.xxx.xxx.xxx netmask 0xNNNNNNNN broadcast 255.255.255.255
356
357If this doesn't work, you can also try the following strange hack:
358
359 ifconfig net0 alias 10.1.1.1 netmask 8.0.0.0
a8b53b42 360
26833160
TL
361Apparently this works because of an interaction between SCO's support
362for network classes and the weird netmask. The 10.* network is just a
363dummy that can generally be assumed to be safe. Don't ask why this
41e45067 364works. Just try it. If it works for you, great.
a8b53b42 365
26833160
TL
366 HP-UX
367
368HP-UX has the same problem with the all-ones broadcast address that
aa857ee0
TL
369SCO and Linux have. One user reported that adding the following to
370/etc/rc.config.d/netconf helped (you may have to modify this to suit
371your local configuration):
372
373INTERFACE_NAME[0]=lan0
374IP_ADDRESS[0]=1.1.1.1
375SUBNET_MASK[0]=255.255.255.0
376BROADCAST_ADDRESS[0]="255.255.255.255"
377LANCONFIG_ARGS[0]="ether"
378DHCP_ENABLE[0]=0
26833160
TL
379
380 ULTRIX
381
382Now that we have Ultrix packet filter support, the DHCP Distribution
383on Ultrix should be pretty trouble-free. However, one thing you do
384need to be aware of is that it now requires that the pfilt device be
385configured into your kernel and present in /dev. If you type ``man
386packetfilter'', you will get some information on how to configure your
387kernel for the packet filter (if it isn't already) and how to make an
388entry for it in /dev.
389
390 FreeBSD
391
392Versions of FreeBSD prior to 2.2 have a bug in BPF support in that the
393ethernet driver swaps the ethertype field in the ethernet header
394downstream from BPF, which corrupts the output packet. If you are
395running a version of FreeBSD prior to 2.2, and you find that dhcpd
396can't communicate with its clients, you should #define BROKEN_FREEBSD_BPF
397in site.h and recompile.
a8b53b42 398
98311e4b
DH
399Modern versions of FreeBSD include the ISC DHCP 3.0 client as part of
400the base system, and the full distribution (for the DHCP server and
401relay agent) is available from the Ports Collection in
402/usr/ports/net/isc-dhcp3, or as a package on FreeBSD installation
403CDROMs.
404
adbef119 405 NeXTSTEP
a8f3586f
TL
406
407The NeXTSTEP support uses the NeXTSTEP Berkeley Packet Filter
cd977bed
TL
408extension, which is not included in the base NextStep system. You
409must install this extension in order to get dhcpd or dhclient to work.
a8f3586f 410
3dcbf508
TL
411 SOLARIS
412
e950a7be
SR
413There are two known issues seen when compiling using the Sun compiler.
414
415The first is that older Sun compilers generate an error on some of
416our uses of the flexible array option. Newer versions only generate
417a warning, which can be safely ignored. If you run into this error
418("type of struct member "buf" can not be derived from structure with
419flexible array member"), upgrade your tools to Sun Studio 12 or
420something newer.
421
422The second is the interaction between the configure script and the
423makefiles for the Bind libraries. Currently we don't pass all
424environment variables between the DHCP configure and the Bind configure.
425
426If you attempt to specify the compiler you wish to use like this:
427
428 CC=/opt/SUNWspro/bin/cc ./configure
429
430"make" may not build the Bind libraries with that compiler.
431
432In order to use the same compiler for Bind and DHCP we suggest the
433following commands:
434
435 CC=/opt/SUNWspro/bin/cc ./configure
436 CC=/opt/SUNWspro/bin/cc make
437
ce53cc84
TL
438One problem which has been observed and is not fixed in this
439patchlevel has to do with using DLPI on Solaris machines. The symptom
440of this problem is that the DHCP server never receives any requests.
35eb3023
TL
441This has been observed with Solaris 2.6 and Solaris 7 on Intel x86
442systems, although it may occur with other systems as well. If you
443encounter this symptom, and you are running the DHCP server on a
444machine with a single broadcast network interface, you may wish to
445edit the includes/site.h file and uncomment the #define USE_SOCKETS
88cd8aca
DH
446line. Then type ``make clean; make''. As an alternative workaround,
447it has been reported that running 'snoop' will cause the dhcp server
448to start receiving packets. So the practice reported to us is to run
449snoop at dhcpd startup time, with arguments to cause it to receive one
450packet and exit.
451
452 snoop -c 1 udp port 67 > /dev/null &
ce53cc84
TL
453
454The DHCP client on Solaris will only work with DLPI. If you run it
455and it just keeps saying it's sending DHCPREQUEST packets, but never
456gets a response, you may be having DLPI trouble as described above.
88cd8aca
DH
457If so, we have no solution to offer at this time, aside from the above
458workaround which should also work here. Also, because Solaris requires
459you to "plumb" an interface before it can be detected by the DHCP client,
460you must either specify the name(s) of the interface(s) you want to
461configure on the command line, or must plumb the interfaces prior to
462invoking the DHCP client. This can be done with ``ifconfig iface plumb'',
463where iface is the name of the interface (e.g., ``ifconfig hme0 plumb'').
ce53cc84
TL
464
465It should be noted that Solaris versions from 2.6 onward include a
466DHCP client that you can run with ``/sbin/ifconfig iface dhcp start''
786b0930
DH
467rather than using the ISC DHCP client, including DHCPv6. Consequently,
468we don't believe there is a need for the client to run on Solaris, and
469have not engineered the needed DHCPv6 modifications for the dhclient-script.
470If you feel this is in error, or have a need, please contact us.
3dcbf508 471
98311e4b
DH
472 AIX
473
474The AIX support uses the BSD socket API, which cannot differentiate on
475which network interface a broadcast packet was received; thus the DHCP
476server and relay will work only on a single interface. (They do work
477on multi-interface machines if configured to listen on only one of the
478interfaces.)
479
fc06ee4f
SR
480We have reports of Windows XP clients having difficutly retrieving
481addresses from a server running on an AIX machine. This issue
482was traced to the client requiring messages be sent to the all ones
483broadcast address (255.255.255.255) while the AIX server was sending
484to 192.168.0.255.
485
486You may be able to solve this by including a relay between the client
487and server with the relay configured to use a broadcast of all-ones.
488
489A second option that worked for AIX 5.1 but doesn't seem to work for
490AIX 5.3 was to:
491 create a host file entry for all-ones (255.255.255.255)
492and then add a route:
493 route add -host all-ones -interface <local-ip-address>
494
98311e4b
DH
495The ISC DHCP distribution does not include a dhclient-script for AIX--
496AIX comes with a DHCP client. Contribution of a working dhclient-script
497for AIX would be welcome.
498
fc06ee4f 499
236d3a99
DH
500 MacOS X
501
502The MacOS X system uses a TCP/IP stack derived from FreeBSD with a
503user-friendly interface named the System Configuration Framework.
504As it includes a builtin DHCPv4 client (you are better just using that),
505this text is only about the DHCPv6 client (``dhclient -6 ...''). The DNS
506configuration (domain search list and name servers' addresses) is managed
507by a System Configuration agent, not by /etc/resolv.conf (which is a link
508to /var/run/resolv.conf, which itself only reflects the internal state;
509the System Configuration agent's Dynamic Store).
510
511This means that modifying resolv.conf directly doesn't have the intended
512effect, so the macos script sample uses its own resolv.conf.dhclient6 in
513/var/run, and inserts the contents of this file into the System
514Configuration agent. Because the System Configuration agent expects the
515prefix along with the configured address, and a default router, this is
516not usable (the DHCPv6 protocol does not today deliver this information).
517Instead, ifconfig is directly used for address configuration.
518
519Note the Dynamic Store (from which /var/run/resolv.conf is built) is
520recomputed from scratch when the current location/set is changed, for
521instance when a laptop is resumed from sleep. In this case running the
522dhclient-script could reinstall the resolv.conf.dhclient6 configuration.
523
f76ebbfd
TL
524 SUPPORT
525
98311e4b
DH
526The Internet Systems Consortium DHCP server is developed and distributed
527by ISC in the public trust, thanks to the generous donations of its
e021c50c 528sponsors. ISC now also offers commercial quality support contracts for
98311e4b
DH
529ISC DHCP, more information about ISC Support Contracts can be found at
530the following URL:
531
2c85ac9b 532 https://www.isc.org/services/support/
98311e4b 533
e021c50c
DH
534Please understand that we may not respond to support inquiries unless
535you have a support contract. ISC will continue its practice of always
536responding to critical items that effect the entire community, and
537responding to all other requests for support upon ISC's mailing lists
538on a best-effort basis.
98311e4b
DH
539
540However, ISC DHCP has attracted a fairly sizable following on the
45d545f0 541Internet, which means that there are a lot of knowledgeable users who
e021c50c
DH
542may be able to help you if you get stuck. These people generally
543read the dhcp-users@isc.org mailing list. Be sure to provide as much
544detail in your query as possible.
0cd69353 545
e021c50c
DH
546If you are going to use ISC DHCP, you should probably subscribe to
547the dhcp-users or dhcp-announce mailing lists.
da411127 548
98311e4b
DH
549WHERE TO SEND FEATURE REQUESTS: We like to hear your feedback. We may
550not respond to it all the time, but we do read it. If ISC DHCP doesn't
551work well for you, or you have an idea that would improve it for your
552use, please send your suggestion to dhcp-suggest@isc.org. This is also
553an excellent place to send patches that add new features.
554
e021ce5c
TL
555WHERE TO REPORT BUGS: If you want the act of sending in a bug report
556to result in you getting help in the form of a fixed piece of
557software, you are asking for help. Your bug report is helpful to us,
558but fundamentally you are making a support request, so please use the
1ad180b1
TL
559addresses described in the previous paragraphs. If you are _sure_ that
560your problem is a bug, and not user error, or if your bug report
e021c50c
DH
561includes a patch, you can send it to our ticketing system at
562dhcp-bugs@isc.org. If you have not received a notice that the ticket
563has been resolved, then we're still working on it.
e021ce5c 564
da411127
TL
565PLEASE DO NOT REPORT BUGS IN OLD SOFTWARE RELEASES! Fetch the latest
566release and see if the bug is still in that version of the software,
802fdea1
TM
567and if it is still present, _then_ report it. ISC release versions
568always have three numbers, for example: 1.2.3. The 'major release' is
5691 here, the 'minor release' is 2, and the 'maintenance release' is 3.
570ISC will accept bug reports against the most recent two major.minor
e021c50c
DH
571releases: for example, 1.0.0 and 0.9.0, but not 0.8.* or prior.
572
573PLEASE take a moment to determine where the ISC DHCP distribution
574that you're using came from. ISC DHCP is sometimes heavily modified
575by integrators in various operating systems - it's not that we
576feel that our software is perfect and incapable of having bugs, but
577rather that it is very frustrating to find out after many days trying
578to help someone that the sources you're looking at aren't what they're
579running. When in doubt, please retrieve the source distribution from
580ISC's web page and install it.
0cd69353 581
e021ce5c 582 HOW TO REPORT BUGS OR REQUEST HELP
4650dc25 583
da411127
TL
584When you report bugs or ask for help, please provide us complete
585information. A list of information we need follows. Please read it
586carefully, and put all the information you can into your initial bug
e021c50c
DH
587report. This will save us a great deal of time and more informative
588bug reports are more likely to get handled more quickly overall.
0cd69353 589
1ad180b1 590 1. The specific operating system name and version of the
adbef119 591 machine on which the DHCP server or client is running.
1ad180b1 592 2. The specific operating system name and version of the
adbef119
DH
593 machine on which the client is running, if you are having
594 trouble getting a client working with the server.
1ad180b1 595 3. If you're running Linux, the version number we care about is
adbef119
DH
596 the kernel version and maybe the library version, not the
597 distribution version - e.g., while we don't mind knowing
598 that you're running Redhat version mumble.foo, we must know
599 what kernel version you're running, and it helps if you can
600 tell us what version of the C library you're running,
601 although if you don't know that off the top of your head it
602 may be hard for you to figure it out, so don't go crazy
603 trying.
1ad180b1 604 4. The specific version of the DHCP distribution you're
adbef119 605 running, as reported by dhcpd -t.
1ad180b1 606 5. Please explain the problem carefully, thinking through what
adbef119
DH
607 you're saying to ensure that you don't assume we know
608 something about your situation that we don't know.
e021c50c
DH
609 6. Include your dhcpd.conf and dhcpd.leases file as MIME attachments
610 if they're not over 100 kilobytes in size each. If they are
611 this large, please make them available to us eg via a hidden
612 http:// URL or FTP site. If you're not comfortable releasing
613 this information due to sensitive contents, you may encrypt
614 the file to our release signing key, available on our website.
1ad180b1 615 7. Include a log of your server or client running until it
adbef119
DH
616 encounters the problem - for example, if you are having
617 trouble getting some client to get an address, restart the
618 server with the -d flag and then restart the client, and
619 send us what the server prints. Likewise, with the client,
620 include the output of the client as it fails to get an
621 address or otherwise does the wrong thing. Do not leave
622 out parts of the output that you think aren't interesting.
1ad180b1 623 8. If the client or server is dumping core, please run the
adbef119
DH
624 debugger and get a stack trace, and include that in your
625 bug report. For example, if your debugger is gdb, do the
626 following:
0cd69353
TL
627
628 gdb dhcpd dhcpd.core
629 (gdb) where
630 [...]
631 (gdb) quit
632
633 This assumes that it's the dhcp server you're debugging, and
634 that the core file is in dhcpd.core.
cd977bed 635
2c85ac9b 636Please see https://www.isc.org/software/dhcp/ for details on how to subscribe
98311e4b 637to the ISC DHCP mailing lists.
da411127 638