Allow synonyms for localhost
[spider.git] / html / install.html
index 74c432ce4bf80c7bce1c4df118da682a4d353bb1..7b75e8cfd202e328cf60c1c836cfa01490aad2d6 100644 (file)
@@ -1,10 +1,12 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+s<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
 <HTML>
   <HEAD>
        <TITLE>DX Spider Installation</TITLE>
        <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">
        <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">
        <meta name="Author" content="Dirk Koopman G1TLH">
+    <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
+
   </HEAD>
 
   <body TEXT="#000000" LINK="#0000ff" VLINK="#800080" BGCOLOR="#FFFFFF">
        <address><A HREF="mailto:ip@g8sjp.demon.co.uk">Iain Phillips G0RDI</A></address>
 <!-- Created: Wed Dec  2 16:40:25 GMT 1998 -->
 <!-- hhmts start -->
-Last modified: Sat Dec 19 16:10:14 GMT 1998
+Last modified: Tue Sep 18 17:54:45 BST 2001
 <!-- hhmts end -->
-       <P>This HOWTO describes the installation for DX Spider v1.11 on a "vanilla" 
+       <P>This HOWTO describes the installation for DX Spider v1.30 on a "vanilla" 
          <A href="http://www.redhat.com">RedHat</A> 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 :-) [ more normal people may like to try with less <em>Ed</em> ].
 
+       <p><b><i>WARNING</i></b> The perl on the vanilla RedHat 5.2
+       (perl-5.004m4-1.i386.rpm) is <em>BROKEN</em>, please use the one
+       in the <a href="../download/index.html#perl">Download</a> section.
+
        <p>The crucial ingredient for all of this is <a href="http://www.perl.org">Perl 5.004</a>. Now I know
          Perl 5.005 is out and this will almost certainly work with it, but 
          <A Href="http://www.redhat.com">RedHat</A> 5.1 comes with 5.004. 
@@ -32,21 +38,23 @@ Last modified: Sat Dec 19 16:10:14 GMT 1998
          <b>do not</b> come with 5.004 as standard, you need to 
          <a href="ftp://upgrade.redhat.com">upgrade</a>
 
-       <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>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>
-               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;
+               <a href="http://www.cpan.org/modules/by-module/MD5/MD5-1.7.tar.gz">MD5-1.7.tar.gz</a><BR>
+               <a href="http://www.cpan.org/modules/by-module/Data/Data-Dumper-2.10.tar.gz">Data-Dumper-2.10.tar.gz</a><BR>
+               <a href="http://www.cpan.org/modules/by-module/Date/TimeDate-1.08.tar.gz">TimeDate-1.08.tar.gz</a><BR>
+               <a href="http://www.cpan.org/modules/by-module/IO/IO-1.20.tar.gz">IO-1.20.tar.tgz</a> (only on perl 5.00503 and below, do: 'perl -v' to find out what version you have)<BR>
+               <a href="http://www.cpan.org/modules/by-module/Net/Net-Telnet-3.02.tar.gz">Net-Telnet-3.02.tar.gz</a><BR>
+               <a href="http://www.cpan.org/modules/by-module/Curses/Curses-1.06.tar.gz">Curses-1.06.tar.gz</a><BR>
+        <a href="http://www.cpan.org/modules/by-module/Time/Time-HiRes-01.20.tar.gz">Time::Hires</a>
        </DIR>
 
-       <p><em>Do</em> get the latest versions of these packages if any of the above list
-         is out of date.
+       <p>The modules above are the current versions found at <a href="http://www.cpan.org">www.cpan.org</a> in the appropriate directories -
+       you can click on the links (above) to download them - particularly useful if you use the Lynx text HTML browser from your Linux box.
+       You may wish to check for more recent versions of these modules and use the newer ones if they are available.</p>
+
+       <br>
 
        <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>
@@ -85,36 +93,36 @@ Last modified: Sat Dec 19 16:10:14 GMT 1998
 # make install
 # cd ..
 #
-# tar xvfz /usr/local/packages/FreezeThaw-0.3.tar.gz
-# cd FreezeThaw-0.3
+# tar xvfz /usr/local/packages/TimeDate-1.08.tar.gz
+# cd TimeDate-1.08
 # perl Makefile.PL
 # make test
 # make install
 # cd ..
 #
-# tar xvfz /usr/local/packages/MLDBM-2.00.tar.gz
-# cd MLDBM-2.00
+# tar xvfz /usr/local/packages/IO-1.20.tar.gz
+# cd IO-1.20
 # perl Makefile.PL
 # make test
-# make install
+# make install UNINST=1
 # cd ..
 #
-# tar xvfz /usr/local/packages/TimeDate-1.08.tar.gz
-# cd TimeDate-1.08
+# tar xvfz /usr/local/packages/Net-Telnet-3.02.tar.gz
+# cd Net-Telnet-3.02
 # perl Makefile.PL
 # make test
 # make install
 # cd ..
 #
-# tar xvfz /usr/local/packages/IO-1.20.tar.gz
-# cd IO-1.20
+# tar xvfz /usr/local/packages/Curses-1.05.tar.gz
+# cd Curses-1.05
 # perl Makefile.PL
 # make test
-# make install UNINST=1
+# make install
 # cd ..
 #
-# tar xvfz /usr/local/packages/Net-Telnet-3.01.tar.gz
-# cd Net-Telnet-3.01.tar.gz
+# tar xvfz /usr/local/packages/Time-HiRes-01.20.tar.gz 
+# cd Time-HiRes-01.20
 # perl Makefile.PL
 # make test
 # make install
@@ -158,33 +166,97 @@ spider:x:251:sysop,g0rdi,root
                </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). 
+               <p><LI>In later releases there is a client program written in C. You
+               must <tt>make</tt> this program before you can use it (and you must 
+               remember to to remake with every new release).
+
+               <p>To do this you should:-
                <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
+# cd /spider/src
+# make
+        </PRE>
+
+               <p>You can continue to use the perl client (<tt>/spider/perl/client.pl</tt>, but
+               support of this will gradually whither away.
+               <p><LI><a name="connect"></a>If you want to be able to allow people or clusters
+               to login via IP then you will need to set up logins for them.
+
+               <p><pre>
+# useradd -m 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 ;-):-
+
+               <p>You can then either alter the default .bashrc so that it
+               contains just one line (assuming you use the default bash
+               shell).
+       
+               <p><PRE>
+exec /spider/perl/client.pl &lt;callsign&gt; telnet
+               </PRE>
+               
+               <p>Alternatively you can alter the <tt>/etc/passwd</tt> thus:-
+
                <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.). 
                
+               Don't forget to give them a real password. The <tt>telnet</tt> 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.). If the user or other cluster
+               program requires AX25 conventions to operate then you can use 
+               <tt>ax25</tt> instead.
+
+               <p>Another thing you can do is to get <tt>inetd</tt> to listen
+               on a specific port and then start the client up directly. To
+                 do this, create an entry in <tt>/etc/services</tt> with a
+                 port number > 1000 that isn't used elsewhere eg:-
+
+               <p><pre>
+gb7djk     8001/tcp 
+gb7tlh     8002/tcp
+        </pre>
+
+               Then create some lines in <tt>/etc/inetd.conf</tt> that look 
+               like this:-
+               
+               <p><pre>
+gb7djk  stream tcp   nowait   sysop /usr/sbin/tcpd /spider/src/client gb7djk telnet
+gb7tlh  stream tcp   nowait   sysop /usr/sbin/tcpd /spider/src/client gb7tlh telnet
+               </pre>
+
+               Please <b>DON'T</b> run the client as <tt>root</tt> you will only 
+               come to regret it later when the next person finds a security hole
+               in DX Spider (there are bound to be some although I have tried to
+               avoid the obvious ones I could think of).
+
+               <p>The only reason I would use this mechanism is for Internet connections
+                 to other or from other clusters. Don't use this for normal users.
+
+               <p>In the example I have used <tt>tcpd</tt> as the access control 
+                 mechanism to the port. Don't (I can't be bothered to emphasize 
+                 it any more) run a system like this without one, you are asking
+                 for trouble. In fact I use the <a href="http://www.tis.com">TIS
+                 Firewall Toolkit</a> myself, you may find this more intuitive 
+                 to use. The point is that <tt>gb7djk</tt> would only be coming
+                 from one IP address, if it coming from another, it is an imposter!
+
+               <p><b>You are responsible for arranging and looking after your 
+                       security - not me.</b>
+
                <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:- 
                <PRE>
-[ether]                                                                         
-NOCALL   * * * * * *  L                                                         
-default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
-&lt;bbs&gt;
-NOCALL   * * * * * *  L                                                         
-default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
+[ether]        
+NOCALL   * * * * * *  L                                                      
+default  * * * * * *  - sysop /spider/src/client client %u ax25
+&lt;cluster&gt;
+NOCALL   * * * * * *  L                                                       
+default  * * * * * *  - sysop /spider/src/client client %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.
                
@@ -195,7 +267,7 @@ default  * * * * * *  - sysop /spider/perl/client.pl client.pl %u ax25
                </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.
+               <p><LI><a name="dxvar"></a>Login to your computer as sysop, and create the initial DX Spider parameters necessary to start the cluster for the first time.
                <PRE>
 $ startx&#9;&#9;&#9;(much easier to use X)
 $ cd /spider
@@ -255,20 +327,31 @@ $ client.pl gb7xxx      (doesn't have to be uppercase).
 PC38^GB7JIM^~           &lt;- the cluster thinks this is a cluster
 ^C                      &lt;- to get out
                </pre>
+               <p>
+         <li> Finally try:-
+           <pre>
+$ console.pl 
+        </pre>
+               <p>This is the normal way (as of version 1.30) of running the cluster system
+               as a sysop. It is a simple program client program that allows you to
+        press &lt;up-arrow> &lt;down-arrow> and use all the usual line editting
+               keystrokes that you can use on the unix shell under linux or bash. 
+               <p>In addition, it will highlight certain type of lines in particular
+               colours and allow you to scroll the top window up and down with the
+               &lt;page-up> and &lt;page-down> keys.
        </ol>
 
        <p>You should now have a basic working system. Best of luck! Can I now draw your attention to
-         the <a href="http://www.dxcluster.org/spider">Bug Reporting</a> System. Some mailing lists will
-         be created RSN for more general discussions.
+         the <a href="http://www.dxcluster.org/spider">Bug Reporting</a> System. 
 
        <p>Can I commend to you the Announcements mailing list to which you may 
-         <a href="mailto:majordomo@dxcluster.org?subject=Subscribe&body=subscribe%20dxspider-announce%0D%0A--%0D%0A">subscribe</a>.
+         <a href="mailto:dxspider-announce-request@dxcluster.org?subject=Subscribe&body=subscribe%20dxspider-announce%0D%0A--%0D%0A">subscribe</a>.
          This is a low volume mailing list which will send you announcements of new patches and 
          such like things as they arise.
 
        <p>If you like what you see and want to be a part of the ongoing development then 
-         <a href="mailto:majordomo@dxcluster.org?subject=Subscribe&body=subscribe%20dxspider-support%0D%0A--%0D%0A">subscribe</a> 
-         to the support mailing list which will be the initial focus of any discussions.
+         <a href="mailto:dxspider-support-request@dxcluster.org?subject=Subscribe&body=subscribe%20dxspider-support%0D%0A--%0D%0A">subscribe</a> 
+         to the support mailing list which will be the focus of any discussion/bug fixing etc.
 
 <!-- Standard Footer!! -->
        <p>&nbsp;</p>