Original linux-igd sources from CVS repo:
[igd2-for-linux:wanipconnection2.git] / linuxigd2 / INSTALL
1 Simple Quick Install Guide
2
3 This install guide is simply a quick helper to let people start testing the new
4 version.  It will be replaced soon with more thourough documentation.
5
6 Installation
7 ------------
8
9 This version of the linux-igd is written in C as opposed to previous version 
10 that was written in C++.  This was done at the requests of many embedded 
11 developers, as well as some of our developers.  The upnp sdk we now use
12 from Intel is libupnp-1.3.1, and is written in C as well.  Everything is a 
13 little more uniform now, and should create a smaller, leaner, faster device.
14
15 Step 1 -- Download and install libupnp-1.3.1 source from 
16 http://www.sourceforge.net/projects/upnp.  Please install with source 
17 only as we haven't tested against any precompiled versions.  Also, as 
18 the "make install" doesn't quite work as expected, please follow these 
19 instructions to install it properly.
20
21 (Note: See below regarding installing on Fedora Core 5!)
22
23 1. tar -xvzf libupnp-1.3.1.tar.gz
24 2. cd libupnp-1.3.1
25 3. ./configure
26 4. make
27 5. make install
28
29 This process should install libupnp-1.3.1 to our liking (maybe not 
30 someone else's ;-)
31
32 Step 2 -- Obtain the linux-igd software (if for some reason you're reading 
33 this outside the package you should have already gotten, 
34 http://linux-igd.sourceforge.net)
35
36 1. tar -xvzf linuxigd-1.0.tgz    (or whatever the version you have is, or CVS)
37 2. To compile using the iptables command to manipulate netfilter
38 tables, just say:
39
40    make 
41
42 To compile with libiptc (part of iptables-devel) to manipulte
43 netfilter tables, say: 
44
45    make HAVE_LIBIPTC=1
46
47 If libiptc is installed in a different directory than /usr/lib,
48 e.g. /usr/local/lib, set LIBIPTC_PREFIX:
49
50    make HAVE_LIBIPTC=1 LIBIPTC_PREFIX=/usr/local
51
52 If libupnp is installed in a different directory than /usr/lib, e.g. /usr/local/lib,
53 set LIBUPNP_PREFIX:
54
55    make LIBUPNP_PREFIX=/usr/local
56
57 3. make install                         (if CVS, remove etc/CVS directory, then do)
58
59 This will install linux-igd as /usr/sbin/upnpd. To install somewhere else,
60 set PREFIX:
61
62    make PREFIX=/usr/local install
63
64
65 System Preparation before starting 
66 ----------------------------------
67
68 1. In order for device discovery to function properly, you must add a 
69 multicast route to the internal interface like so:
70
71 # route add -net 239.0.0.0 netmask 255.0.0.0 eth0      (or whatever your internal
72                                                         interface name is - here
73                                                         eth0)
74
75 2. If your internal interface is firewalled, then allow multicast packets, eg:
76
77 # iptables -t filter -I INPUT 1 -s 224.0.0.0/4 -j ACCEPT
78 # iptables -t filter -I INPUT 1 -d 224.0.0.0/4 -j ACCEPT
79
80 -- Also, if you'd like to see debug information, and please do, as it helps us 
81 resolve your conflicts, perform the following steps:
82
83 A. Add the following lines to bottom of your /etc/syslog.conf file
84
85 # UPnP IGD messages
86 local6.!=debug                                          /var/log/messages
87 local6.*                                                /var/log/upnpd
88
89 This will send all non-debug output to /var/log/messages, and all output including
90 debug output to /var/log/upnpd. Modify as you like.
91
92 B.  service syslog restart  
93                  (or on your system, maybe:
94                                  /etc/rc.d/init.d/syslog restart
95                   or 
96                                 killall -HUP syslog
97
98
99 Daemon Startup
100 --------------
101
102 Now you should be ready to run the daemon.  At this time, your FORWARD rule in 
103 iptables should be set to ACCEPT.  We'll add the forwarding rules back right 
104 away, but first someone needs to tell me what they are, my FORWARD is always 
105 accept.
106  
107 Start the daemon with the following:
108
109 upnpd <ext_ifname> <int_ifname>
110
111 Example: upnpd eth1 eth0          -- Where eth1 is my external interface name
112                                          and eth0 is my internal interface name.
113
114 Where the deamon isn't starting correctly, or exiting soon after with an
115 error, you can start it with 'upnpd -f <ext_ifname> <int_ifname>',
116 preventing it daemonizing into the background; error messages will be sent
117 to stderr also - this is good for testing, but don't forget to have the
118 multicast route setup for it to accept multicast requests.
119
120 To check and see if everything starts up ok, in /var/log/debug you should see 
121 a few debug messages followed by Advertisements Sent, and possibly some 
122 GetNATRSIPStatus and other messages.
123
124 Another way to check this is to look in your Windows XP client under Network 
125 Conections.  You should see an Icon for Internet Connection set to enabled 
126 in there.  If for some reason you don't, first try restarting the daemon.  If 
127 this doesn't work post a message to the forums and we'll try to help you.
128
129
130 REMINDERS and THANK YOUS
131 ------------------------
132 Truth is I can't remember everyone to thank, but I especially want to thank 
133 both Henri Manson and Anders Betner for their development and testing work.  
134 Also Eric Wirt, for helping us test, and providing the winning comments for 
135 switching to C, alongside many others contributing patches and help.
136
137 This is a work in progress.  This code is simply released now for others to 
138 help us debug some problems we are having.  Please, help us out by checking 
139 the forums, answering problems, and giving any advice and suggestions you can 
140 to the open source community.
141
142 Thanks a lot to the users, and to the over 10,000 downloads, and countless 
143 CVS checkouts.  If it weren't for the interest in the program, we wouldn't be 
144 touching it (ok maybe i would, when i got bored or something) :-)
145
146 Cheers all
147
148 Dime
149
150
151 -----------------------------------------------------------------------
152 Notes: Installing on Fedora Core 5
153
154 For Fedora Core 5 there are RPMs available for libupnp 1.3.1 and
155 iptables 1.3.5:
156
157 # yum install iptables-devel libupnp libupnp-devel
158
159 The files are installed in /usr/lib and /usr/include.
160
161 One thing about iptables-devel is that it includes libiptc.a, but not
162 the corresponding header files: ipt_kernel_headers.h and
163 libiptc.h. You will have to get hold of them from a source tarball,
164 e.g.
165 http://www.netfilter.org/projects/iptables/files/iptables-1.3.5.tar.bz2.
166
167 Unpack the source, find the two header files, and place them in an
168 include directory beside linux-igd, like this:
169
170 $ ls ../include/libiptc/
171 ipt_kernel_headers.h  libiptc.h
172
173 After that all you have to do is compile upnpd:
174
175 $ make HAVE_LIBIPTC=1
176
177 And as root:
178
179 # make install
180
181 /Magnus