added more help
[spider.git] / html / install.html
index 5ffef8d1e74f459ec5e1dc3e1d6629ac611362fe..b375941ef08cfae9629bc1d2a2652c9ca09f2e25 100644 (file)
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
-<html>
-  <head>
-    <title>Installing Spider</title>
-  </head>
-
-  <body>
-    <h2>Installing Spider</h2>
-
-    <hr>
-    <address><a href="mailto:djk@tobit.co.uk"></a></address>
+<HTML>
+<HEAD>
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
+<META NAME="Generator" CONTENT="Microsoft Word 97">
+<TITLE>Spider-HOWTO</TITLE>
+<META NAME="Template" CONTENT="C:\PROGRAM FILES\MICROSOFT OFFICE\OFFICE\html.dot">
+</HEAD>
+<BODY LINK="#0000ff" VLINK="#800080">
+
+<P><!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"></P>
+<H2>Installing DX Spider on RedHat 5.1</H2>
+<P><HR></P>
+<P><A HREF="mailto:ip@g8sjp.demon.co.uk">Iain Phillips G0RDI</A></P>
+<P>
 <!-- Created: Wed Dec  2 16:40:25 GMT 1998 -->
 <!-- hhmts start -->
-Last modified: Wed Dec  2 18:19:38 GMT 1998
-<!-- hhmts end -->
-
-       <p>This version of dxspider requires perl5 (it is written entirely in perl5 and
-       makes extensive use of perl objects). This program is known to work with
-       RedHat 5.1 perl5_004.</p>
-
-       <p>In addition to the standard perl5 distribution you will require to load the
-       the following modules:-</p>
-
-       <ol>  
-         <li> <a href="cpan.html">CPAN</a> - this has a load of the standard extra stuff in it. To load it type:-
-
-      <pre>
-  # perl -MCPAN -e shell
-  cpan> install Bundle::CPAN
-  cpan> q
-     </pre>
-
-               <p>Please sure there were no errors, be particularly careful when installing
-                 libwww stuff, I would suggest 'no host lookups' and pressing &lt;space> and
-                 enter for each of the offered default hostnames. </p>
-               
-               <p>I have monitored a typical load of <a href="cpan.html">CPAN</a> which you can
-                 look at <a href="cpan.html">here</a></p>
-
-         <li> Date::Parse, MLDBM, IO::Select
-  
-               <p>As you have so carefully loaded it, I suggest you use the CPAN system
-                 above:-</p>
-               <pre>
-  # perl -MCPAN -e shell
-  cpan> install Date::Parse
-  ..
-  ..
-  cpan> install MLDBM
-  ..
-  ..
-  cpan> install IO::Select
-        </pre>
-               <p>In order to use IO::Select you will need to </p>
-               <pre>
-  # cd /root/.cpan/build/IO-1.20  
-  # make install UNINST=1
-        </pre>
-               <p>The 'cd' is to the place where CPAN sets up its local cache. The example 
-                 shown is for Linux defaults.</p>
-
-         <li> select a user to run the cluster as UNDER _NO_ CIRCUMSTANCES USE ROOT.
-
-               <p>I say again DO NOT USE root.</p>
-   
-               <p>Pick an existing user or create a new one. Don't care which. I don't know
-                 your security requirements.</p>
-   
-         <li> login as root (I shall use 'jim' for any examples).<br>
-
-         <li> type in the following:-
-               <pre>
-   # cd ~jim
-   # tar xvfz spider-x.x.tar.gz
-   # ln -s ~jim/spider /spider
-   # groupadd -g 251 spider       (or another number)
-   # vi /etc/group                (or your favorite editor)
-               </pre>
-
-               <p>add jim (or whatever) and root to the group spider
-                 it should look something like:-</p>
-        
-               <pre>
-     spider:x:251:jim,root
-     :x
-   # chown -R jim.spider spider
-   # find . -type d -exec chmod 2775 {} \;
-   # find . -type f -exec chmod 775 {} \;
-               </pre>
-               <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>
-
-         <li> if you have any users that require network logins, set them up as real
-               users with useradd -m &lt;callsign>. Alter the default .bashrc so that it
-               contains just one line (assuming you use the default bash shell).
-               
-               <pre>
-               exec /spider/perl/client.pl &lt;callsign> telnet
-               </pre>
-   
-               <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> to a 'safe[r]' level.</p>
-   
-         <li> for incoming AX25 connections you are expected to have got the AX25
-               utilities setup, tested and working. See the AX25-HOWTO for more info
-               on this - it really is outside the scope of this document. I would 
-               recommend using ax25-utils-2.1.42a-5.i386.rpm or above as a starting 
-               point. DXSpider uses ax25d for incoming connections. You need to have 
-               entries like this:-
-               <pre>
+Last modified: Mon Dec 14 00:01:40 GMT 1998
+<!-- hhmts end --></P>
+<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>
+<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>
+<DIR>
+
+<P>MD5-1.7.tar.gz <BR>
+Data-Dumper-2.10.tar.gz <BR>
+FreezeThaw-0.3.tar.gz <BR>
+MLDBM-2.00.ar.gz <BR>
+TimeDate-1.8.tar.gz <BR>
+IO-1.20.tar.tgz <BR>
+Net-Telnet-3.01.tar.gz<BR>
+&nbsp; </P></DIR>
+</DIR>
+<p><em>Do</em> get the latest versions of these packages if any of the above list
+is out of date.
+
+<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>
+<DIR>
+
+<P>ax25-utils-2.1.42a-1.i386.rpm</P></DIR>
+</DIR>
+
+<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
+ still have trouble after that.</P>
+<P>The last "must have" is the DX Spider distribution itself, and this is available via: -</P><DIR>
+<DIR>
+
+<P><A HREF="http://www.dxcluster.org/">http://www.dxcluster.org</A></P>
+<P>&nbsp;</P></DIR>
+</DIR>
+
+<OL>
+
+<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>
+<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>
+<PRE># tar xvfz /usr/local/packages/MD5-1.7.tar.gz
+# cd MD5-1.7
+# make Makefile.PL
+# make test
+# make install
+# cd ..
+#
+# tar xvfz /usr/local/packages/Data-Dumper-2.10.tar.gz
+# cd Data-Dumper-2.10
+# make Makefile.PL
+# make test
+# make install
+# cd ..
+#
+# tar xvfz /usr/local/packages/FreezeThaw-0.3.tar.gz
+# cd FreezeThaw-0.3
+# make Makefile.PL
+# make test
+# make install
+# cd ..
+#
+# tar xvfz /usr/local/packages/MLDBM-2.00.tar.gz
+# cd MLDBM-2.00
+# make Makefile.PL
+# make test
+# make install
+# cd ..
+#
+# tar xvfz /usr/local/packages/TimeDate-1.08.tar.gz
+# cd TimeDate-1.08
+# make Makefile.PL
+# make test
+# make install
+# cd ..
+#
+# tar xvfz /usr/local/packages/IO-1.20.tar.gz
+# cd IO-1.20
+# make Makefile.PL
+# make test
+# make install UNINST=1
+# cd ..
+#
+# tar xvfz /usr/local/packages/Net-Telnet-3.01.tar.gz
+# cd Net-Telnet-3.01.tar.gz
+# make Makefile.PL
+# make test
+# make install
+# cd ..
+#
+</pre>
+<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>
+<LI>Create a user to run the cluster under. <B><I><U>UNDER NO CIRCUMSTANCES USE ROOT</LI>
+</B></I></U><P>Again: <B><I><U>DO NOT USE</B></I></U> root.</P>
+<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>
+<P># adduser -m sysop</P>
+<P>Now set a password for the user:-</P>
+<PRE>#
+# passwd sysop
+# New UNIX password:
+# Retype new UNIX password:
+passwd: all authentication tokens updated successfully</PRE>
+<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>
+<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>
+<PRE># cd ~sysop
+# tar xvfz spider-1.9.tar.gz
+# ln -s ~sysop/spider /spider
+# groupadd -g 251 spider       (or another number)
+# vi /etc/group                (or your favorite editor)
+</PRE>
+<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>
+<PRE>spider:x:251:sysop,g0rdi,root</PRE>
+<LI>Next step is to set permissions on the 'spider' directory tree and files:-</LI>
+<PRE># chown -R sysop.spider spider
+# find . -type d -exec chmod 2775 {} \;
+# find . -type f -exec chmod 775 {} \;
+</PRE>
+<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>
+<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>
+<PRE>
+exec /spider/perl/client.pl &lt;callsign&gt; telnet
+</PRE>
+<p>Alternatively you can set up a real login for a person (or another cluster) by creating a login using:-
+<pre>
+# useradd gb7djk
+# passwd gb7djk
+New UNIX password: 
+Retype new UNIX password: 
+passwd: all authentication tokens updated successfully
+</pre>
+<p>and editing the <tt>/etc/passwd</tt> file to look like this (do substitute the correct callsigns here ;-):-
+<pre>
+fbb:x:505:505::/home/fbb:/bin/bash
+gb7djk:x:506:506::/home/gb7djk:/usr/bin/perl /spider/perl/client.pl gb7djk telnet
+</pre>
+<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>
+<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>
+<PRE>
    [ether]                                                                         
    NOCALL   * * * * * *  L                                                         
-   default  * * * * * *  - jim /spider/perl/client.pl client.pl %u ax25
-   &lt;bbs>
+   default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
+   &lt;bbs&gt;
    NOCALL   * * * * * *  L                                                         
-   default  * * * * * *  - jim /spider/perl/client.pl client.pl %u ax25
-               </pre>
-
-               <p>where ether and bbs are appropriate KNOWN WORKING axport and nrport 
-               names respectively.</p>
-   
-               <p>Obviously you can use different names, callsigns or whatever for your 
-                 purposes, but it is up to you to get it to work. </p>
-   
-               <p>Note I use BPQ over ethernet which why I have the port names I have.</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>
-               <pre>
-   # chown root ax25_call netrom_call
-   # chmod 4775 ax25_call netrom_call
-        </pre>
-        <p>This has to be done to allow you to specify the correct callsigns on outgoing connects</p>
-   
-         <li> login as jim (or whatever)
-               <pre>
-   $ startx                     (much easier to use X)
+   default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
+</PRE>
+<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>
+<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>
+<PRE>   # chown root ax25_call netrom_call
+   # chmod 4775 ax25_call netrom_call</PRE>
+<P>This has to be done to allow you to specify the correct callsigns on outgoing connects</P>
+<LI>Login to your computer as sysop, and create the initial DX Spider parameters necessary to start the cluster for the first time.</LI>
+<PRE>   $ startx&#9;&#9;&#9;(much easier to use X)
    $ cd /spider
    $ mkdir local
    $ mkdir local_cmd
    $ cp perl/DXVars.pm local
    $ cd local
-   $ vi DXVars.pm
-               </pre>
-               <p>now alter your cluster callsign, sysop callsign and other user info 
-                 as you wish. Note that this a perl file which will parsed and executed
-                 as part of the cluster. If you get it wrong then perl will complain 
-                 when you start the cluster process.</p>
-   
-               <p><b>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</b><p>
-   
-               <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>
-               <pre>
+   $ vi DXVars.pm&#9;&#9;&#9;(or 'joe DXVars.pm' if you're a WordStar fan ;-)
+</PRE>
+<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>
+<B><P>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</P>
+</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>
+<PRE>
    :x
    
    $ cd ../perl
-               </pre>
-
-               <p>now create the basic user file with you as the sysop.</p>
-               <pre>
+</PRE>
+<P>Next, run the following script, which will create the basic user file with you as the sysop.</P>
+<PRE>
    $ create_sysop.pl
-               </pre>
-
-               <p>try and run the cluster program and see whether all the various rivets are
-                 flying in approximate formation...</p>
-               
-               <pre>
+</PRE>
+<P>Now attempt to startup the cluster program and see whether all the various rivets are flying in approximate formation...</P>
+<PRE>
    $ cluster.pl
-   DXSpider DX Cluster Version x.x
+   DXSpider DX Cluster Version 1.9
    Copyright (c) 1998 Dirk Koopman G1TLH
    loading prefixes ...
    loading band data ...
@@ -181,41 +193,33 @@ Last modified: Wed Dec  2 18:19:38 GMT 1998
    reading existing message headers
    reading cron jobs
    orft we jolly well go ...
-               </pre>
-   
-         <li> now log in again or start another rxvt or xterm
-               <pre>
-   $ client.pl
-               </pre>
-
-               <p>you should now see a normal cluster prompt.</p>
-   
-               <p>at the cluster prompt:-</p>
-               <pre>
-   G1JIM de GB7JIM 10-Sep-98 1000Z> set/node GB7XXX
-        </pre>
-
-   <p>for every dxcluster you expect to connect to or from.</p>
-
-               <pre>
-   G1JIM de GB7JIM 10-Sep-98 1001Z> shutdown
-               </pre>
+</PRE>
+<LI>now log in again (as 'sysop') or start another rxvt or xterm </LI>
 
-               <p>The cluster and the client should both go back to prompts
-   
-               <p>Restart the cluster.
-   
-               <p>The callsigns should be the sysop callsign and the cluster callsign
-                 as per your modified DXVars.pm. You can check that the cluster 
-                 connections will work by:-
-               <pre>
+<PRE>
+   $ client.pl
+</PRE>
+<P>at the cluster prompt (which will look something like):-</P>
+<PRE>
+   G1JIM de GB7JIM 12-Dec-98 1718Z &gt;
+</pre>
+Type:
+<pre>
+   set/node GB7XXX
+</PRE>
+<p>(where 'GB7XXX' is a DX cluster which you expect to connect to or from).</p>
+<P>Now shut the cluster down by simply typing 'shutdown' at the prompt.</P>
+<P>The cluster and the client should both go back to prompts </P>
+<p>The callsigns should be the sysop callsign and the cluster callsign
+as per your modified DXVars.pm. You can check that the cluster 
+connections will work by:-
+<pre>
    $ client.pl gb7xxx      (doesn't have to be uppercase).
    PC38^GB7JIM^~           <- the cluster thinks this is a cluster
    ^C                      <- to get out
-        </pre>
-       </ol>
-   
-       <hr>
-       <h5>Version: $Id$</h5>
-  </body>
-</html>
+</pre>
+</ol>
+<HR>
+<h5>Version: $Id$</h5>
+</BODY>
+</HTML>