added more help
[spider.git] / html / install.html
1 <HTML>
2 <HEAD>
3 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
4 <META NAME="Generator" CONTENT="Microsoft Word 97">
5 <TITLE>Spider-HOWTO</TITLE>
6 <META NAME="Template" CONTENT="C:\PROGRAM FILES\MICROSOFT OFFICE\OFFICE\html.dot">
7 </HEAD>
8 <BODY LINK="#0000ff" VLINK="#800080">
9
10 <P><!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"></P>
11 <H2>Installing DX Spider on RedHat 5.1</H2>
12 <P><HR></P>
13 <P><A HREF="mailto:ip@g8sjp.demon.co.uk">Iain Phillips G0RDI</A></P>
14 <P>
15 <!-- Created: Wed Dec  2 16:40:25 GMT 1998 -->
16 <!-- hhmts start -->
17 Last modified: Mon Dec 14 00:01:40 GMT 1998
18 <!-- hhmts end --></P>
19 <P>This HOWTO describes the installation for DX Spider v1.11 on a "vanilla" Red Hat 5.1 platform, and assumes that you have started with a clean disk, with nothing other than the standard Red Hat 5.1 distribution. I always select 'everything', and that seems to ensure that nothing is missed out :-) </P>
20 <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: -</P><DIR>
21 <DIR>
22
23 <P>MD5-1.7.tar.gz <BR>
24 Data-Dumper-2.10.tar.gz <BR>
25 FreezeThaw-0.3.tar.gz <BR>
26 MLDBM-2.00.ar.gz <BR>
27 TimeDate-1.8.tar.gz <BR>
28 IO-1.20.tar.tgz <BR>
29 Net-Telnet-3.01.tar.gz<BR>
30 &nbsp; </P></DIR>
31 </DIR>
32 <p><em>Do</em> get the latest versions of these packages if any of the above list
33 is out of date.
34
35 <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: -</P><DIR>
36 <DIR>
37
38 <P>ax25-utils-2.1.42a-1.i386.rpm</P></DIR>
39 </DIR>
40
41 <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
42  still have trouble after that.</P>
43 <P>The last "must have" is the DX Spider distribution itself, and this is available via: -</P><DIR>
44 <DIR>
45
46 <P><A HREF="http://www.dxcluster.org/">http://www.dxcluster.org</A></P>
47 <P>&nbsp;</P></DIR>
48 </DIR>
49
50 <OL>
51
52 <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.</LI>
53 <P>Log in as 'root', and make sure you're at '/root' before you continue. Here are exactly the commands you must issue next: -</P>
54 <PRE># tar xvfz /usr/local/packages/MD5-1.7.tar.gz
55 # cd MD5-1.7
56 # make Makefile.PL
57 # make test
58 # make install
59 # cd ..
60 #
61 # tar xvfz /usr/local/packages/Data-Dumper-2.10.tar.gz
62 # cd Data-Dumper-2.10
63 # make Makefile.PL
64 # make test
65 # make install
66 # cd ..
67 #
68 # tar xvfz /usr/local/packages/FreezeThaw-0.3.tar.gz
69 # cd FreezeThaw-0.3
70 # make Makefile.PL
71 # make test
72 # make install
73 # cd ..
74 #
75 # tar xvfz /usr/local/packages/MLDBM-2.00.tar.gz
76 # cd MLDBM-2.00
77 # make Makefile.PL
78 # make test
79 # make install
80 # cd ..
81 #
82 # tar xvfz /usr/local/packages/TimeDate-1.08.tar.gz
83 # cd TimeDate-1.08
84 # make Makefile.PL
85 # make test
86 # make install
87 # cd ..
88 #
89 # tar xvfz /usr/local/packages/IO-1.20.tar.gz
90 # cd IO-1.20
91 # make Makefile.PL
92 # make test
93 # make install UNINST=1
94 # cd ..
95 #
96 # tar xvfz /usr/local/packages/Net-Telnet-3.01.tar.gz
97 # cd Net-Telnet-3.01.tar.gz
98 # make Makefile.PL
99 # make test
100 # make install
101 # cd ..
102 #
103 </pre>
104 <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.</P>
105 <LI>Create a user to run the cluster under. <B><I><U>UNDER NO CIRCUMSTANCES USE ROOT</LI>
106 </B></I></U><P>Again: <B><I><U>DO NOT USE</B></I></U> root.</P>
107 <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!</P>
108 <P># adduser -m sysop</P>
109 <P>Now set a password for the user:-</P>
110 <PRE>#
111 # passwd sysop
112 # New UNIX password:
113 # Retype new UNIX password:
114 passwd: all authentication tokens updated successfully</PRE>
115 <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.</P>
116 <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: -</LI>
117 <PRE># cd ~sysop
118 # tar xvfz spider-1.9.tar.gz
119 # ln -s ~sysop/spider /spider
120 # groupadd -g 251 spider       (or another number)
121 # vi /etc/group                (or your favorite editor)
122 </PRE>
123 <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:-</P>
124 <PRE>spider:x:251:sysop,g0rdi,root</PRE>
125 <LI>Next step is to set permissions on the 'spider' directory tree and files:-</LI>
126 <PRE># chown -R sysop.spider spider
127 # find . -type d -exec chmod 2775 {} \;
128 # find . -type f -exec chmod 775 {} \;
129 </PRE>
130 <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.</P>
131 <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). </LI>
132 <PRE>
133 exec /spider/perl/client.pl &lt;callsign&gt; telnet
134 </PRE>
135 <p>Alternatively you can set up a real login for a person (or another cluster) by creating a login using:-
136 <pre>
137 # useradd gb7djk
138 # passwd gb7djk
139 New UNIX password: 
140 Retype new UNIX password: 
141 passwd: all authentication tokens updated successfully
142 </pre>
143 <p>and editing the <tt>/etc/passwd</tt> file to look like this (do substitute the correct callsigns here ;-):-
144 <pre>
145 fbb:x:505:505::/home/fbb:/bin/bash
146 gb7djk:x:506:506::/home/gb7djk:/usr/bin/perl /spider/perl/client.pl gb7djk telnet
147 </pre>
148 <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.). </P>
149 <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:- </LI>
150 <PRE>
151    [ether]                                                                         
152    NOCALL   * * * * * *  L                                                         
153    default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
154    &lt;bbs&gt;
155    NOCALL   * * * * * *  L                                                         
156    default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
157 </PRE>
158 <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.</P>
159 <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> </LI>
160 <PRE>   # chown root ax25_call netrom_call
161    # chmod 4775 ax25_call netrom_call</PRE>
162 <P>This has to be done to allow you to specify the correct callsigns on outgoing connects</P>
163 <LI>Login to your computer as sysop, and create the initial DX Spider parameters necessary to start the cluster for the first time.</LI>
164 <PRE>   $ startx&#9;&#9;&#9;(much easier to use X)
165    $ cd /spider
166    $ mkdir local
167    $ mkdir local_cmd
168    $ cp perl/DXVars.pm local
169    $ cd local
170    $ vi DXVars.pm&#9;&#9;&#9;(or 'joe DXVars.pm' if you're a WordStar fan ;-)
171 </PRE>
172 <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.</P>
173 <B><P>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</P>
174 </B><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!</P>
175 <PRE>
176    :x
177    
178    $ cd ../perl
179 </PRE>
180 <P>Next, run the following script, which will create the basic user file with you as the sysop.</P>
181 <PRE>
182    $ create_sysop.pl
183 </PRE>
184 <P>Now attempt to startup the cluster program and see whether all the various rivets are flying in approximate formation...</P>
185 <PRE>
186    $ cluster.pl
187    DXSpider DX Cluster Version 1.9
188    Copyright (c) 1998 Dirk Koopman G1TLH
189    loading prefixes ...
190    loading band data ...
191    loading user file system ...
192    starting listener ...
193    reading existing message headers
194    reading cron jobs
195    orft we jolly well go ...
196 </PRE>
197 <LI>now log in again (as 'sysop') or start another rxvt or xterm </LI>
198
199 <PRE>
200    $ client.pl
201 </PRE>
202 <P>at the cluster prompt (which will look something like):-</P>
203 <PRE>
204    G1JIM de GB7JIM 12-Dec-98 1718Z &gt;
205 </pre>
206 Type:
207 <pre>
208    set/node GB7XXX
209 </PRE>
210 <p>(where 'GB7XXX' is a DX cluster which you expect to connect to or from).</p>
211 <P>Now shut the cluster down by simply typing 'shutdown' at the prompt.</P>
212 <P>The cluster and the client should both go back to prompts </P>
213 <p>The callsigns should be the sysop callsign and the cluster callsign
214 as per your modified DXVars.pm. You can check that the cluster 
215 connections will work by:-
216 <pre>
217    $ client.pl gb7xxx      (doesn't have to be uppercase).
218    PC38^GB7JIM^~           <- the cluster thinks this is a cluster
219    ^C                      <- to get out
220 </pre>
221 </ol>
222 <HR>
223 <h5>Version: $Id$</h5>
224 </BODY>
225 </HTML>