Add changes to the installation manual for Windows users from K1XX
[spider.git] / html / installation-4.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: Configuration</TITLE>
6  <LINK HREF="installation-5.html" REL=next>
7  <LINK HREF="installation-3.html" REL=previous>
8  <LINK HREF="installation.html#toc4" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="installation-5.html">Next</A>
13 <A HREF="installation-3.html">Previous</A>
14 <A HREF="installation.html#toc4">Contents</A>
15 <HR>
16 <H2><A NAME="s4">4. Configuration</A></H2>
17
18 <H2><A NAME="ss4.1">4.1 Allowing ax25 connects from users</A>
19 </H2>
20
21 <P>This is dealt with in the previous section
22 <P>
23 <H2><A NAME="ss4.2">4.2 Allowing telnet connects from users </A>
24 </H2>
25
26 <P> 
27 >From version 1.47 there is a new (more efficient) way of doing this
28 (see next section) but, if you prefer, the method of doing it described 
29 here will continue to work just fine.
30 <P>
31 <P>Allowing telnet connections is quite simple.  Firstly you need to add a line 
32 in /etc/services to allow connections to a port number, like this ....
33 <P>
34 <BLOCKQUOTE><CODE>
35 <PRE>
36 spdlogin   8000/tcp     # spider anonymous login port
37 </PRE>
38 </CODE></BLOCKQUOTE>
39 <P>
40 <P>Then add a line in /etc/inetd.conf like this ....
41 <P>
42 <BLOCKQUOTE><CODE>
43 <PRE>
44 spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet
45 </PRE>
46 </CODE></BLOCKQUOTE>
47 <P>
48 <P>Once this is done, you need to restart inetd like this ....
49 <P>
50 <BLOCKQUOTE><CODE>
51 <PRE>
52 killall -HUP inetd
53 </PRE>
54 </CODE></BLOCKQUOTE>
55 <P>
56 <P>Now login as <EM>sysop</EM> and cd spider/src. You can test that spider 
57 is accepting telnet logins by issuing the following command ....
58 <P>
59 <BLOCKQUOTE><CODE>
60 <PRE>
61 ./client login telnet
62 </PRE>
63 </CODE></BLOCKQUOTE>
64 <P>
65 <P>You should get a login prompt and on issuing a callsign, you will be given 
66 access to the cluster.  Note, you will not get a password login.  There seems 
67 no good reason for a password prompt to be given so it is not asked for.
68 <P>
69 <P>Assuming all is well, then try a telnet from your linux console ....
70 <P>
71 <BLOCKQUOTE><CODE>
72 <PRE>
73 telnet localhost 8000
74 </PRE>
75 </CODE></BLOCKQUOTE>
76 <P>
77 <P>You should now get the login prompt and be able to login as before.
78 <P>
79 <H2><A NAME="ss4.3">4.3 Setting up telnet connects (from 1.47 onwards)</A>
80 </H2>
81
82 <P>>From version 1.47 you can choose to allow the perl cluster.pl program to 
83 allow connections directly (i.e. not via the <CODE>/spider/src/client</CODE>
84 interface program). If you are using Windows then this is the only method
85 available of allowing incoming telnet connections.
86 <P>
87 <P>To do this you need first to remove any line that you may previously have set
88 up in /etc/inetd.conf. Remember to:-
89 <P>
90 <BLOCKQUOTE><CODE>
91 <PRE>
92 killall -HUP inetd
93 </PRE>
94 </CODE></BLOCKQUOTE>
95 <P>
96 <P>to make the change happen...
97 <P>
98 <P>Having done that, you need to copy the file 
99 <EM>/spider/perl/Listeners.pm</EM> to <EM>/spider/local</EM> and 
100 then edit it. You will need to uncomment the line containing &quot;0.0.0.0&quot; 
101 and select the correct port to listen on. So that it looks like this:-
102 <P>
103 <BLOCKQUOTE><CODE>
104 <PRE>
105 @listen = (
106     ["0.0.0.0", 8000],
107 );
108 </PRE>
109 </CODE></BLOCKQUOTE>
110 <P>
111 <P>As standard, the listener will listen on all interfaces simultaneously. 
112 If you require more control than this, you can specify each interface 
113 individually:-
114 <P>
115 <BLOCKQUOTE><CODE>
116 <PRE>
117 @listen = (
118     ["gb7baa.dxcluster.net", 8000],
119     ["44.131.16.2", 6300],
120 );
121 </PRE>
122 </CODE></BLOCKQUOTE>
123 <P>
124 <P>This will only be successful if the IP addresses on each interface are static. 
125 If you are using some kind of dynamic IP addressing then the 'default' method 
126 is the only one that will work.
127 <P>
128 <P>Restart the cluster.pl program to enable the listener.
129 <P>
130 <P>One important difference with the internal listener is that no echoing 
131 is done by the cluster program. Users will need to set 'local-echo' on in 
132 their telnet clients if it isn't set automatically (as per the standards). 
133 Needless to say this will probably only apply to Windows users. 
134 <P>
135 <H2><A NAME="ss4.4">4.4 Setting up for AGW Engine (1.47 onwards)</A>
136 </H2>
137
138 <P>AGW Engine is a Windows based ax25 stack. You can connect to an AGW engine 
139 from Linux as well as Windows based machines.
140 <P>
141 <P>In order to enable access to an AGW Engine you need to copy 
142 <EM>/spider/perl/AGWConnect.pm</EM> to <EM>/spider/local</EM> and edit it. 
143 Specifically you must:-
144 <P>
145 <UL>
146 <LI> set <CODE>$enable</CODE> to 1.</LI>
147 <LI> set <CODE>$login</CODE> and <CODE>$passwd</CODE> to the values set up in your AGW installation. 
148 If you haven't set any there, then you should not touch these values.</LI>
149 <LI> You can connect to a remote AGW engine (ie on some other machine) by changing <CODE>$addr</CODE>
150 and <CODE>$port</CODE> appropriately.</LI>
151 <LI> Restart the cluster.pl program</LI>
152 </UL>
153    
154 <P>
155 <P>
156 <H2><A NAME="ss4.5">4.5 Setting up node connects</A>
157 </H2>
158
159 <P>In order to allow cluster node connections, spider needs to know that the 
160 connecting callsign is a cluster node.  This is the case whether the connect 
161 is incoming or outgoing.  In spider this is a simple task and can be done in 
162 runtime.
163 <P>
164 <P>Later versions of Spider can distinguish different software and treat them
165 differently.  For example, the WCY beacon cannot be handles by AK1A type
166 nodes as AK1A does not know what to do with PC73.  There are 4 different
167 types of node at present and although they may not have any major
168 differences at the moment, it allows for compatibility.  The 4 types are ...
169 <P>
170 <BLOCKQUOTE><CODE>
171 <PRE>
172 set/node        (AK1A type)
173 set/spider
174 set/dxnet
175 set/clx
176 </PRE>
177 </CODE></BLOCKQUOTE>
178 <P>
179 <P>For now, we will assume that the cluster we are going to connect to is an
180 AK1A type node.
181 <P>
182 <P>Start up the cluster as you did before and login as the sysop with client.
183 The cluster node I am wanting to make a connection to is GB7BAA but you would
184 obviously use whatever callsign you required.  At the prompt type ...
185 <P>
186 <BLOCKQUOTE><CODE>
187 <PRE>
188 set/node gb7baa
189 </PRE>
190 </CODE></BLOCKQUOTE>
191 <P>
192 <P>The case does not matter as long as you have a version of DXSpider later than 
193 1.33.  Earlier versions required the callsign to be in upper case.
194 <P>
195 <P>That is now set, it is as simple as that.  To prove it, login on yet another 
196 console as sysop, cd to spider/src and issue the command ...
197 <P>
198 <BLOCKQUOTE><CODE>
199 <PRE>
200 ./client gb7baa (using the callsign you set as a node)
201 </PRE>
202 </CODE></BLOCKQUOTE>
203 <P>
204 <P>You should get an initialisation string from DXSpider like this ...
205 <P>
206 <BLOCKQUOTE><CODE>
207 <PRE>
208 ./client gb7baa
209 PC38^GB7MBC^~
210 </PRE>
211 </CODE></BLOCKQUOTE>
212 <P>If the callsign you just set up as a cluster node is for an incoming connect, 
213 this is all that needs to be done.  If the connection is to be outgoing then 
214 a connection script needs to be written.
215 <P>
216 <P>Sometimes you make a mistake... Honest, it does happen.  If you want to make a node
217 back to being a normal user, regardless
218 of what type it is, do:
219 <P>
220 <BLOCKQUOTE><CODE>
221 <PRE>
222 unset/node gb7baa
223 </PRE>
224 </CODE></BLOCKQUOTE>
225 <P>
226 <H2><A NAME="ss4.6">4.6 Connection scripts</A>
227 </H2>
228
229 <P>Because DXSpider operates under Linux, connections can be made using just about 
230 any protocol;  AX25, NETRom, tcp/ip, ROSE etc are all possible examples.  
231 Connect scripts live in the /spider/connect directory and are simple ascii files.  
232 Writing a script for connections is therefore relatively simple.  
233 <P>
234 <P>The connect scripts consist of lines which start with the following keywords 
235 or symbols:-
236 <P>
237 <DL>
238 <P>
239 <DT><B>#</B><DD><P>All lines starting with a <CODE>#</CODE> are ignored, as are completely 
240 blank lines.
241 <P>
242 <DT><B>timeout</B><DD><P><CODE>timeout</CODE> followed by a number is the number of seconds to wait for a 
243 command to complete. If there is no timeout specified in the script 
244 then the default is 60 seconds.
245 <P>
246 <DT><B>abort</B><DD><P><CODE>abort</CODE> is a regular expression containing one or more strings to look 
247 for to abort a connection. This is a perl regular expression and is 
248 executed ignoring case.
249 <P>
250 <DT><B>connect</B><DD><P><CODE>connect</CODE> followed by ax25, agw (for Windows users) or telnet and some type dependent 
251 information. In the case of a telnet connection, there can be up to 
252 two parameters.
253 The first is the ip address or hostname of the computer you wish to 
254 connect to and the second is the port number you want to use (this 
255 can be left out if it is a normal telnet session).
256 In the case of an ax25 session then this would normally be a call to
257 ax25_call or netrom_call as in the example above. It is your
258 responsibility to get your node and other ax25 parameters to work 
259 before going down this route!
260 <P>
261 <DT><B>'</B><DD><P><CODE>'</CODE> is the delimiting character for a word or phrase of an expect/send 
262 line in a chat type script. The words/phrases normally come in pairs,
263 either can be empty. Each line reads input from the connection until 
264 it sees the string (or perl regular expression) contained in the
265 left hand string. If the left hand string is empty then it doesn't 
266 read or wait for anything. The comparison is done ignoring case.
267 When the left hand string has found what it is looking for (if it is)
268 then the right hand string is sent to the connection.
269 This process is repeated for every line of chat script. 
270 <P>
271 <DT><B>client</B><DD><P><CODE>client</CODE> starts the connection, put the arguments you would want here 
272 if you were starting the client program manually. You only need this 
273 if the script has a different name to the callsign you are trying to 
274 connect to (i.e. you have a script called other which actually 
275 connects to GB7DJK-1 [instead of a script called gb7djk-1]).
276 </DL>
277 <P>
278 <P>There are many possible ways to configure the script but here are three examples, 
279 one for a NETRom/AX25 connect, one for AGW engines and one for tcp/ip.  
280 <P>
281 <BLOCKQUOTE><CODE>
282 <PRE>
283 timeout 60
284 abort (Busy|Sorry|Fail)
285 # don't forget to chmod 4775 netrom_call!
286 connect ax25 /usr/sbin/netrom_call bbs gb7djk g1tlh
287 'Connect' '' 
288 'Connect' 'c np7'
289 'Connect' 'c gb7dxm'
290 # you can leave this out if you call the script 'gb7dxm'
291 client gb7dxm ax25
292 </PRE>
293 </CODE></BLOCKQUOTE>
294 <P>
295 <P>
296 <P>
297 <BLOCKQUOTE><CODE>
298 <PRE>
299 timeout 60
300 abort (Busy|Sorry|Fail)
301 # this does exactly the same as the previous example
302 # the '1' is the AGW port number to connect thru for g1tlh
303 connect agw 1 g1tlh
304 'Connect' '' 
305 'Connect' 'c np7'
306 'Connect' 'c gb7dxm'
307 # you can leave this out if you call the script 'gb7dxm'
308 client gb7dxm ax25
309 </PRE>
310 </CODE></BLOCKQUOTE>
311 <P>
312 <P>
313 <P>
314 <BLOCKQUOTE><CODE>
315 <PRE>
316 timeout 15
317 connect telnet dirkl.tobit.co.uk
318 'login' 'gb7djk'
319 'word' 'gb7djk'
320 # tell GB7DJK-1 that it is connected to GB7DJK
321 # you can leave this out if you call this script 'gb7djk'
322 client gb7djk telnet
323 </PRE>
324 </CODE></BLOCKQUOTE>
325 <P>
326 <P>Both these examples assume that everything is set up properly at the other end.  
327 You will find other examples in the /spider/examples directory.
328 <P>
329 <H2><A NAME="ss4.7">4.7 Starting the connection</A>
330 </H2>
331
332 <P>You start the connection, from within a sysop enabled cluster login, by typing 
333 in the word <EM>connect</EM> followed by a script name like this ....
334 <P>
335 <BLOCKQUOTE><CODE>
336 <PRE>
337 G0VGS de GB7MBC 13-Dec-1998 2041Z >connect gb7djk-1
338 connection to GB7DJK-1 started
339 G0VGS de GB7MBC 13-Dec-1998 2043Z >
340 </PRE>
341 </CODE></BLOCKQUOTE>
342 <P>
343 <P>This will start a connection using the script called <EM>gb7djk-1</EM>.  You can
344 follow the connection by watching the term or console from where you started
345 <EM>cluster.pl</EM>.  From version 1.47 onwards, you will need to <CODE>set/debug connect</CODE> first.
346 You should see something like this ...
347 <P>
348 <BLOCKQUOTE><CODE>
349 <PRE>
350 &lt;- D G1TLH connect gb7djk-1
351 -> D G1TLH connection to GB7DJK-1 started
352 -> D G1TLH G1TLH de GB7DJK 13-Dec-1998 2046Z >
353 timeout set to 15
354 CONNECT sort: telnet command: dirkl.tobit.co.uk
355 CHAT "login" -> "gb7djk"
356 received "
357 Red Hat Linux release 5.1 (Manhattan)
358 Kernel 2.0.35 on an i586
359 "
360 received "login: "
361 sent "gb7djk"
362 CHAT "word" -> "gb7djk"
363 received "gb7djk"
364 received "Password: "
365 sent "gb7djk"
366 Connected to GB7DJK-1, starting normal protocol
367 &lt;- O GB7DJK-1 telnet
368 -> B GB7DJK-1 0
369 GB7DJK-1 channel func  state 0 -> init
370 &lt;- D GB7DJK-1 
371 &lt;- D GB7DJK-1 Last login: Sun Dec 13 17:59:56 from dirk1
372 &lt;- D GB7DJK-1 PC38^GB7DJK-1^~
373 &lt;- D GB7DJK-1 PC18^ 1 nodes, 0 local / 1 total users  Max users 0  Uptime 
374 0 00:00^5447^~
375     etc
376 </PRE>
377 </CODE></BLOCKQUOTE>
378 <P>
379 <P>With later versions of Spider there is a set/login command for users.  This 
380 tells them when a user or node logs in or out.  If you do not add a line to 
381 your scripts after the final line (or before the client line which should always 
382 be last if needed) then the login/logout information will be sent to users
383 <I>before</I> the login actually completes.  This means if a node is 
384 unreachable, it will continue sending logins and logouts to users even though it 
385 is not actually connecting.  To avoid this use the following line ...
386 <P>
387 <BLOCKQUOTE><CODE>
388 <PRE>
389 'connect' ''
390 </PRE>
391 </CODE></BLOCKQUOTE>
392 <P>
393 <P>In a script, this might look like ...
394 <P>
395 <BLOCKQUOTE><CODE>
396 <PRE>
397 timeout 35 
398 abort (Busy|Sorry|Fail)
399 connect telnet mary 3000
400 'ogin:' 'gb7mbc'
401 '>' 'telnet 44.131.93.96 7305'
402 'connect' ''
403 </PRE>
404 </CODE></BLOCKQUOTE>
405 <P>
406 <H2><A NAME="ss4.8">4.8 Telnet echo</A>
407 </H2>
408
409 <P>Cluster links in particular suffer greatly from the presence of telnet echo.  
410 This is caused by the telnet negotiation itself and can create at worst severe 
411 loops.  At best it creates unnecessary bandwidth and large logfiles!  There are
412 things that can be done to limit this problem but will not always work dependent 
413 on the route taken to connect.
414 <P>
415 <P>Telnet echo itself should only be a problem if the connection is being made to 
416 the telnet port (23).  This port uses special rules that include echo negotiation.
417 If the connection is to a different port, such as 7300, this negotiation does 
418 not happen and therefore no echo should be present.
419 <P>
420 <P>Sometimes it is not possible to make a direct connection to another node and this 
421 can cause problems.  There is a way of trying to suppress the telnet echo but 
422 this will not always work, unfortunately it is difficult to be more specific.  
423 Here is an example of what I mean ...
424 <P>
425 <BLOCKQUOTE><CODE>
426 <PRE>
427 timeout 35
428 abort (Busy|Sorry|Fail)
429 connect telnet mary.lancs.ac.uk
430 'ogin:' 'gb7mbc'
431 'word:' 'mypasswd'
432 '\$' 'stty -echo raw'
433 '\$' 'telnet 44.131.93.96'
434 'connect' ''
435 </PRE>
436 </CODE></BLOCKQUOTE>
437 <P>
438 <P>So, the first connection is made by Spider.  This is fine as Spider uses the
439 Net_Telnet script from within perl.  This actually uses TCP rather than TELNET 
440 so no negotiation will be done on the first connection.  Once connected to
441 mary.lancs.ac.uk, the command is sent to suppress echo.  Now a telnet is made 
442 to a cluster node that is accepting connections on port 23.  The problem with 
443 this link is that the negotiation is made by the remote machine, therefore you 
444 have no control over it.  The chances are that this link will create echo and 
445 there will be no way you can stop it.
446 <P>
447 <P>
448 <H2><A NAME="ss4.9">4.9 Autostarting the cluster</A>
449 </H2>
450
451 <P>Ok, you should now have DXSpider running nicely and allowing connects by cluster
452 nodes or users.  However, it has to be shutdown and restarted manually.  It
453 would be much easier to have it start automatically. 
454 <P>
455 <P>This is not only a way to start the cluster automatically, it also works as a
456 watchdog, checking the sanity of DXSpider and respawning it should it crash for 
457 any reason.  Before doing the following, shutdown the cluster as you did earlier.
458 <P>
459 <P>Login as root and bring up the /etc/inittab file in your favourite editor.  Add 
460 the following lines to the file near the end ...
461 <P>
462 <BLOCKQUOTE><CODE>
463 <PRE>
464 ##Start DXSpider on bootup and respawn it should it crash
465 DX:3:respawn:/bin/su -c "/usr/bin/perl -w /spider/perl/cluster.pl" sysop >/dev/tty7
466 </PRE>
467 </CODE></BLOCKQUOTE>
468 <P>
469 <P>This line works fine for RedHat distributions. It is also fine for SuSE up to
470 7.0.  From SuSE 7.1 you need to add runlevels 2 and 5 like this ...
471 <P>
472 <BLOCKQUOTE><CODE>
473 <PRE>
474 DX:235:respawn:/bin/su -c "/usr/bin/perl -w /spider/perl/cluster.pl" sysop >/dev/tty7
475 </PRE>
476 </CODE></BLOCKQUOTE>
477 <P>
478 <P>The line required for Slackware distributions is slightly different.  My thanks to 
479 Aurelio, PA3EZL for this information.
480 <P>
481 <BLOCKQUOTE><CODE>
482 <PRE>
483 DX:23:respawn:/bin/su - sysop -c "/usr/bin/perl -w /spider/perl/cluster.pl" >/dev/tty7
484 </PRE>
485 </CODE></BLOCKQUOTE>
486 <P>
487 <P>This will automatically start DXSpider on tty7 (ALT-F7) on bootup and restart 
488 it should it crash for any reason.
489 <P>
490 <P>NB: It should be noted that /dev/tty7 is only an example.  Some SuSE systems will
491 only accept upto tty6.  It really does not matter which tty you run it on.
492 <P>
493 <P>As root type the command <EM>telinit q</EM>.  DXSpider should start up 
494 immediately.  You will see the output on tty7 and if you login as <EM>sysop</EM> 
495 you should find everything running nicely.
496 <P>
497 <HR>
498 <A HREF="installation-5.html">Next</A>
499 <A HREF="installation-3.html">Previous</A>
500 <A HREF="installation.html#toc4">Contents</A>
501 </BODY>
502 </HTML>