74c432ce4bf80c7bce1c4df118da682a4d353bb1
[spider.git] / html / install.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2 <HTML>
3   <HEAD>
4         <TITLE>DX Spider Installation</TITLE>
5         <meta name="Keywords" content="DX Cluster, DXSpider, Spider, Packet Cluster, DXCluster, Pavillion Software, AK1A, AX25, AX.25, WWV, Packet Radio, Amateur Radio, Propagation, DX, DXing, G1TLH, GB7TLH, Dirk Koopman, Mailing list, Linux, RedHat, PERL">
6         <meta name="Description" content="Software and systems for realtime digital communications between amateur radio stations for the provision of information on propagation conditions and stations operating">
7         <meta name="Author" content="Dirk Koopman G1TLH">
8   </HEAD>
9
10   <body TEXT="#000000" LINK="#0000ff" VLINK="#800080" BGCOLOR="#FFFFFF">
11         <FONT COLOR="#606060" face="Verdana,Helvetica,Swiss,Arial"> 
12           <hr>
13           <h2>Installing DX Spider (on Redhat 5.1)</h2>
14           <hr>
15         </font>
16
17         <address><A HREF="mailto:ip@g8sjp.demon.co.uk">Iain Phillips G0RDI</A></address>
18 <!-- Created: Wed Dec  2 16:40:25 GMT 1998 -->
19 <!-- hhmts start -->
20 Last modified: Sat Dec 19 16:10:14 GMT 1998
21 <!-- hhmts end -->
22         <P>This HOWTO describes the installation for DX Spider v1.11 on a "vanilla" 
23           <A href="http://www.redhat.com">RedHat</A> 5.1 platform, 
24           and assumes that you have started with a clean disk, with nothing other than the standard 
25           Red Hat 5.1 distribution. I always select 'everything', and that seems to ensure that 
26           nothing is missed out :-) [ more normal people may like to try with less <em>Ed</em> ].
27
28         <p>The crucial ingredient for all of this is <a href="http://www.perl.org">Perl 5.004</a>. Now I know
29           Perl 5.005 is out and this will almost certainly work with it, but 
30           <A Href="http://www.redhat.com">RedHat</A> 5.1 comes with 5.004. 
31           <em>Be Warned</em> earlier versions of <A Href="http://www.redhat.com">RedHat</A> 
32           <b>do not</b> come with 5.004 as standard, you need to 
33           <a href="ftp://upgrade.redhat.com">upgrade</a>
34
35         <P>In addition to the standard Red Hat distribution you will require the following <A HREF="http://www.cpan.org/CPAN.html">CPAN</A> modules: -
36         <p>
37         <dir>
38                 MD5-1.7.tar.gz <BR>
39                 Data-Dumper-2.10.tar.gz <BR>
40                 FreezeThaw-0.3.tar.gz <BR>
41                 MLDBM-2.00.ar.gz <BR>
42                 TimeDate-1.8.tar.gz <BR>
43                 IO-1.20.tar.tgz <BR>
44                 Net-Telnet-3.01.tar.gz<BR>
45                 &nbsp;
46         </DIR>
47
48         <p><em>Do</em> get the latest versions of these packages if any of the above list
49           is out of date.
50
51         <P>You'll also need the AX25 utility package. There is much debate about what is "best", what is "better". What works for 5.1 is this: -
52         <p>
53         <DIR>
54                 ax25-utils-2.1.42a-1.i386.rpm
55         </DIR>
56         
57         <P>This can be found at (among other places) <A HREF="ftp://contrib.redhat.com/libc6">ftp://contrib.redhat.com</A>. Note that no attempt is made within this document to describe the steps necessary to install and commission the AX25 kernel package. It remains the responsibility of the reader to have sufficient knowledge and expertise to make this part of the system operation (and to be satisfied that it <B><I>is </B></I>operational) before attempting to install DX Spider. Read the AX25-HOWTO and ask around if you
58  still have trouble after that.
59
60         <P>The last "must have" is the DX Spider distribution itself, and this is available via: -
61
62         <p>
63         <DIR>
64                 <A HREF="../download/index.html">The DX Spider Software</A>
65         </DIR>
66
67         <p>We can now begin:-
68         <P>
69         <OL>
70           
71           <p><LI>Copy the CPAN modules listed above to a convenient place on your computer. For no good reason, I put mine in /usr/local/packages, and the instructions which follow will assume that that's where yours are, too.
72                 <P>Log in as 'root', and make sure you're at '/root' before you continue. Here are exactly the commands you must issue next: -
73                 <PRE>
74 # tar xvfz /usr/local/packages/MD5-1.7.tar.gz
75 # cd MD5-1.7
76 # perl Makefile.PL
77 # make test
78 # make install
79 # cd ..
80 #
81 # tar xvfz /usr/local/packages/Data-Dumper-2.10.tar.gz
82 # cd Data-Dumper-2.10
83 # perl Makefile.PL
84 # make test
85 # make install
86 # cd ..
87 #
88 # tar xvfz /usr/local/packages/FreezeThaw-0.3.tar.gz
89 # cd FreezeThaw-0.3
90 # perl Makefile.PL
91 # make test
92 # make install
93 # cd ..
94 #
95 # tar xvfz /usr/local/packages/MLDBM-2.00.tar.gz
96 # cd MLDBM-2.00
97 # perl Makefile.PL
98 # make test
99 # make install
100 # cd ..
101 #
102 # tar xvfz /usr/local/packages/TimeDate-1.08.tar.gz
103 # cd TimeDate-1.08
104 # perl Makefile.PL
105 # make test
106 # make install
107 # cd ..
108 #
109 # tar xvfz /usr/local/packages/IO-1.20.tar.gz
110 # cd IO-1.20
111 # perl Makefile.PL
112 # make test
113 # make install UNINST=1
114 # cd ..
115 #
116 # tar xvfz /usr/local/packages/Net-Telnet-3.01.tar.gz
117 # cd Net-Telnet-3.01.tar.gz
118 # perl Makefile.PL
119 # make test
120 # make install
121 # cd ..
122 #
123                 </pre>
124                 <P>Do not fall into the trap of thinking they're all the same, just because they nearly are! Pay particular attention to the instructions of IO, above.
125
126                 <p><LI>Create a user to run the cluster under. <B><I><U>UNDER NO CIRCUMSTANCES USE ROOT
127                 </B></I></U><P>Again: <B><I><U>DO NOT USE</B></I></U> root.
128                 <P>In the instructions which follow, it is assumed that this user is called 'sysop'. You may call it anything you wish. Depending upon your security requirements, you may choose to use an existing user. This will be your choice, not ours!
129                 <P># adduser -m sysop
130                 <P>Now set a password for the user:-
131                 <PRE>
132 #
133 # passwd sysop
134 # New UNIX password:
135 # Retype new UNIX password:
136 passwd: all authentication tokens updated successfully
137                 </PRE>
138                 <P># Do not fall into the trap of thinking they're all the same, just because they nearly are! Pay particular attention to the instructions of IO, above.
139                 
140                 <p><LI>Now unpack the DX Spider distribution, set symbolic links and group permissions like this (assumes that the version we're interested in is 1.9. The distribution tar file may be named slightly differently in your case: -
141                 <PRE>
142 # cd ~sysop
143 # tar xvfz spider-1.9.tar.gz
144 # ln -s ~sysop/spider /spider
145 # groupadd -g 251 spider       (or another number)
146 # vi /etc/group                (or your favorite editor)
147                 </PRE>
148                 <P>add 'sysop', your own callsign (in my case 'g0rdi' - which will be used as an alias) and 'root' to the group spider. The result should look something like:-
149                 <PRE>
150 spider:x:251:sysop,g0rdi,root
151                 </PRE>
152
153                 <p><LI>Next step is to set permissions on the 'spider' directory tree and files:-
154                 <PRE>
155 # chown -R sysop.spider spider
156 # find . -type d -exec chmod 2775 {} \;
157 # find . -type f -exec chmod 775 {} \;
158                 </PRE>
159                 <P>This last step allows various users of group spider to have write access to all the directories. Not really needed for now but will be useful when web interfaces start to appear.
160                 
161                 <p><LI>Should you have any users that require network logins, set them up as real users with 'useradd -m &lt;callsign&gt;'. Alter the default .bashrc so that it contains just one line (assuming you use the default bash shell). 
162                 <PRE>
163 exec /spider/perl/client.pl &lt;callsign&gt; telnet
164                 </PRE>
165                 <p>Alternatively you can set up a real login for a person (or another cluster) by creating a login using:-
166                 <pre>
167 # useradd gb7djk
168 # passwd gb7djk
169 New UNIX password: 
170 Retype new UNIX password: 
171 passwd: all authentication tokens updated successfully
172                 </pre>
173                 <p>and editing the <tt>/etc/passwd</tt> file to look like this (do substitute the correct callsigns here ;-):-
174                 <pre>
175 fbb:x:505:505::/home/fbb:/bin/bash
176 gb7djk:x:506:506::/home/gb7djk:/usr/bin/perl /spider/perl/client.pl gb7djk telnet
177                 </pre>
178                 <P>Don't forget to give them a real password. This is really for network cluster logins. The telnet argument does two things, it sets the EOL convention to \n rather than AX25's \r and it automatically reduces the privilege of the &lt;callsign&gt; to a 'safe[r]' level.). 
179                 
180                 <p><LI>As mentioned earlier, for AX25 connections <B><I>you</B></I> are expected to have the AX25 utilities installed, setup, tested and working. See the AX25-HOWTO for more info on this - it really is beyond the scope of this document DX Spider uses ax25d for incoming connections. You need to have entries like this:- 
181                 <PRE>
182 [ether]                                                                         
183 NOCALL   * * * * * *  L                                                         
184 default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
185 &lt;bbs&gt;
186 NOCALL   * * * * * *  L                                                         
187 default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
188                 </PRE>
189                 <P>where 'ether' and 'bbs' are appropriate <B><I>KNOWN WORKING</B></I> axport and nrport names respectively. Obviously you can use different names, callsigns or whatever for your purposes, but it is up to you to get it to work. Note I use BPQ over ethernet which why I have the port names I have.
190                 
191                 <p><LI>Find your <TT>netrom_call</TT> and <TT>ax25_call</TT> programs (which on my system live in <TT>/usr/sbin)</TT> and chmod them so that they are SUID <TT>root</TT> 
192                 <PRE>
193 # chown root ax25_call netrom_call
194 # chmod 4775 ax25_call netrom_call
195                 </PRE>
196                 <P>This has to be done to allow you to specify the correct callsigns on outgoing connects
197
198                 <p><LI>Login to your computer as sysop, and create the initial DX Spider parameters necessary to start the cluster for the first time.
199                 <PRE>
200 $ startx&#9;&#9;&#9;(much easier to use X)
201 $ cd /spider
202 $ mkdir local
203 $ mkdir local_cmd
204 $ cp perl/DXVars.pm local
205 $ cd local
206 $ vi DXVars.pm&#9;&#9;&#9;(or 'joe DXVars.pm' if you're a WordStar fan ;-)
207                 </PRE>
208                 <P>Using the distributed DXVars.pm as a a template, set your cluster callsign, sysop callsign and other user info to suit your own environment. Note that this a perl file which will be parsed and executed as part of the cluster. If you get it wrong then perl will complain when you start the cluster process.
209                 <P><b>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</B>
210                 <P>DON'T alter the DXVars.pm (or any other file) in /spider/perl, they are overwritten with every release. Any files or commands you place in /spider/local or /spider/local_cmd will automagically be used in preference to the ones in /spider/perl EVEN whilst the cluster is running!
211                 <PRE>
212 :x
213    
214 $ cd ../perl
215                 </PRE>
216                 <P>Next, run the following script, which will create the basic user file with you as the sysop.
217                 <PRE>
218 $ create_sysop.pl
219                 </PRE>
220                 <P>Now attempt to startup the cluster program and see whether all the various rivets are flying in approximate formation...
221                 <PRE>
222 $ cluster.pl
223 DXSpider DX Cluster Version 1.9
224 Copyright (c) 1998 Dirk Koopman G1TLH
225 loading prefixes ...
226 loading band data ...
227 loading user file system ...
228 starting listener ...
229 reading existing message headers
230 reading cron jobs
231 orft we jolly well go ...
232                 </PRE>
233                 
234                 <p><LI>now log in again (as 'sysop') or start another rxvt or xterm 
235
236                 <PRE>
237 $ client.pl
238                 </PRE>
239                 <P>at the cluster prompt (which will look something like):-
240                 <PRE>
241 G1JIM de GB7JIM 12-Dec-98 1718Z &gt;
242                 </pre>
243                 Type:
244                 <pre>
245 set/node GB7XXX
246                 </PRE>
247                 <p>(where 'GB7XXX' is a DX cluster which you expect to connect to or from).
248                 <P>Now shut the cluster down by simply typing 'shutdown' at the prompt.
249                 <P>The cluster and the client should both go back to prompts 
250                 <p>The callsigns should be the sysop callsign and the cluster callsign
251                   as per your modified DXVars.pm. You can check that the cluster 
252                   connections will work by:-
253                 <pre>
254 $ client.pl gb7xxx      (doesn't have to be uppercase).
255 PC38^GB7JIM^~           &lt;- the cluster thinks this is a cluster
256 ^C                      &lt;- to get out
257                 </pre>
258         </ol>
259
260         <p>You should now have a basic working system. Best of luck! Can I now draw your attention to
261           the <a href="http://www.dxcluster.org/spider">Bug Reporting</a> System. Some mailing lists will
262           be created RSN for more general discussions.
263
264         <p>Can I commend to you the Announcements mailing list to which you may 
265           <a href="mailto:majordomo@dxcluster.org?subject=Subscribe&body=subscribe%20dxspider-announce%0D%0A--%0D%0A">subscribe</a>.
266           This is a low volume mailing list which will send you announcements of new patches and 
267           such like things as they arise.
268
269         <p>If you like what you see and want to be a part of the ongoing development then 
270           <a href="mailto:majordomo@dxcluster.org?subject=Subscribe&body=subscribe%20dxspider-support%0D%0A--%0D%0A">subscribe</a> 
271           to the support mailing list which will be the initial focus of any discussions.
272
273 <!-- Standard Footer!! -->
274         <p>&nbsp;</p>
275         <p>
276           <FONT COLOR="#606060"><hr></font>
277         <font color="#FF0000" size=-2>
278           Copyright &copy; 1998 by Dirk Koopman G1TLH and Iain Phillips G0RDI. All Rights Reserved<br>
279         </font>
280         <font color="#000000" size=-2>$Id$</font>
281
282   </BODY>
283 </HTML>