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