added installation notes and licence
[spider.git] / INSTALL
diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..3a5dc6e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,157 @@
+DXSPIDER INSTALLATION
+
+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.
+
+In addition to the standard perl5 distribution you will require to load the
+the following modules:-
+
+1) CPAN - this has a load of the standard extra stuff in it. To load it type:-
+
+  # perl -MCPAN -e shell
+  cpan> install Bundle::CPAN
+  cpan> q
+  
+  Please sure there were no errors, be particularly careful when installing
+  libwww stuff, I would suggest 'no host lookups' and pressing <space> and
+  enter for each of the offered default hostnames.
+  
+2) Date::Parse, MLDBM, IO::Select
+  
+  As you have so carefully loaded it, I suggest you use the CPAN system
+  above:-
+  
+  # perl -MCPAN -e shell
+  cpan> install Date::Parse
+  ..
+  ..
+  cpan> install MLDBM
+  ..
+  ..
+  cpan> install IO::Select
+  
+3) select a user to run the cluster as UNDER _NO_ CIRCUMSTANCES USE ROOT.
+
+   I say again DO NOT USE root.
+   
+   Pick an existing user or create a new one. Don't care which. I don't know
+   your security requirements.
+   
+4) login as root (I shall use 'jim' for any examples).
+
+5) # 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)
+     add jim (or whatever) and root to the group spider
+     it should look something like:-
+        
+        spider:x:251:jim,root
+        :x
+   # chown -R jim.spider spider
+   # find . -type d -exec chmod 2775 {} \;
+   # find . -type f -exec chmod 775 {} \;
+   
+   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.
+
+6) if you have any users that require network logins, set them up as real
+   users with useradd -m <callsign>. Alter the default .bashrc so that it
+   contains just one line (assuming you use the default bash shell).
+   
+   exec /spider/perl/client.pl <callsign>
+   
+   Don't forget to give them a real password. This is really for network
+   cluster logins
+   
+7) 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:-
+   
+   [ether]                                                                         
+   NOCALL   * * * * * *  L                                                         
+   default  * * * * * *  - djk /spider/perl/client.pl client.pl %u ax25
+   <bbs>
+   NOCALL   * * * * * *  L                                                         
+   default  * * * * * *  - djk /spider/perl/client.pl client.pl %u ax25
+
+   where ether and bbs are appropriate KNOWN WORKING 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.
+   
+8) login as jim (or whatever)
+   $ startx                     (much easier to use X)
+   $ cd /spider
+   $ mkdir local
+   $ mkdir local_cmd
+   $ cp perl/DXVars.pm local
+   $ cd local
+   $ vi DXVars.pm
+   
+   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.
+   
+   PLEASE USE CAPITAL LETTERS FOR CALLSIGNS
+   
+   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!
+   
+   :x
+   
+   $ cd ../perl
+   $ cluster.pl
+   DXSpider DX Cluster Version x.x
+   Copyright (c) 1998 Dirk Koopman G1TLH
+   loading prefixes ...
+   loading band data ...
+   loading user file system ...
+   starting listener ...
+   reading existing message headers
+   reading cron jobs
+   orft we jolly well go ...
+   
+   
+9) now log in again or start another rxvt or xterm
+   $ client.pl
+   
+   you should now see a normal cluster prompt.
+   
+   at the cluster prompt:-
+   
+   G1JIM de GB7JIM 10-Sep-98 1000Z> set/node GB7XXX
+   
+   for every dxcluster you expect to connect to or from.
+
+   G1JIM de GB7JIM 10-Sep-98 1001Z> shutdown
+   
+   The cluster and the client should both go back to prompts
+   
+   Restart the cluster.
+   
+   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:-
+   
+   $ client.pl gb7xxx      (doesn't have to be uppercase).
+   PC38^GB7JIM^~           <- the cluster thinks this is a cluster
+   ^C                      <- to get out
+   
+   
+   
+
+   
+