make additions and changes to manuals
[spider.git] / html / installation-6.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 Manual v1.50: Installing the software</TITLE>
6  <LINK HREF="installation-7.html" REL=next>
7  <LINK HREF="installation-5.html" REL=previous>
8  <LINK HREF="installation.html#toc6" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="installation-7.html">Next</A>
13 <A HREF="installation-5.html">Previous</A>
14 <A HREF="installation.html#toc6">Contents</A>
15 <HR>
16 <H2><A NAME="s6">6. Installing the software</A></H2>
17
18 <P>Ensure that your CVS session or your WINunZIPped file have left you with
19 a directory "C:\spider\local" and C:\spider\local_cmd"; if not, go to
20 "C:\spider\" and create them. If "C:\spider" is missing, go back and
21 figure out why, because it shouldn't be.
22 <P>Now create your own local copy of the DXVars.pm file by:-
23 <P>
24 <BLOCKQUOTE><CODE>
25 <PRE>
26 copy c:\spider\perl\DXVars.pm.issue
27 c:\spider\local\DXVars.pm
28 </PRE>
29 </CODE></BLOCKQUOTE>
30 <P>Now you'll need to edit this file using a text editor. If nothing
31 else, you can simply
32 <P>
33 <BLOCKQUOTE><CODE>
34 <PRE>
35 cd \spider\local
36 </PRE>
37 </CODE></BLOCKQUOTE>
38 <P>and then
39 <P>
40 <BLOCKQUOTE><CODE>
41 <PRE>
42 notepad DXVars.pm
43 </PRE>
44 </CODE></BLOCKQUOTE>
45 <P>to bring up an editor window containing the file. As an absolute
46 minimum you must adjust the following items in DXVars.pm:-
47 <P>
48 <UL>
49 <LI> $mycall  - Should hold the callsign of your DX Cluster</LI>
50 <LI> $myname  - The SysOp's first name</LI>
51 <LI> $myalias - the SysOp's callsign. Cannot be the same as $mycall!</LI>
52 <LI> $myqth - The station's geographical location (QTH).</LI>
53 <LI> $mylatitude - The station latitude in degrees and decimal fractions</LI>
54 <LI> $mylongitude - The station longitude in degrees and decimal fractions</LI>
55 <LI> $mylocator - The Maidenhead (or QRA) locator of the station </LI>
56 </UL>
57 <P>You really also ought to update the $myqth and $myemail variables. And
58 unless you are absolutely certain you know what you're doing, you
59 should change nothing else in this file. Note that if you use an "@" or 
60 a "$" character in one of the above strings (typically in $myemail) you must 
61 write them as "\@" or "\$". 
62 <P>
63 <P>
64 <H2><A NAME="ss6.1">6.1 Incoming telnets</A>
65 </H2>
66
67 <P>If you want to enable inbound "TELNET" connections (or you are running
68 Windows NT, 2000 or XP), you've got a little more work to do. From a
69 handy "DOS box" that's not doing anything else, do the following:-
70 <P>
71 <BLOCKQUOTE><CODE>
72 <PRE>
73 copy \spider\perl\Listeners.pm \spider\local
74 cd \spider\local
75 notepad listeners.pm
76 </PRE>
77 </CODE></BLOCKQUOTE>
78 <P>The following lines need attention:-
79 <P>
80 <BLOCKQUOTE><CODE>
81 <PRE>
82 ["0.0.0.0", 7300],
83 </PRE>
84 </CODE></BLOCKQUOTE>
85 <P>On my machine, I've simply uncommented the "0.0.0.0" entry by
86 removing the '#' from the front of the line. 
87 <P><B>You MUST carry out this step if you are
88 running on a Windows NT, 2000 or XP based system</B>
89 <P>If you don't have a static hostname for your machine, and you
90 intend to allow folk to connect to your machine across the
91 internet, then I'd suggest you pay a visit to www.dyndns.org and
92 create one for yourself. While it's free, it will take a modest
93 an amount of effort on your part to read, understand and
94 implement what needs to be done to set this up.
95 <P>
96 <P>If your machine is connected to the internet <B>and</B> you don't
97 want to allow your machine to be visible to the outside world you
98 should change the "0.0.0.0" to "127.0.0.1" [which is
99 "localhost"]. This will then only allow connections from inside your
100 machine. As was said earlier: if you aren't running Win9x (or you want
101 to use DXTelnet or somesuch), then you need to have the machine
102 listening at least to "127.0.0.1" ("0.0.0.0" means <B>all</B> IP
103 addresses).
104 <P>
105 <H2><A NAME="ss6.2">6.2 The AGW packet engine</A>
106 </H2>
107
108 <P>On the assumption that you'll be using the SV2AGW Packet Engine
109 to interface your radios to the cluster, you should now create
110 your own local copy of AGWConnect.pm by:-
111 <P>
112 <BLOCKQUOTE><CODE>
113 <PRE>
114 copy c:\spider\perl\AGWConnect.pm
115 c:\spider\local\AGWConnect.pm
116 </PRE>
117 </CODE></BLOCKQUOTE>
118 <P>and then
119 <P>
120 <BLOCKQUOTE><CODE>
121 <PRE>
122 notepad AGWConnect.pm
123 </PRE>
124 </CODE></BLOCKQUOTE>
125 <P>to bring up an editor window containing the file. You must
126 consider adjusting the following items in AGWConnect.pm:-
127 <P>
128 <UL>
129 <LI>$enable - set to '1' to enable AGWPE interface </LI>
130 <LI>$login  - the login ID you chose when you set up the SV2AGW security :-)</LI>
131 <LI>$passwd - password that matches $login</LI>
132 </UL>
133 <P>
134 <H2><A NAME="ss6.3">6.3 Setting up the initial user files</A>
135 </H2>
136
137 <P>Next you need to create the initial user files, etc. A tool is
138 supplied which will do this for you. To run the tool:-
139 <P>
140 <BLOCKQUOTE><CODE>
141 <PRE>
142 cd \spider\perl
143 perl create_sysop.pl
144 </PRE>
145 </CODE></BLOCKQUOTE>
146 <P>If all goes according to plan, you will see no output from this
147 program, and after a brief wait, your DOS prompt will be
148 returned.
149 <P>Depending on how brave you are, you might now care to try the
150 following:-
151 <P>
152 <BLOCKQUOTE><CODE>
153 <PRE>
154 perl cluster.pl
155 </PRE>
156 </CODE></BLOCKQUOTE>
157 <P>If you did everything you were told, your DOS window will now
158 hold a display which looks something like:-
159 <P>
160 <BLOCKQUOTE><CODE>
161 <PRE>
162 DXSpider DX Cluster Version 1.47
163 Copyright (c) 1998-2001 Dirk Koopman G1TLH
164 loading prefixes ...
165 loading band data ...
166 loading user file system ...
167 starting listeners ...
168 Internal port: localhost 27754
169 load badwords: Ok
170 reading in duplicate spot and WWV info ...
171 reading existing message headers ...
172 load badmsg: Ok
173 load forward: Ok
174 load swop: Ok
175 @msg = 0 before delete
176 @msg = 0 after delete
177 reading cron jobs ...v cron: reading /spider/cmd/crontab
178 cron: adding 1 0 * * 0
179 DXUser::export("$main::data/user_asc")
180 reading database descriptors ...
181 doing local initialisation ...
182 orft we jolly well go ...
183 queue msg (0)
184 </PRE>
185 </CODE></BLOCKQUOTE>
186 <P>Now, if that's what you've got, you are very nearly home and dry
187 (in as far as these particular experiments are concerned, anyhow)
188 <P>If you are running Windows 9x you can access your new cluster (from
189 the local machine) by finding yourself another "DOS box" and doing the
190 following:-
191 <P>
192 <BLOCKQUOTE><CODE>
193 <PRE>
194 cd \spider\perl
195 perl winclient.pl
196 </PRE>
197 </CODE></BLOCKQUOTE>
198 <P>If you are running Windows NT, 2000 or XP then winclient.pl does not
199 work. We don't know why other than this seems to be some kind of
200 incomaptibility in perl. You can achieve the same thing by telnetting
201 to the port you defined in Listeners.pm (7300 as default), thus:-
202 <P>
203 <BLOCKQUOTE><CODE>
204 <PRE>
205 Menu->Start->Run
206 telnet localhost 7300
207 </PRE>
208 </CODE></BLOCKQUOTE>
209 <P>On getting the <B>login:</B> prompt, enter your sysop callsign (the one you
210 put in DXVars.pm as $myalias).
211 <P>
212 <P>I would recommend <B>strongly</B> that you obtain a better telnet
213 client than that which comes with windows (I use 
214 <A HREF="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">PuTTY</A>). 
215 <P>
216 <P>Anyway, if you are rewarded with a display which looks something like:-
217 <P>
218 <BLOCKQUOTE><CODE>
219 <PRE>
220 Hello Iain, this is GB7SJP in Amersham, Bucks running DXSpider V1.47
221 Cluster: 1 nodes, 1 local / 1 total users Max users 2 Uptime 0 00:00
222 M0ADI de GB7SJP 4-Mar-2001 1511Z >
223 </PRE>
224 </CODE></BLOCKQUOTE>
225 <P>You've arrived. Try some commands, and see how they feel. (In
226 case you were wondering, "Iain", "M0ADI" and "GB7SJP" all came
227 from the version of DXVars.pm that was on the machine when I
228 started the winclient.pl)
229 <P>
230 <P>The interface is very basic. It is a simple command line. There are
231 better looking interfaces. Most of the "standard" logging and DX
232 Cluster access programs that are capable of connecting via a TCP or
233 telnet connection will work as a "Sysop Console" client. You connect
234 to "localhost" on the port that you defined in Listeners.pm (usually
235 7300). I recommend packages like 
236 <A HREF="http://www.qsl.net/wd4ngb/telnet.htm">DXTelnet</A>.
237 <P>
238 <H2><A NAME="ss6.4">6.4 Connecting to other clusters</A>
239 </H2>
240
241 <P>If you want to connect this to another cluster, then you'll want to
242 negotiate a link with someone. For experimental purposes, I'm happy to
243 allow folk to connect to GB7DXA (spud.ath.cx), on the understanding
244 that the system may or may not be there and may or may not be
245 connected to anything particularly useful at any given moment. Contact
246 me by 
247 <A HREF="mailto:g0rdi@blacksheep.org">Email</A> if you
248 want me to set up a connection for you.
249 <P>
250 <HR>
251 <A HREF="installation-7.html">Next</A>
252 <A HREF="installation-5.html">Previous</A>
253 <A HREF="installation.html#toc6">Contents</A>
254 </BODY>
255 </HTML>