*** empty log message ***
[spider.git] / INSTALL
1 DXSPIDER INSTALLATION
2
3 This version of dxspider requires perl5 (it is written entirely in perl5 and
4 makes extensive use of perl objects). This program is known to work with
5 RedHat 5.1 perl5_004.
6
7 In addition to the standard perl5 distribution you will require to load the
8 the following modules:-
9
10 1) CPAN - this has a load of the standard extra stuff in it. To load it type:-
11
12   # perl -MCPAN -e shell
13   cpan> install Bundle::CPAN
14   cpan> q
15   
16   Please sure there were no errors, be particularly careful when installing
17   libwww stuff, I would suggest 'no host lookups' and pressing <space> and
18   enter for each of the offered default hostnames.
19   
20 2) Date::Parse, MLDBM, IO::Select
21   
22   As you have so carefully loaded it, I suggest you use the CPAN system
23   above:-
24   
25   # perl -MCPAN -e shell
26   cpan> install Date::Parse
27   ..
28   ..
29   cpan> install MLDBM
30   ..
31   ..
32   cpan> install IO::Select
33   
34 3) select a user to run the cluster as UNDER _NO_ CIRCUMSTANCES USE ROOT.
35
36    I say again DO NOT USE root.
37    
38    Pick an existing user or create a new one. Don't care which. I don't know
39    your security requirements.
40    
41 4) login as root (I shall use 'jim' for any examples).
42
43 5) # cd ~jim
44    # tar xvfz spider-x.x.tar.gz
45    # ln -s ~jim/spider /spider
46    # groupadd -g 251 spider       (or another number)
47    # vi /etc/group                (or your favorite editor)
48      add jim (or whatever) and root to the group spider
49      it should look something like:-
50          
51          spider:x:251:jim,root
52          :x
53    # chown -R jim.spider spider
54    # find . -type d -exec chmod 2775 {} \;
55    # find . -type f -exec chmod 775 {} \;
56    
57    This last step allows various users of group spider to have write
58    access to all the directories. Not really needed for now but will 
59    be useful when web interfaces start to appear.
60
61 6) if you have any users that require network logins, set them up as real
62    users with useradd -m <callsign>. Alter the default .bashrc so that it
63    contains just one line (assuming you use the default bash shell).
64    
65    exec /spider/perl/client.pl <callsign> telnet
66    
67    Don't forget to give them a real password. This is really for network
68    cluster logins. The telnet argument does two things, it sets the EOL 
69    convention to \n rather than AX25's \r and it automatically reduces
70    the privilege of the <callsign> to a 'safe[r]' level.
71    
72 7) for incoming AX25 connections you are expected to have got the AX25
73    utilities setup, tested and working. See the AX25-HOWTO for more info
74    on this - it really is outside the scope of this document. I would 
75    recommend using ax25-utils-2.1.42a-5.i386.rpm or above as a starting 
76    point. DXSpider uses ax25d for incoming connections. You need to have 
77    entries like this:-
78    
79    [ether]                                                                         
80    NOCALL   * * * * * *  L                                                         
81    default  * * * * * *  - djk /spider/perl/client.pl client.pl %u ax25
82    <bbs>
83    NOCALL   * * * * * *  L                                                         
84    default  * * * * * *  - djk /spider/perl/client.pl client.pl %u ax25
85
86    where ether and bbs are appropriate KNOWN WORKING axport and nrport 
87    names respectively.
88    
89    Obviously you can use different names, callsigns or whatever for your 
90    purposes, but it is up to you to get it to work. 
91    
92    Note I use BPQ over ethernet which why I have the port names I have.
93    
94 8) login as jim (or whatever)
95    $ startx                     (much easier to use X)
96    $ cd /spider
97    $ mkdir local
98    $ mkdir local_cmd
99    $ cp perl/DXVars.pm local
100    $ cd local
101    $ vi DXVars.pm
102    
103    now alter your cluster callsign, sysop callsign and other user info 
104    as you wish. Note that this a perl file which will parsed and executed
105    as part of the cluster. If you get it wrong then perl will complain 
106    when you start the cluster process.
107    
108    PLEASE USE CAPITAL LETTERS FOR CALLSIGNS
109    
110    DON'T alter the DXVars.pm (or any other file) in /spider/perl, they are
111    overwritten with every release. Any files or commands you place in
112    /spider/local or /spider/local_cmd will automagically be used in preference
113    to the ones in /spider/perl EVEN whilst the cluster is running!
114    
115    :x
116    
117    $ cd ../perl
118    $ cluster.pl
119    DXSpider DX Cluster Version x.x
120    Copyright (c) 1998 Dirk Koopman G1TLH
121    loading prefixes ...
122    loading band data ...
123    loading user file system ...
124    starting listener ...
125    reading existing message headers
126    reading cron jobs
127    orft we jolly well go ...
128    
129    
130 9) now log in again or start another rxvt or xterm
131    $ client.pl
132    
133    you should now see a normal cluster prompt.
134    
135    at the cluster prompt:-
136    
137    G1JIM de GB7JIM 10-Sep-98 1000Z> set/node GB7XXX
138    
139    for every dxcluster you expect to connect to or from.
140
141    G1JIM de GB7JIM 10-Sep-98 1001Z> shutdown
142    
143    The cluster and the client should both go back to prompts
144    
145    Restart the cluster.
146    
147    The callsigns should be the sysop callsign and the cluster callsign
148    as per your modified DXVars.pm. You can check that the cluster 
149    connections will work by:-
150    
151    $ client.pl gb7xxx      (doesn't have to be uppercase).
152    PC38^GB7JIM^~           <- the cluster thinks this is a cluster
153    ^C                      <- to get out
154    
155    
156    
157
158    
159