xref: /freebsd/libexec/bootpd/README (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1
2This is an enhanced version of the CMU BOOTP server which was derived
3from the original BOOTP server created by Bill Croft at Stanford.
4This version merges all the enhancements and bug-fixes from the
5NetBSD, Columbia, and other versions.
6
7Please direct questions, comments, and bug reports to the list:
8	<bootp@andrew.cmu.edu>
9
10You can subscribe to this mailing list by sending mail to:
11	bootp-request@andrew.cmu.edu
12(The body of the message should contain: "Add <your-address>")
13
14[ From the NetBSD README file: ]
15
16BOOTPD is a useful adjunct to the nfs diskless boot EPROM code.
17
18The alternatives for initiating a boot of a kernel across a network
19are to use RARP protocol, or BOOTP protocol. BOOTP is more flexible;
20it allows additional items of information to be returned to the
21booting client; it also supports booting across gateways.
22
23[ From the CMU README file: ]
24
25Notes:
261) BOOTP was originally designed and implemented by Bill Croft at Stanford.
27   Much of the credit for the ideas and the code goes to him.  We've added
28   code to support the vendor specific area of the packet as specified in
29   RFC1048.  We've also improved the host lookup algorithm and added some
30   extra logging.
31
322) The server now uses syslog to do logging.  Specifically it uses the 4.3bsd
33   version.  I've #ifdef'd all of these calls.  If you are running 4.2 you
34   should compile without the -DSYSLOG switch.
35
363) You must update your /etc/services file to contain the following two lines:
37	bootps		67/udp		bootp		# BOOTP Server
38	bootpc		68/udp				# BOOTP Client
39
404) Edit the bootptab.  It has some explanitory comments, and there
41   is a manual entry describing its format (bootptab.5)
42   If you have any questions, just let us know.
43
44Construction:
45    [ See the file Installation which is more up-to-date. -gwr ]
46
47    Make sure all of the files exist first.  If anything is missing,
48    please contact either Walt Wimer or Drew Perkins by E-mail or phone.
49    Addresses and phone numbers are listed below.
50
51    Type 'make'.  The options at present are: -DSYSLOG which enables logging
52    code, -DDEBUG which enables table dumping via signals, and -DVEND_CMU
53    which enables the CMU extensions for CMU PC/IP.
54
55    Edit the bootptab.  The man page and the comments in the file should
56    explain how to go about doing so.  If you have any problems, let me know.
57
58    Type 'make install'.  This should put all of the files in the right place.
59
60    Edit your /etc/rc.local or /etc/inetd.conf file to start up bootpd upon
61    reboot.  The following is a sample /etc/inetd.conf entry:
62	# BOOTP server
63	bootps dgram udp wait root /usr/etc/bootpd bootpd -i
64
65Care and feeding:
66    If you change the interface cards on your host or add new hosts you will
67    need to update /etc/bootptab.  Just edit it as before.  Once you write
68    it back out, bootpd will notice that there is a new copy and will
69    reread it the next time it gets a request.
70
71    If your bootp clients don't get a response then several things might be
72    wrong.  Most often, the entry for that host is not in the database.
73    Check the hardware address and then check the entry and make sure
74    everything is right.  Other problems include the server machine crashing,
75    bad cables, and the like.  If your network is very congested you should
76    try making your bootp clients send additional requests before giving up.
77
78
79November 7, 1988
80
81
82Walter L. Wimer			Drew D. Perkins
83ww0n@andrew.cmu.edu		ddp@andrew.cmu.edu
84(412) 268-6252			(412) 268-8576
85
864910 Forbes Ave
87Pittsburgh, PA  15213
88
89[ Contents description by file: ]
90
91Announce*	Text of release announcements
92Changes  	Change history, reverse chronological
93ConvOldTab.sh	Script to convert old (1.x) bootptab files
94Installation	Instructions for building and installing
95Makefile*	for "make"
96README		This file
97ToDo		Things not yet done
98bootp.h		The protocol header file
99bootpd.8	Manual page for bootpd, boopgw
100bootpd.c	BOOTP server main module
101bootpd.h	 header for above (and others)
102bootpef.8	Manual page for bootpef
103bootpef.c	BOOTP extension file compiler
104bootpgw.c	BOOTP gateway main module
105bootptab.5	A manual describing the bootptab format
106bootptab.cmu	A sample database file for the server
107bootptab.mcs	Another sample from <gwr@mc.com>
108bootptest.8	Manual page for bootptest
109bootptest.c	BOOTP test program (fake client)
110bootptest.h	 header for above
111dovend.c	Vendor Option builder (for bootpd, bootpef)
112dovend.h	 header for above
113dumptab.c	Implements debugging dump for bootpd
114getether.c	For bootptest (not used yet)
115getether.h	 header for above
116getif.c		Get network interface info.
117getif.h		 header for above
118hash.c		The hash table module
119hash.h		 header for above
120hwaddr.c	Hardware address support
121hwaddr.h	 header for above
122lookup.c	Internet Protocol address lookup
123lookup.h	 header for above
124patchlevel.h	Holds version numbers
125print-bootp.c	Prints BOOTP packets (taken from BSD tcpdump)
126readfile.c	The configuration file-reading routines
127readfile.h	 header for above
128report.c	Does syslog-style messages
129report.h	 header for above
130strerror.c	Library errno-to-string (for systems lacking it)
131syslog.conf	Sample config file for syslogd(8)
132syslog.h	For systems that lack syslog(3)
133try*.c		Test programs (for debugging)
134tzone.c		Get timezone offset
135tzone.h		 header for above
136