Changes to Manual
[spider.git] / html / adminmanual-1.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
5  <TITLE>The DXSpider Installation and Administration Manual : Installation (Original version by Iain Phillips, G0RDI)</TITLE>
6  <LINK HREF="adminmanual-2.html" REL=next>
7
8  <LINK HREF="adminmanual.html#toc1" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual-2.html">Next</A>
13 Previous
14 <A HREF="adminmanual.html#toc1">Contents</A>
15 <HR>
16 <H2><A NAME="s1">1. Installation (Original version by Iain Phillips, G0RDI)</A></H2>
17
18 <P>Last modified: 24 January 2001 by Ian Maude, G0VGS
19 <P>
20 <H2><A NAME="ss1.1">1.1 Introduction</A>
21 </H2>
22
23 <P>This section describes the installation of DX Spider v1.35 on a 
24 <A HREF="http://www.redhat.com">RedHat</A> Linux Distribution.  
25 I do not intend to try and cover the installation of Linux or the setup 
26 of the AX25 utilities.  If you need help on this then read Iains original 
27 HOWTO on the 
28 <A HREF="http://www.dxcluster.org">DXSpider</A> 
29 website.
30 <P>
31 <P>I am assuming a general knowledge of Linux and its commands.  You should 
32 know how to use <EM>tar</EM> and how to edit files using your favourite editor.
33 <P>
34 <P>The crucial ingredient for all of this is 
35 <A HREF="http://www.perl.org">Perl 5.004</A>.  Now I know Perl 5.005 
36 is out and this will almost certainly work with it, but 
37 <A HREF="http://www.redhat.com">RedHat 5.1</A> comes with 5.004. 
38 <EM>Be Warned</EM>, earlier versions of 
39 <A HREF="http://www.redhat.com">RedHat</A> <B>do not</B> come 
40 with 5.004 as standard, you need to 
41 <A HREF="ftp://upgrade.redhat.com">upgrade</A><P>
42 <P>In addition to the standard Red Hat distribution you will require the 
43 following 
44 <A HREF="http://www.cpan.org/CPAN.html">CPAN</A> modules: -
45 <P>
46 <P>
47 <UL>
48 <LI>            MD5-1.7.tar.gz</LI>
49 <LI>            Data-Dumper-2.10.tar.gz</LI>
50 <LI>            FreezeThaw-0.3.tar.gz</LI>
51 <LI>            MLDBM-2.00.tar.gz</LI>
52 <LI>            TimeDate-1.08.tar.gz</LI>
53 <LI>            IO-1.20.tar.gz</LI>
54 <LI>            Net-Telnet-3.02.tar.gz</LI>
55 <LI>            Curses-1.05.tar.gz</LI>
56 <LI>            Time-HiRes-01.20.tar.gz
57 </LI>
58 </UL>
59 <P>
60 <P>
61 <P><EM>Do</EM> get the latest versions of these packages and install them 
62 but use the above list as the earliest versions usable.
63 <P>
64 <H2><A NAME="ss1.2">1.2 Preparation</A>
65 </H2>
66
67 <P>I will assume that you have already downloaded the latest tarball of 
68 the DXSpider software and are ready to install it. I am assuming version 
69 1.35 for this section but of course you would use the latest version.
70 <P>
71 <P>Login as root and create a user to run the cluster under.  <B><I>UNDER 
72 NO CIRCUMSTANCES USE ROOT AS THIS USER!</I></B>.  I am going to use 
73 the name <EM>sysop</EM>.  You can call it anything you wish.  Depending 
74 on your security requirements you may wish to use an existing user, 
75 however this is your own choice.
76 <P>
77 <P>
78 <BLOCKQUOTE><CODE>
79 <PRE>
80 # adduser -m sysop
81 </PRE>
82 </CODE></BLOCKQUOTE>
83 <P>
84 <P>Now set a password for the user ...
85 <P>
86 <BLOCKQUOTE><CODE>
87 <PRE>
88 # passwd sysop
89 # New UNIX password:
90 # Retype new UNIX password:
91 passwd: all authentication tokens updated successfully
92 </PRE>
93 </CODE></BLOCKQUOTE>
94 <P>
95 <H2><A NAME="ss1.3">1.3 Installing the software</A>
96 </H2>
97
98 <P>Now to unpack the DX Spider distribution, set symbolic links and group 
99 permissions.  Copy the tarball to /home/sysop and do the following.
100 <P>
101 <BLOCKQUOTE><CODE>
102 <PRE>
103 # cd ~sysop
104 # tar xvfz spider-1.35.tar.gz
105 # ln -s ~sysop/spider /spider
106 # groupadd -g 251 spider       (or another number)
107 </PRE>
108 </CODE></BLOCKQUOTE>
109 <P>If you do not have the command <EM>groupadd</EM> available to you simply 
110 add a line in /etc/group by hand.
111 <P>
112 <BLOCKQUOTE><CODE>
113 <PRE>
114 # vi /etc/group                (or your favorite editor)
115 </PRE>
116 </CODE></BLOCKQUOTE>
117 <P>You also need to add some others to the group, including your own callsign 
118 (this will be used as an alias) and root.  The finished line in /etc/group 
119 should look something like this
120 <P><CODE>spider:x:251:sysop,g0vgs,root</CODE>
121 <P>
122 <P>The next step is to set the permissions on the Spider directory tree and files ....
123 <P>
124 <BLOCKQUOTE><CODE>
125 <PRE>
126 # chown -R sysop.spider spider
127 # find . -type d -exec chmod 2775 {} \;
128 # find . -type f -exec chmod 775 {} \;
129 </PRE>
130 </CODE></BLOCKQUOTE>
131 <P>
132 <P>This last step allows various users of the group <EM>spider</EM> to have 
133 write access to all the directories.  This is not really needed just yet 
134 but will be useful when web interfaces start to appear.
135 <P>
136 <P>Finally, you need to fix the permissions on the ax25_call and netrom_call 
137 programs.  Check where they are with the <EM>locate</EM> command and alter 
138 the permissions with the <EM>chmod</EM> command like this ..
139 <P>
140 <BLOCKQUOTE><CODE>
141 <PRE>
142 # chown root ax25_call netrom_call
143 # chmod 4775 ax25_call netrom_call
144 </PRE>
145 </CODE></BLOCKQUOTE>
146 <P>
147 <H2><A NAME="ss1.4">1.4 Setting callsigns etc</A>
148 </H2>
149
150 <P>Now login to your machine as the user you created earlier.  In my case that 
151 user is called <EM>sysop</EM>.  Once logged in, issue the following commands ....
152 <P>
153 <BLOCKQUOTE><CODE>
154 <PRE>
155 $ cd /spider
156 $ mkdir local
157 $ mkdir local_cmd
158 $ cp perl/DXVars.pm.issue local/DXVars.pm
159 $ cd local
160 $ vi DXVars.pm (or your favourite editor)
161 </PRE>
162 </CODE></BLOCKQUOTE>
163 <P>
164 <P>Using the distributed DXVars.pm as a a template, set your cluster callsign, 
165 sysop callsign and other user info to suit your own environment. Note that 
166 this a perl file which will be parsed and executed as part of the cluster. If 
167 you get it wrong then perl will complain when you start the cluster process.  
168 It is important only to alter the text of any section.  Some of the lines look 
169 a little odd.  Take this line for example ....
170 <P><CODE>$myemail = "ianmaude\@btinternet.com";</CODE>
171 <P>
172 <P>There appears to be an extra slash in there.  However this has to be there 
173 for the file to work so leave it in.
174 <P>
175 <P><B>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</B>
176 <P>
177 <P>DON'T alter the DXVars.pm (or any other file) in /spider/perl, they are 
178 overwritten with every release. Any files or commands you place in /spider/local 
179 or /spider/local_cmd will automagically be used in preference to the ones in 
180 /spider/perl EVEN while the cluster is running!
181 <P>
182 <P>Save the new file and change directory to ../perl ....
183 <P>
184 <BLOCKQUOTE><CODE>
185 <PRE>
186 $ cd ../perl
187 </PRE>
188 </CODE></BLOCKQUOTE>
189 <P>
190 <P>Now type the following command which creates the basic user file with you as 
191 the sysop.
192 <P>
193 <BLOCKQUOTE><CODE>
194 <PRE>
195 $ create_sysop.pl
196 </PRE>
197 </CODE></BLOCKQUOTE>
198 <P>
199 <H2><A NAME="ss1.5">1.5 Starting up for the first time</A>
200 </H2>
201
202 <P>We can now bring spider up for the first time and see if all is well or not!  
203 It should look something like this ...
204 <P>
205 <BLOCKQUOTE><CODE>
206 <PRE>
207 $ cluster.pl
208 DXSpider DX Cluster Version 1.35
209 Copyright (c) 1998 Dirk Koopman G1TLH
210 loading prefixes ...
211 loading band data ...
212 loading user file system ...
213 starting listener ...
214 reading existing message headers
215 reading cron jobs
216 orft we jolly well go ...
217 </PRE>
218 </CODE></BLOCKQUOTE>
219 <P>
220 <P>If all is well then login on another term or console as <EM>sysop</EM> and 
221 cd to /spider/perl.  Now issue the following command ...
222 <P>
223 <BLOCKQUOTE><CODE>
224 <PRE>
225 $ client.pl
226 </PRE>
227 </CODE></BLOCKQUOTE>
228 <P>
229 <P>This should log you into the cluster as the sysop under the alias callsign we 
230 set earlier.  In this case the callsign is G0VGS.  The cluster callsign is set 
231 in the DXVars.pm file in /spider/local.  In this case we will assume that this 
232 was set as GB7MBC.  You should therefore see this when you login ....
233 <P>
234 <BLOCKQUOTE><CODE>
235 <PRE>
236 G0VGS de GB7MBC 19-Nov-1999 2150Z >
237 </PRE>
238 </CODE></BLOCKQUOTE>
239 <P>If you do, congratulations!  If not, look over the instructions again, you 
240 have probably missed something out.  You can shut spider down again with the 
241 command ....
242 <P>
243 <BLOCKQUOTE><CODE>
244 <PRE>
245 shutdown
246 </PRE>
247 </CODE></BLOCKQUOTE>
248 <P>
249 <P>and both the cluster and the client should return to Linux prompts.
250 <P>
251 <HR>
252 <A HREF="adminmanual-2.html">Next</A>
253 Previous
254 <A HREF="adminmanual.html#toc1">Contents</A>
255 </BODY>
256 </HTML>