fix some typos
[spider.git] / txt / installation_en.txt
index ac606c760b64d7dcc48661b9edbb355d7dea8430..35b2888942b155ba1858b7366346598e6622df73 100644 (file)
@@ -33,8 +33,8 @@
 
   4. Configuration
      4.1 Allowing ax25 connects from users
-     4.2 Allowing telnet connects from users
-     4.3 Setting up telnet connects (from 1.47 onwards)
+     4.2 Setting up telnet connects (from 1.47 onwards)
+     4.3 Allowing telnet connects from users (before version 1.47 or for special purposes)
      4.4 Setting up for AGW Engine (1.47 onwards)
      4.5 Setting up node connects
      4.6 Connection scripts
 
   o  Data-Dumper-2.101.tar.gz   \e[4mthis\e[24m \e[4mis\e[24m \e[4mincluded\e[24m \e[4min\e[24m \e[4mperl\e[24m \e[4m5.6.1\e[24m \e[4mand\e[24m \e[4mabove\e[0m
 
-  o  TimeDate-1.10.tar.gz
+  o  TimeDate-2.27.tar.gz
 
   o  IO-1.20.tar.gz  (\e[4mfor\e[24m \e[4mperl\e[24m \e[4m5.00403\e[24m \e[4mand\e[24m \e[4mlower\e[24m)
 
   o  Net-Telnet-3.03.tar.gz
 
-  o  Curses-1.06.tar.gz
+  o  Curses-1.08a.tar.gz
 
-  o  Time-HiRes-01.20.tar.gz
+  o  Time-HiRes-01.20.tar.gz (\e[4mfor\e[24m \e[4mperl\e[24m \e[4mversions\e[24m \e[4mlower\e[24m \e[4mthan\e[24m \e[4m5.8\e[24m )
 
   o  Digest-SHA1-2.01.tar.gz
 
 
+
+  On most modern distributions most (if not all) the modules you will
+  need are either included or can be loaded automatically. Please
+  consult your distro's instructions for loading new programs and look
+  for modules that usually start with the string "perl-". For instance:-
+
+
+  o  Mandrake: urpmi perl-TimeDate perl-Digest-SHA1 perl-Curses perl-
+     Net-Telnet
+
+  o  Redhat/Fedora: up2date perl-TimeDate perl-Digest-SHA1 perl-Curses
+     perl-Net-Telnet
+
+  o  SuSE: use yast
+
+  o  Debian: use apt-get
+
+
+  Some distros are now packaging perl-DB_File separately as well, so you
+  may have to add that to the list above.
+
+
   Copy the CPAN modules listed above to a convenient place on your
   computer. One good place would be /usr/local/packages, and the
   instructions which follow will assume that that's where you have put
   Here are exactly the commands you must issue next: -
 
 
-
-  # tar xvfz /usr/local/packages/TimeDate-1.10.tar.gz
-  # cd TimeDate-1.10
+  # tar xvfz /usr/local/packages/TimeDate-2.27.tar.gz
+  # cd TimeDate-2.27
   # perl Makefile.PL
   # make test
   # make install
   # make install
   # cd ..
   #
-  # tar xvfz /usr/local/packages/Curses-1.06.tar.gz
-  # cd Curses-1.06
+  # tar xvfz /usr/local/packages/Curses-1.08a.tar.gz
+  # cd Curses-1.08a
   # perl Makefile.PL
   # make test
   # make install
 
 
 
-  Only if you need to do these (because your perl is old):-
+  Only if you need to do these because your perl is old:-
+
 
 
   #
        # Retype new UNIX password:
        passwd: all authentication tokens updated successfully
 
-
-
   \e[1m1.3.  Installing the software\e[0m
 
   Now to unpack the DX Spider distribution, set symbolic links and group
 
 
 
-  # vi /etc/group                (or your favorite editor)
+       # vi /etc/group                (or your favorite editor)
 
 
 
   Using the distributed DXVars.pm as a a template, set your cluster
   callsign, sysop callsign and other user info to suit your own
   environment.
+
+
+
        $mycall = "GB7DJK";
 
 
        $ ./client
 
 
-
   This should log you into the cluster as the sysop under the alias
   callsign we set earlier.  In this case the callsign is G0VGS.  The
   cluster callsign is set in the DXVars.pm file in /spider/local.  In
 
 
 
-  shutdown
+       shutdown
 
 
 
 
   o  Enter the correct line in /etc/services (root)
 
-
   o  Enter the correct line in /etc/inetd.conf (root)
 
   o  killall -HUP inetd (root)
   more comprehensive and an interesting configuration program is also
   available called ax25-config which may help you to configure things.
 
-
   The following files are extracts from the working files at GB7MBC and
   are in daily use.  However, there are many ways that you can configure
   the ax25 utils, this is just the one I use, it does not mean it is
   There are 2 main node packages in use of which I shall keep to the
   original by Tomi Manninen, OH2BNS as this is included in the ax25 rpms
   as standard.  The other is AWZNode by IZ5AWZ.
+
+
   NB: The AX25 stuff in 2.4 kernels appears to have been broken until
   2.4.18.  I strongly suggest you get at least this kernel.
 
        rpm -ivh ax25-apps-0.0.4-9.i386.rpm
 
 
-
   \e[1m3.4.  Configuration\e[0m
 
   You will find the configuration files in /etc/ax25.  These consist of
 
 
 
-       #portname   callsign   alias   paclen   description
-        netrom     gb7mbc-8   BARE    236      Node Netrom Port
-        netrom2    gb7mbc-9   MBCDX   236      Cluster Netrom Port
+  #portname   callsign   alias   paclen   description
+   netrom     gb7mbc-8   BARE    236      Node Netrom Port
+   netrom2    gb7mbc-9   MBCDX   236      Cluster Netrom Port
 
 
 
   The file headings are as follows ...
 
 
-
   portname        -       The name you will refer to the port by
   callsign        -       This is the callsign that NET/ROM traffic from this
                           port will use
   This is dealt with in the previous section
 
 
-  \e[1m4.2.  Allowing telnet connects from users\e[0m
+  \e[1m4.2.  Setting up telnet connects (from 1.47 onwards)\e[0m
 
+  >From version 1.47 you can choose to allow the perl cluster.pl program
+  to allow connections directly (i.e. not via the /spider/src/client
+  interface program). If you are using Windows then this is the only
+  method available of allowing incoming telnet connections.
 
-  >From version 1.47 there is a new (more efficient) way of doing this
-  (see next section) but, if you prefer, the method of doing it
-  described here will continue to work just fine.
 
+  to make the change happen...
 
-  Allowing telnet connections is quite simple.  Firstly you need to add
-  a line in /etc/services to allow connections to a port number, like
-  this ....
 
+  Having done that, you need to copy the file \e[4m/spider/perl/Listeners.pm\e[0m
+  to \e[4m/spider/local\e[24m and then edit it. You will need to uncomment the line
+  containing "0.0.0.0" and select the correct port to listen on.
 
+  It comes out of the box looking something like:-
 
-       spdlogin   8000/tcp     # spider anonymous login port
 
 
+  @listen = (
+  #    ["0.0.0.0", 7300],
+  );
 
-  Then add a line in /etc/inetd.conf like this ....
 
-       spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet
 
+  Change it so that it looks like this:-
 
 
-  Once this is done, you need to restart inetd like this ....
 
+       @listen = (
+           ["0.0.0.0", 7300],
+       );
 
 
-       killall -HUP inetd
 
+  Later versions have more comments in the Listeners.pm file that are
+  designed to help you remove the correct '#' character.
 
 
-  Now login as \e[4msysop\e[24m and cd spider/src. You can test that spider is
-  accepting telnet logins by issuing the following command ....
+  As standard, the listener will listen on all interfaces
+  simultaneously.  If you require more control than this, you can
+  specify each interface individually:-
 
 
 
-       ./client login telnet
+       @listen = (
+           ["gb7baa.dxcluster.net", 7300],
+           ["44.131.16.2", 6300],
+       );
 
 
 
-  You should get a login prompt and on issuing a callsign, you will be
-  given access to the cluster.  Note, you will not get a password login.
-  There seems no good reason for a password prompt to be given so it is
-  not asked for.
+  This will only be successful if the IP addresses on each interface are
+  static.  If you are using some kind of dynamic IP addressing then the
+  'default' method is the only one that will work.
 
 
-  Assuming all is well, then try a telnet from your linux console ....
+  Restart the cluster.pl program to enable the listener.
 
 
+  One important difference with the internal listener is that no echoing
+  is done by the cluster program. Users will need to set 'local-echo' on
+  in their telnet clients if it isn't set automatically (as per the
+  standards).  Needless to say this will probably only apply to Windows
+  users.
 
-       telnet localhost 8000
 
+  \e[1m4.3.  Allowing telnet connects from users (before version 1.47 or for\e[0m
+  \e[1mspecial purposes)\e[0m
 
 
-  You should now get the login prompt and be able to login as before.
+  >From version 1.47 there is a new (more efficient) way of doing this
+  (see previous section) but, if you prefer, the method of doing it
+  described here will continue to work just fine.
 
 
-  \e[1m4.3.  Setting up telnet connects (from 1.47 onwards)\e[0m
+  Allowing telnet connections is quite simple.  Firstly you need to add
+  a line in /etc/services to allow connections to a port number, like
+  this ....
 
-  >From version 1.47 you can choose to allow the perl cluster.pl program
-  to allow connections directly (i.e. not via the /spider/src/client
-  interface program). If you are using Windows then this is the only
-  method available of allowing incoming telnet connections.
+       spdlogin   8000/tcp     # spider anonymous login port
 
 
-  To do this you need first to remove any line that you may previously
-  have set up in /etc/inetd.conf. Remember to:-
 
+  Then add a line in /etc/inetd.conf like this ....
 
 
-       killall -HUP inetd
 
+       spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet
 
 
-  to make the change happen...
 
+  Once this is done, you need to restart inetd like this ....
 
-  Having done that, you need to copy the file \e[4m/spider/perl/Listeners.pm\e[0m
-  to \e[4m/spider/local\e[24m and then edit it. You will need to uncomment the line
-  containing "0.0.0.0" and select the correct port to listen on. So that
-  it looks like this:-
 
 
+       killall -HUP inetd
 
-       @listen = (
-           ["0.0.0.0", 8000],
-       );
 
 
+  Now login as \e[4msysop\e[24m and cd spider/src. You can test that spider is
+  accepting telnet logins by issuing the following command ....
 
-  As standard, the listener will listen on all interfaces
-  simultaneously.  If you require more control than this, you can
-  specify each interface individually:-
 
 
+       ./client login telnet
 
-       @listen = (
-           ["gb7baa.dxcluster.net", 8000],
-           ["44.131.16.2", 6300],
-       );
 
 
+  You should get a login prompt and on issuing a callsign, you will be
+  given access to the cluster.  Note, you will not get a password login.
+  There seems no good reason for a password prompt to be given so it is
+  not asked for.
 
-  This will only be successful if the IP addresses on each interface are
-  static.  If you are using some kind of dynamic IP addressing then the
-  'default' method is the only one that will work.
 
+  Assuming all is well, then try a telnet from your linux console ....
 
-  Restart the cluster.pl program to enable the listener.
 
 
-  One important difference with the internal listener is that no echoing
-  is done by the cluster program. Users will need to set 'local-echo' on
-  in their telnet clients if it isn't set automatically (as per the
-  standards).  Needless to say this will probably only apply to Windows
-  users.
+       telnet localhost 8000
+
+
+
+  You should now get the login prompt and be able to login as before.
+
 
 
   \e[1m4.4.  Setting up for AGW Engine (1.47 onwards)\e[0m
   In order to enable access to an AGW Engine you need to copy
   \e[4m/spider/perl/AGWConnect.pm\e[24m to \e[4m/spider/local\e[24m and edit it.  Specifically
   you must:-
-
-
   o  set $enable to 1.
 
   o  set $login and $passwd to the values set up in your AGW
      installation.  If you haven't set any there, then you should not
      touch these values.
 
-
   o  You can connect to a remote AGW engine (ie on some other machine)
      by changing $addr and $port appropriately.
 
   another console as sysop, cd to spider/src and issue the command ...
 
 
-
        ./client gb7baa (using the callsign you set as a node)
 
 
 
 
 
-       timeout 15
-       connect telnet dirkl.tobit.co.uk
-       # tell GB7DJK-1 that it is connected to GB7DJK
-       # you can leave this out if you call this script 'gb7djk'
-       client gb7djk telnet
+  timeout 15
+  connect telnet dirkl.tobit.co.uk
+  # tell GB7DJK-1 that it is connected to GB7DJK
+  # you can leave this out if you call this script 'gb7djk'
+  client gb7djk telnet
+
+
 
   Both these examples assume that everything is set up properly at the
   other end.  You will find other examples in the /spider/examples
   This means if a node is unreachable, it will continue sending logins
   and logouts to users even though it is not actually connecting.  To
   avoid this use the following line ...
+
+
+
   In a script, this might look like ...
 
 
   automatically.
 
 
-
   This is not only a way to start the cluster automatically, it also
   works as a watchdog, checking the sanity of DXSpider and respawning it
   should it crash for any reason.  Before doing the following, shutdown
   tty you run it on.
 
 
+
   As root type the command \e[4mtelinit\e[24m \e[4mq\e[24m.  DXSpider should start up
   immediately.  You will see the output on tty7 and if you login as
   \e[4msysop\e[24m you should find everything running nicely.
   any platform that has reasonably complete support for Perl. Is there
   someone out there with both an enquiring mind and (say) a Macintosh,
   for instance?
-
   Please bear in mind, though, that my instructions relate solely to how
   to get this going under a Microsoft Windows environment, and I have
   zero intention of trying to make them say otherwise.
   noticable difficulty.)  You can get this from:
   http://www.activestate.com/Products/ActivePerl/Download.html
 
-
   The link takes you to an initial page of System Requirements and
   Software Prerequisites.  If you do not have it already installed, you
   can download and install the Windows Installer 2.0 for a Win98
 
 
 
-  D:\ppm>ppm install Data-Dumper.ppd
-  Installing package 'Data-Dumper.ppd'
-  Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.bs
-  Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.dll
-  Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.exp
-  Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.lib
-  Installing D:\Perl\html\site\lib\auto\Data\Dumper\Dumper.html
-  Installing D:\Perl\site\lib\Data\Dumper\Dumper.pm
-  Writing D:\Perl\site\lib\auto\Data\Dumper\Dumper.packlist
-  D:\ppm>
+       D:\ppm>ppm install Data-Dumper.ppd
+       Installing package 'Data-Dumper.ppd'
+       Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.bs
+       Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.dll
+       Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.exp
+       Installing D:\Perl\site\lib\auto\Data\Dumper\Dumper.lib
+       Installing D:\Perl\html\site\lib\auto\Data\Dumper\Dumper.html
+       Installing D:\Perl\site\lib\Data\Dumper\Dumper.pm
+       Writing D:\Perl\site\lib\auto\Data\Dumper\Dumper.packlist
+       D:\ppm>
 
 
 
   unstable. Generally, there will be a note on the website if this is
   the case.
 
-
   The only difference between "CVSlatest.tgz" and the latest "official"
   release version is that it is more up to date. \e[1mDo not confuse the\e[0m
   \e[1m"CVSlatest.tgz" file with "Downloading from Sourceforge with CVS" -\e[0m
 
   o  $mycall  - Should hold the callsign of your DX Cluster
 
+
   o  $myname  - The SysOp's first name
 
   o  $myalias - the SysOp's callsign. Cannot be the same as $mycall!
   o  $mylongitude - The station longitude in degrees and decimal
      fractions
 
-
   o  $mylocator - The Maidenhead (or QRA) locator of the station
 
   You really also ought to update the $myqth and $myemail variables. And
   somesuch), then you need to have the machine listening at least to
   "127.0.0.1" ("0.0.0.0" means \e[1mall \e[22mIP addresses).
 
-
   \e[1m6.2.  The AGW packet engine\e[0m
 
   On the assumption that you'll be using the SV2AGW Packet Engine to
        cd \spider\perl
        perl create_sysop.pl
 
-
-
   If all goes according to plan, you will see no output from this
   program, and after a brief wait, your DOS prompt will be returned.
 
   following:-
 
 
+
        perl cluster.pl
 
 
 
 
 
-       Menu->Start->Run
-       telnet localhost 7300
+  Menu->Start->Run
+  telnet localhost 7300
 
 
 
   On getting the \e[1mlogin: \e[22mprompt, enter your sysop callsign (the one you
   put in DXVars.pm as $myalias).
+
+
   I would recommend \e[1mstrongly \e[22mthat you obtain a better telnet client than
   that which comes with windows (I use PuTTY).
 
 
 
 
-       # check every 10 minutes to see if gb7xxx is connected and if not
-       # start a connect job going
+  # check every 10 minutes to see if gb7xxx is connected and if not
+  # start a connect job going
 
-       0,10,20,30,40,50 * * * * start_connect('gb7xxx') unless connected('gb7xxx')
+  0,10,20,30,40,50 * * * * start_connect('gb7xxx') unless connected('gb7xxx')
 
 
 
   going to connect to.  This will now check every 10 minutes to see if
   gb7xxx is connected, if it is then nothing will be done.  If it is
   not, then a connect attempt will be started.
+
+
   There are probably lots of other things you could use this crontab
   file for.  If you want to know more about it, look at the DXSpider
   website at the cron page where it is explained more fully.