added new version fo the admin manual
[spider.git] / html / adminmanual-3.html
index 638a268049f2fd5da10c68e168161e0d3599b146..42605ab71c415958d2efdde47554a9aa554a531c 100644 (file)
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Administration Manual : Hop control and filtering</TITLE>
+ <TITLE>The DXSpider Installation and Administration Manual : Configuration</TITLE>
+ <LINK HREF="adminmanual-4.html" REL=next>
  <LINK HREF="adminmanual-2.html" REL=previous>
  <LINK HREF="adminmanual.html#toc3" REL=contents>
 </HEAD>
 <BODY>
-Next
+<A HREF="adminmanual-4.html">Next</A>
 <A HREF="adminmanual-2.html">Previous</A>
 <A HREF="adminmanual.html#toc3">Contents</A>
 <HR>
-<H2><A NAME="s3">3. Hop control and filtering</A></H2>
+<H2><A NAME="s3">3. Configuration</A></H2>
 
-<P>Starting with version 1.13 there is simple hop control available on a per
-node basis. Also it is possible to isolate a network completely so that you 
-get all the benefits of being on that network, but can't pass on information
-from it to any other networks you may be connected to (or vice versa).
+<H2><A NAME="ss3.1">3.1 Allowing ax25 connects from users</A>
+</H2>
+
+<P>As stated previously, the aim of this document is not to tell you how to configure Linux or the ax25 utilities.  However, you do need to add a line in your ax25d.conf to allow connections to DXSpider for your users.  For each interface that you wish to allow connections on, use the following format ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+default  * * * * * *  - sysop /spider/src/client client %u ax25
+</PRE>
+</CODE></BLOCKQUOTE>
 <P>
-<H2><A NAME="ss3.1">3.1 Basic hop control</A>
+<H2><A NAME="ss3.2">3.2 Allowing telnet connects from users</A>
 </H2>
 
-<P>In /spider/data you will find a file called hop_table.pl.  This is the file that controls your hop count settings.  It has a set of default hops on the various PC frames and also a set for each node you want to alter the hops for.  You may be happy with the default settings of course, but this powerful tool can help to protect and improve the network.  The file will look something like this ...
+<P>Allowing telnet connections is quite simple.  Firstly you need to add a line in /etc/services to allow connections to a port number, like this ....
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+spdlogin   8000/tcp     # spider anonymous login port
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>Then add a line in /etc/inetd.conf like this ....
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>This needs to be added above the standard services such as ftp, telnet etc.  Once this is done, you need to restart inetd like this ....
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+killall -HUP inetd
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>
+<P>Now login as <EM>sysop</EM> and cd spider/perl. You can test that spider is accepting telnet logins by issuing the following command ....
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+client.pl login telnet
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>You should get a login prompt and on issuing a callsign, you will be given access to the cluster.  Note, you will not get a password login.  There seems no good reason for a password prompt to be given so it is not asked for.
+<P>
+<P>Assuming all is well, then try a telnet from your linux console ....
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-# 
-# hop table construction
-# 
+telnet localhost 8000
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>You should now get the login prompt and be able to login as before.
+<P>
+<H2><A NAME="ss3.3">3.3 Setting up node connects</A>
+</H2>
 
-package DXProt;
+<P>In order to allow cluster node connections, spider needs to know that the connecting callsign is a cluster node.  This is the case whether the connect is incoming or outgoing.
+In spider this is a simple task and can be done in runtime.
+<P>
+<P>Start up the cluster as you did before and login as the sysop with client.pl.
+The cluster node I am wanting to make a connection to is GB7BAA but you would obviously use whatever callsign you required.
+At the prompt type ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/node gb7baa
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>The case does not matter as long as you have a version of DXSpider later than 1.33.  Earlier versions required the callsign to be in upper case.
+<P>
+<P>That is now set, it is as simple as that.  To prove it, login on yet another console as sysop and issue the command ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+client.pl gb7baa (using the callsign you set as a node)
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>You should get an initialisation string from DXSpider like this ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+client.pl gb7baa
+PC38^GB7MBC^~
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>If the callsign you just set up as a cluster node is for an incoming connect, this is all that needs to be done.  If the connection is to be outgoing then a connection script needs to be written.
+<P>
+<H3>Connection scripts</H3>
 
-# default hopcount to use
-$def_hopcount = 5;
+<P>Because DXSpider operates under Linux, connections can be made using just about any protocol;  AX25, NETRom, tcp/ip, ROSE etc are all possible examples.  Connect scripts live in the /spider/connect directory and are simple ascii files.  Writing a script for connections is therefore relatively simple.  
+<P>
+<P>The connect scripts consist of lines which start with the following keywords or symbols:-
+<P>
+<P>
+<PRE>
+        
+#               All lines starting with a # are ignored, as are wholly blank lines.
 
-# some variable hop counts based on message type
-%hopcount = 
+timeout         timeout followed by a number is the number of seconds to wait for a 
+                command to complete. If there is no timeout specified in the script 
+                then the default is 60 seconds.
 
- 11 => 10,
- 16 => 10,
- 17 => 10,
- 19 => 10,
- 21 => 10,
-);
+abort           abort is a regular expression containing one or more strings to look 
+                for to abort a connection. This is a perl regular expression and is 
+                executed ignoring case.
 
+connect         connect followed by ax25 or telnet and some type dependent 
+                information. In the case of a telnet connection, there can be up to 
+                two parameters.
+                The first is the ip address or hostname of the computer you wish to 
+                connect to and the second is the port number you want to use (this 
+                can be left out if it is a normal telnet session).
+                In the case of an ax25 session then this would normally be a call to
+                ax25_call or netrom_call as in the example above. It is your
+                responsibility to get your node and other ax25 parameters to work 
+                before going down this route!
 
-# the per node hop control thingy
+'               ' is the delimiting character for a word or phrase of an expect/send 
+                line in a chat type script. The words/phrases normally come in pairs, 
+                either can be empty. Each line reads input from the connection until 
+                it sees the string (or perl regular expression) contained in the
+                left hand string. If the left hand string is empty then it doesn't 
+                read or wait for anything. The comparison is done ignoring case.
+                When the left hand string has found what it is looking for (if it is) 
+                then the right hand string is sent to the connection.
+                This process is repeated for every line of chat script. 
 
+client          client starts the connection, put the arguments you would want here 
+                if you were starting the client program manually. You only need this 
+                if the script has a different name to the callsign you are trying to 
+                connect to (i.e. you have a script called other which actually 
+                connects to GB7DJK-1 [instead of a script called gb7djk-1]).
+</PRE>
+<P>
+<P>There are many possible ways to configure the script but here are two examples, one for a NETRom/AX25 connect and one for tcp/ip.  
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+        timeout 60
+        abort (Busy|Sorry|Fail)
+        # don't forget to chmod 4775 netrom_call!
+        connect ax25 /usr/sbin/netrom_call bbs gb7djk g1tlh
+        'Connect' ''
+        'Connect' 'c np7'
+        'Connect' 'c gb7dxm'
+        # you can leave this out if you call the script 'gb7dxm'
+        client gb7dxm ax25
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+        timeout 15
+        connect telnet dirkl.tobit.co.uk
+        'login' 'gb7djk'
+        'word' 'gb7djk'
+        # tell GB7DJK-1 that it is connected to GB7DJK
+        # you can leave this out if you call this script 'gb7djk'
+        client gb7djk telnet
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>Both these examples assume that everything is set up properly at the other end.  You will find other examples in the /spider/examples directory.
+<P>
+<H3>Starting the connection</H3>
 
-%nodehops = 
+<P>You start the connection, from within a sysop enabled cluster login, by typing in the word <EM>connect</EM> followed by a script name like this ....
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+G0VGS de GB7MBC 13-Dec-1998 2041Z >connect gb7djk-1
+connection to GB7DJK-1 started
+G0VGS de GB7MBC 13-Dec-1998 2043Z >
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>This will start a connection using the script called <EM>gb7djk-1</EM>.  You can follow the connection by watching the term or console from where you started <EM>cluster.pl</EM>.  You should see something like this ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+&lt;- D G1TLH connect gb7djk-1
+-> D G1TLH connection to GB7DJK-1 started
+-> D G1TLH G1TLH de GB7DJK 13-Dec-1998 2046Z >
+timeout set to 15
+CONNECT sort: telnet command: dirkl.tobit.co.uk
+CHAT "login" -> "gb7djk"
+received "
+Red Hat Linux release 5.1 (Manhattan)
+Kernel 2.0.35 on an i586
+"
+received "login: "
+sent "gb7djk"
+CHAT "word" -> "gb7djk"
+received "gb7djk"
+received "Password: "
+sent "gb7djk"
+Connected to GB7DJK-1, starting normal protocol
+&lt;- O GB7DJK-1 telnet
+-> B GB7DJK-1 0
+GB7DJK-1 channel func  state 0 -> init
+&lt;- D GB7DJK-1 
+&lt;- D GB7DJK-1 Last login: Sun Dec 13 17:59:56 from dirk1
+&lt;- D GB7DJK-1 PC38^GB7DJK-1^~
+&lt;- D GB7DJK-1 PC18^ 1 nodes, 0 local / 1 total users  Max users 0  Uptime 0 00:00^5447^~
+    etc
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>With later versions of Spider there is a set/login command for users.  This tells them when a user or node logs in or out.  If you do not add a line to your scripts after the final line (or before the client line which should always be last if needed) then the login/logout information will be sent to users <I>before</I> the login actually completes.  This means if a node is unreachable, it will continue sending logins and logouts to users even though it is not actually connecting.  To avoid this use the following line ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+'connect' ''
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>In a script, this might look like ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+timeout 35 
+abort (Busy|Sorry|Fail)
+connect telnet mary 3000
+'ogin:' 'gb7mbc'
+'>' 'telnet 44.131.93.96 7305'
+'connect' ''
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<H2><A NAME="ss3.4">3.4 Automating things</A>
+</H2>
 
- GB7ADX => {            11 => 8,
-                        12 => 8,
-                        16 => 8,
-                        17 => 8,
-                        19 => 8,
-                        21 => 8,
-                   },
+<P>Ok, you should now have DXSpider running nicely and allowing connects by cluster nodes or users.  However, it has to be shutdown and restarted manually and if connection scripts fail they have to be started again manually too, not much use if you are not at the console!
+So, in this section we will automate both.  Firstly starting the cluster.
+<P>
+<H3>Autostarting the cluster</H3>
 
- GB7UDX => {            11 => 8,
-                        12 => 8,
-                        16 => 8,
-                        17 => 8,
-                        19 => 8,
-                        21 => 8,
-                   },
- GB7BAA => {
-                        11 => 5,
-                        12 => 8,
-                        16 => 8,
-                        17 => 8,
-                        19 => 8,
-                        21 => 8,
-                   },
-};
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>
-<P>Each set of hops is contained within a pair of curly braces and contains a series of PC frame types.  PC11 for example is a DX spot. The figures here are not exhaustive but should give you a good idea of how the file works.
-<P>
-<P>You can alter this file at any time, including whilst the cluster is running.  If you alter the file during runtime, the command <EM>load/hops</EM> will bring your changes into effect.
-<P>
-<H2><A NAME="ss3.2">3.2 Isolating networks</A>
-</H2>
+<P>This is not only a way to start the cluster automatically, it also works as a watchdog, checking the sanity of DXSpider and respawning it should it crash for any reason.
+Before doing the following, shutdown the cluster as you did earlier.
+<P>
+<P>Login as root and bring up the /etc/inittab file in your favourite editor.  Add the following lines to the file near the end ...
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+##Start DXSpider on bootup and respawn it should it crash
+DX:3:respawn:/bin/su -c "/usr/bin/perl -w /spider/perl/cluster.pl" sysop >/dev/tty7
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>This will automatically start DXSpider on tty7 (ALT-F7) on bootup and restart it should it crash for any reason.
+<P>
+<P>As root type the command <EM>telinit q</EM>.  DXSpider should start up immediately.  You will see the output on tty7 and if you login as <EM>sysop</EM> you should find everything running nicely.
+<P>
+<P>So far so good, now to automate script connections...
+<P>
+<H3>The crontab file</H3>
 
-<P>It is possible to isolate networks from each other on a "gateway" node using the
-<EM>set/isolate &lt;node call&gt;</EM> command.
-<P>
-<P>The effect of this is to partition an isolated network completely from another 
-nodes connected to your node. Your node will appear on and otherwise behave 
-normally on every network to which you are connected, but data from an isolated 
-network will not cross onto any other network or vice versa. However all the 
-spot, announce and WWV traffic and personal messages will still be handled 
-locally (because you are a real node on all connected networks), that is locally
-connected users will appear on all networks and will be able to access and 
-receive information from all networks transparently.  All routed messages will 
-be sent as normal, so if a user on one network knows that you are a gateway for 
-another network, he can still still send a talk/announce etc message via your 
-node and it will be routed across.
-<P>
-<P>The only limitation currently is that non-private messages cannot be passed down 
-isolated links regardless of whether they are generated locally. This will change 
-when the bulletin routing facility is added.
+<P>Login as <EM>sysop</EM> and create a file in /spider/local_cmd called crontab.  Edit it with your favourite editor and add a line like this (I have included a comment)
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+# check every 10 minutes to see if gb7xxx is connected and if not
+# start a connect job going
+
+0,10,20,30,40,50 * * * * start_connect('gb7xxx') if !connected('gb7xxx')
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>The callsign involved will be the callsign of the cluster node you are going to connect to.  This will now check every 10 minutes to see if gb7xxx is connected, if it is then nothing will be done.  If it is not, then a connect attempt will be started.
 <P>
+<P>There are probably lots of other things you could use this crontab file for.  If you want to know more about it, look at the 
+<A HREF="http://www.dxcluster.org/cron.html">DXSpider</A> website at the cron page where it is explained more fully.
 <P>
 <HR>
-Next
+<A HREF="adminmanual-4.html">Next</A>
 <A HREF="adminmanual-2.html">Previous</A>
 <A HREF="adminmanual.html#toc3">Contents</A>
 </BODY>