X-Git-Url: http://dxcluster.net/gitweb/gitweb.cgi?a=blobdiff_plain;f=sgml%2Fadminmanual.sgml;h=d91dab680b17f3f7de83b9d1201f4e6f61e257b0;hb=71ce25e28013877858408ae610c9eaf6d1fb001c;hp=1a33fc0fd863851f9f6461292364f7446459376d;hpb=06858d299ea1490083c3ae6cc36fa67d23735914;p=spider.git diff --git a/sgml/adminmanual.sgml b/sgml/adminmanual.sgml index 1a33fc0f..d91dab68 100644 --- a/sgml/adminmanual.sgml +++ b/sgml/adminmanual.sgml @@ -4,9 +4,10 @@ -The DXSpider Installation and Administration Manual -<author>Ian Maude, G0VGS, (ianmaude@btinternet.com) -<date>$Date$ $Revision$ +<title>The DXSpider Administration Manual v1.48 +Ian Maude, G0VGS, (ianmaude@btinternet.com) +Version 1.48 August 2001 revision 1.1 + A reference for SysOps of the DXSpider DXCluster program. @@ -16,1156 +17,215 @@ A reference for SysOps of the DXSpider DXCluster program. -Installation (Original version by Iain Philipps, G0RDI) +Routing and Filtering Introduction

-This section describes the installation of DX Spider v1.46 on a - Linux Distribution. -Wherever possible I will try to include differences for other distributions. -I do not intend to try and cover the installation of Linux or the setup -of the AX25 utilities. If you need help on this then read Iains original -installation guide that comes with the Spider distribution. - -

-I am assuming a general knowledge of Linux and its commands. You should -know how to use tar and how to edit files using your favourite editor. - -

-The crucial ingredient for all of this is -. Earlier versions of -Spider required perl 5.004, however it is now STRONGLY recommended -that you use at least version 5.005_03 as this is the version being used -in the development of Spider. - -

In addition to the standard Red Hat distribution you will require the -following modules from ... - -

- - - Data-Dumper-2.101.tar.gz - TimeDate-1.10.tar.gz - IO-1.20.tar.gz (for perl 5.00403 and lower) - Net-Telnet-3.02.tar.gz - Curses-1.05.tar.gz - Time-HiRes-01.20.tar.gz - - - -

- -Do get the latest versions of these packages and install them -but use the above list as the earliest versions usable. - -Preparation - -

-I will assume that you have already downloaded the latest tarball of -the DXSpider software and are ready to install it. I am assuming version -1.46 for this section but of course you would use the latest version. - -

-Login as root and create a user to run the cluster under. UNDER -NO CIRCUMSTANCES USE ROOT AS THIS USER!. I am going to use -the name sysop. You can call it anything you wish. Depending -on your security requirements you may wish to use an existing user, -however this is your own choice. - -

- -# adduser -m sysop - - -

-Now set a password for the user ... - - -# passwd sysop -# New UNIX password: -# Retype new UNIX password: -passwd: all authentication tokens updated successfully - - -Installing the software - -

-Now to unpack the DX Spider distribution, set symbolic links and group -permissions. Copy the tarball to /home/sysop and do the following. - - -# cd ~sysop -# tar xvfz spider-1.46.tar.gz -# ln -s ~sysop/spider /spider -# groupadd -g 251 spider (or another number) - - -If you do not have the command groupadd available to you simply -add a line in /etc/group by hand. - - -# vi /etc/group (or your favorite editor) - - -You also need to add some others to the group, including your own callsign -(this will be used as an alias) and root. The finished line in /etc/group -should look something like this - - -spider:x:251:sysop,g0vgs,root - - -

-The next step is to set the permissions on the Spider directory tree and files .... - - -# chown -R sysop.spider spider -# find . -type d -exec chmod 2775 {} \; -# find . -type f -exec chmod 775 {} \; - - -

-This last step allows various users of the group spider to have -write access to all the directories. This is not really needed just yet -but will be useful when web interfaces start to appear. - -

-Finally, you need to fix the permissions on the ax25_call and netrom_call -programs. Check where they are with the locate command and alter -the permissions with the chmod command like this .. - - -# chown root ax25_call netrom_call -# chmod 4775 ax25_call netrom_call - - -Setting callsigns etc - -

-Now login to your machine as the user you created earlier. In my case that -user is called sysop. Once logged in, issue the following commands .... - - -$ cd /spider -$ mkdir local -$ mkdir local_cmd -$ cp perl/DXVars.pm.issue local/DXVars.pm -$ cd local -$ vi DXVars.pm (or your favourite editor) - - -

-Using the distributed DXVars.pm as a a template, set your cluster callsign, -sysop callsign and other user info to suit your own environment. Note that -this a perl file which will be parsed and executed as part of the cluster. If -you get it wrong then perl will complain when you start the cluster process. -It is important only to alter the text of any section. Some of the lines look -a little odd. Take this line for example .... - - -$myemail = "ianmaude\@btinternet.com"; - - -

-There appears to be an extra slash in there. However this has to be there -for the file to work so leave it in. - -

PLEASE USE CAPITAL LETTERS FOR CALLSIGNS - -

-DON'T alter any file in /spider/perl, they are overwritten with every -release. Any files or commands you place in /spider/local or /spider/local_cmd -will automagically be used in preference to the ones in /spider/perl EVEN -while the cluster is running! - -

-Save the new file and change directory to ../perl .... - - -$ cd ../perl - - -

-Now type the following command which creates the basic user file with you as -the sysop. - - -$ ./create_sysop.pl - - -Starting up for the first time - -

-We can now bring spider up for the first time and see if all is well or not! -It should look something like this ... - - -$ ./cluster.pl -DXSpider DX Cluster Version 1.46 -Copyright (c) 1998 Dirk Koopman G1TLH -loading prefixes ... -loading band data ... -loading user file system ... -starting listener ... -reading existing message headers -reading cron jobs -orft we jolly well go ... - - -

-If all is well then login on another term or console as sysop and -cd to /spider/src. Now issue the following command ... - - -$ ./client - - -

-This should log you into the cluster as the sysop under the alias callsign we -set earlier. In this case the callsign is G0VGS. The cluster callsign is set -in the DXVars.pm file in /spider/local. In this case we will assume that this -was set as GB7MBC. You should therefore see this when you login .... - - -G0VGS de GB7MBC 19-Nov-1999 2150Z > - - -If you do, congratulations! If not, look over the instructions again, you -have probably missed something out. You can shut spider down again with the -command .... - - -shutdown - - -

-and both the cluster and the client should return to Linux prompts. - -The Client program - -

-In earlier versions of Spider, all the processes were Perl scripts. This -was fine but with a lot of users your computer memory would soon be used up. -To combat this a new client was written in "C". This client only works for -incoming connects at the moment. Before you can use it though it -has to be "made". CD to /spider/src and type make. You -should see the output on your screen and hopefully now have a small C program -called client. Leave it in this directory. - - -Quick installation guide - -

-This section is designed for experienced Spider sysops who want to install -Spider from scratch. It is simply a check list of things that need to be -done without any explanations. The name in brackets at the end of each line -is the user that should be doing that process. - - -Login as root -Get the additional CPAN modules and install them (root) -Create the "sysop" user and set a password (root) -Put the Spider tarball in ~sysop and untar it (root) -ln -s ~sysop/spider /spider (root) -groupadd -g 251 spider (root) -Add any more users you need to the group entry in /etc/group (root) -Set the permissions on the spider tree (root) -Fix permissions on ax25_call and netrom_call (root) -Login as the sysop user -cd to /spider (sysop) -mkdir local (sysop) -mkdir local_cmd (sysop) -cp perl/DXVars.pm.issue local/DXVars.pm (sysop) -cd to /spider/local and edit DXVars to set your details (sysop) -cd ../perl (sysop) -./create_sysop.pl (sysop) -./cluster.pl (sysop) - - -Spider should now be running and you should be able to login using the -client program. - - -Login as root -Enter the correct line in ax25d.conf (root) -Enter the correct line in /etc/services (root) -Enter the correct line in /etc/inetd.conf (root) -killall -HUP inetd (root) - - -Spider should now be able to accept logins via telnet, netrom and ax25. - - -Login as sysop -Start the cluster (sysop) -set/node and type for links (sysop) -Write any connect scripts (sysop) -Edit /spider/crontab as required (sysop) -Edit any other files as necessary (sysop) -Set filters, hops and forwarding files (sysop) -Login as root -Enter the correct line in /etc/inittab (root) - - -Configuration - -Allowing ax25 connects from users - -

-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 ... - - -default * * * * * * - sysop /spider/src/client client %u ax25 - - -or, if you wish your users to be able to use SSID's on their callsigns .. - - -default * * * * * * - sysop /spider/src/client client %s ax25 - - -For most purposes this is not desirable. The only time you probably will need this is -when you need to allow other cluster nodes that are using SSID's in. In this case it -owuld probably be better to use the first example and then add a specific line for that -node like this: - - -GB7DJK-2 * * * * * * - sysop /spider/src/client client gb7djk-2 ax25 -default * * * * * * - sysop /spider/src/client client %u ax25 - - -Allowing telnet connects from users - -

-From version 1.47 there is a new (more efficient) way of doing this (see next section) but, -if you prefer, the method of doing it described here will continue to work just fine. - -

-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 .... - - -spdlogin 7300/tcp # spider anonymous login port - - -Then add a line in /etc/inetd.conf like this .... - - -spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet - - -

-Once this is done, you need to restart inetd like this .... - - -killall -HUP inetd - - - -

Now login as sysop and cd spider/src. You can test that spider -is accepting telnet logins by issuing the following command .... - - -./client login telnet - - -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. - -

-Assuming all is well, then try a telnet from your linux console .... - - -telnet localhost 7300 - +From DXSpider version 1.48, major changes were introduced to the way +node connections are treated. This is part of an ongoing process to +remove problems with loops and to enable talk and other functions to +propagate across the whole of the worldwide cluster network. In fact, +in a Spider network, it would be useful, perhaps even necessary to +have loops. This would give real resilience to the network, meaning +that if a link dropped, the information flow would simply come in and +go out via a different route. Of course, we do not have a complete +network of Spider nodes, there are other programs out there. Some of +these do not have any protection from loops. Certainly AK1A does not +handle loops well at all. It is therefore necessary to have some form +of protection for these nodes.

-You should now get the login prompt and be able to login as before. - -Setting up telnet connects (from 1.47 onwards) +In fact DXSpider has had a simple system for some time which is called +isolation. This is similar to what, in other systems such as +clx, is called passive mode. A more detailed explanation +of isolation is given further below. This system is still available +and, for simple networks, is probably all that you need.

-From version 1.47 you can chose to allow the perl cluster.pl program to -allow connections direct (i.e. not via the /spider/src/client -interface program). If you are using Windows then this is the only method -available of allowing incoming telnet connections. +The new functionality introduced in version 1.48 is filtering the node +and user protocol frames on a "per interface" basis. We call this +route filtering. This is used instead of +isolation. -

-To do this you need first to remove any line that you may previously have set -up in /etc/inetd.conf. Remember to:- +

+What this really means is that you can control more or less completely +which PC protocol frames, to do with user and node management, pass to +each of your partner nodes. You can also limit what comes into your +node from your partners. You can even control the settings that your +partner node has for the routing information that it sends to you +(using the rcmd command). - -killall -HUP inetd - +Route Filters

-to make the change happen... +Initially when route filters were being tested we generated a +"default" filter. Unfortunately it quickly became apparent that this +might suit the UK cluster network but didn't really fit anybody else. +However using a default filter is an appropriate thing to do. How, is +explained further on.

-Having done that then you need to copy the file -/spider/perl/Listeners.pm to /spider/local and -then edit it. You will need to uncomment the line containing &dquot;0.0.0.0&dquot; -and select the correct port to listen on. So that it looks like this:- - - -@listen = ( - ["0.0.0.0", 7300], -); - - -

As standard, the listener will listen on all interfaces simultaniously. If you require more -control than this, you can specify each interface individually:- - - -@listen = ( - ["gb7baa.dxcluster.net", 7300], - ["44.131.16.2", 6300], -); - - -

This will only be successful if the IP addresses on each interface are static. -If you are using some kind of dynamic IP addressing then the 'default' method is the -only one which will work. - -

-Restart the cluster.pl program to enable the listener. - -

-One important difference with the internal listener is that no echoing is done by the -cluster program. Users will need to set 'local-echo' on in their telnet clients if -it isn't set automatically (as per the standards). Needless to say this will probably -only apply to Windows users. - -Setting up for AGW Engine (1.47 onwards) - -

AGW Engine is a Windows based ax25 stack. You can connect to an AGW engine from Linux -as well as Windows based machines. - -

In order to enable access to an AGW Engine you need to copy /spider/perl/AGWConnect.pm -to /spider/local and edit it. Specifically you must:- - - - set $enable to 1. - set $login and $passwd to the values set up in your AGW installation. -If you haven't set any there, then you should not touch these values. - You can connect to a remote AGW engine (ie on some other machine) by changing $addr -and $port appropriately. - Restart the cluster.pl program - - - -Setting up node connects - -

-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. - -

-Later versions of Spider can distinguish different software and treat them -differently. For example, the WCY beacon cannot be handles by AK1A type -nodes as AK1A does not know what to do with PC73. There are 4 different -types of node at present and although they may not have any major -differences at the moment, it allows for compatibility. The 4 types are ... - - -set/node (AK1A type) -set/spider -set/dxnet -set/clx - - -

-For now, we will assume that the cluster we are going to connect to is an -AK1A type node. - -

-Start up the cluster as you did before and login as the sysop with client. -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 ... - - -set/node gb7baa - - -

-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. - -

-That is now set, it is as simple as that. To prove it, login on yet another -console as sysop, cd to spider/src and issue the command ... - - -./client gb7baa (using the callsign you set as a node) - - -

-You should get an initialisation string from DXSpider like this ... - - -./client gb7baa -PC38^GB7MBC^~ - - -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. - -

-Sometimes you make a mistake... Honest, it does happen. If you want to make a node -back to being a normal user, regardless -of what type it is, do: - - -unset/node gb7baa - - -Connection scripts - -

-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. - -

-The connect scripts consist of lines which start with the following keywords -or symbols:- - - - -# are ignored, as are completely - blank lines. - -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. - -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 followed by ax25, agw (for Windows users) 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! - -' 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. +The first thing that you must do is determine whether you need to do route filtering at all. If you are a "normal" node with two or three partners +and you arranged in an "official" non-looping tree type network, then you do +not need to do route filtering and you will feel a lot better for not +getting involved. If you are successfully using isolation then you +also probably don't need to use route filtering. -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]). - - - -There are many possible ways to configure the script but here are three examples, -one for a NETRom/AX25 connect, one for AGW engines and one for tcp/ip. - - -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 - - -

- - -timeout 60 -abort (Busy|Sorry|Fail) -# this does exactly the same as the previous example -# the '1' is the AGW port number to connect thru for g1tlh -connect agw 1 g1tlh -'Connect' '' -'Connect' 'c np7' -'Connect' 'c gb7dxm' -# you can leave this out if you call the script 'gb7dxm' -client gb7dxm ax25 - - -

- - -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 - - -

-Both these examples assume that everything is set up properly at the other end. -You will find other examples in the /spider/examples directory. - -Starting the connection - -

-You start the connection, from within a sysop enabled cluster login, by typing -in the word connect followed by a script name like this .... - - -G0VGS de GB7MBC 13-Dec-1998 2041Z >connect gb7djk-1 -connection to GB7DJK-1 started -G0VGS de GB7MBC 13-Dec-1998 2043Z > - - -This will start a connection using the script called gb7djk-1. You can -follow the connection by watching the term or console from where you started -cluster.pl. From version 1.47 onwards, you will need to set/debug connect first. -You should see something like this ... - - -<- 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 -<- O GB7DJK-1 telnet --> B GB7DJK-1 0 -GB7DJK-1 channel func state 0 -> init -<- D GB7DJK-1 -<- D GB7DJK-1 Last login: Sun Dec 13 17:59:56 from dirk1 -<- D GB7DJK-1 PC38^GB7DJK-1^~ -<- D GB7DJK-1 PC18^ 1 nodes, 0 local / 1 total users Max users 0 Uptime -0 00:00^5447^~ - etc - - - -

-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 -before 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 ... - - -'connect' '' - - -

-In a script, this might look like ... - - -timeout 35 -abort (Busy|Sorry|Fail) -connect telnet mary 3000 -'ogin:' 'gb7mbc' -'>' 'telnet 44.131.93.96 7305' -'connect' '' - - -Telnet echo - -

-Cluster links in particular suffer greatly from the presence of telnet echo. -This is caused by the telnet negotiation itself and can create at worst severe -loops. At best it creates unnecessary bandwidth and large logfiles! There are -things that can be done to limit this problem but will not always work dependent -on the route taken to connect. - -

-Telnet echo itself should only be a problem if the connection is being made to -the telnet port (23). This port uses special rules that include echo negotiation. -If the connection is to a different port, such as 7300, this negotiation does -not happen and therefore no echo should be present. - -

-Sometimes it is not possible to make a direct connection to another node and this -can cause problems. There is a way of trying to suppress the telnet echo but -this will not always work, unfortunately it is difficult to be more specific. -Here is an example of what I mean ... - - -timeout 35 -abort (Busy|Sorry|Fail) -connect telnet mary.lancs.ac.uk -'ogin:' 'gb7mbc' -'word:' 'mypasswd' -'\$' 'stty -echo raw' -'\$' 'telnet 44.131.93.96' -'connect' '' - - -So, the first connection is made by Spider. This is fine as Spider uses the -Net_Telnet script from within perl. This actually uses TCP rather than TELNET -so no negotiation will be done on the first connection. Once connected to -mary.lancs.ac.uk, the command is sent to suppress echo. Now a telnet is made -to a cluster node that is accepting connections on port 23. The problem with -this link is that the negotiation is made by the remote machine, therefore you -have no control over it. The chances are that this link will create echo and -there will be no way you can stop it. - - -Automating things - -

-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. - -Autostarting the cluster - -

-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. - -

-Login as root and bring up the /etc/inittab file in your favourite editor. Add -the following lines to the file near the end ... - - -##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 - - -

-This line works fine for RedHat distributions. It is also fine for SuSE up to -7.0. From Suse 7.1 you need to add runlevels 2 and 5 like this ... - - -DX:235:respawn:/bin/su -c "/usr/bin/perl -w /spider/perl/cluster.pl" sysop >/dev/tty7 - - - -The line required for Slackware distributions is slightly different. My thanks to -Aurelio, PA3EZL for this information. - - -DX:23:respawn:/bin/su - sysop -c "/usr/bin/perl -w /spider/perl/cluster.pl" >/dev/tty7 - - -

-This will automatically start DXSpider on tty7 (ALT-F7) on bootup and restart -it should it crash for any reason. - -

-As root type the command telinit q. DXSpider should start up -immediately. You will see the output on tty7 and if you login as sysop -you should find everything running nicely. - -

-So far so good, now to automate script connections... - -The crontab file - -

-Login as sysop 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) - - -# 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 unless connected('gb7xxx') - - -

-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. - -

-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 - website -at the cron page where it is explained more fully. - -Hop control - -

-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). - -Basic hop control - -

-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 ... - - -# -# hop table construction -# - -package DXProt; - -# default hopcount to use -$def_hopcount = 5; - -# some variable hop counts based on message type -%hopcount = -( - 11 => 10, - 16 => 10, - 17 => 10, - 19 => 10, - 21 => 10, -); - - -# the per node hop control thingy - - -%nodehops = - - GB7ADX => { 11 => 8, - 12 => 8, - 16 => 8, - 17 => 8, - 19 => 8, - 21 => 8, - }, - - 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, - }, -}; - - -

-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. - -

-You can alter this file at any time, including whilst the cluster is running. -If you alter the file during runtime, the command load/hops will -bring your changes into effect. - -Isolating networks - -

-It is possible to isolate networks from each other on a "gateway" node using the - set/isolate <node_call> command. - -

-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. - -

-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. - -

-If you use isolate on a node connection you will continue to receive all -information from the isolated partner, however you will not pass any information -back to the isolated node. There are times when you would like to forward only -spots across a link (maybe during a contest for example). To do this, isolate -the node in the normal way and put in a filter in the /spider/filter/spots -directory to override the isolate. This filter can be very simple and consists -of just one line .... - - -$in = [ - [ 1, 0, 'd', 0, 3] # The last figure (3) is the hop count -]; - - -

-There is a lot more on filtering in the next section. - -Filtering (Old Style upto v1.44) - -

-Filters can be set for spots, announcements and WWV. You will find the -directories for these under /spider/filter. You will find some examples in -the directories with the suffix .issue. There are two types of -filter, one for incoming information and one for outgoing information. -Outgoing filters are in the form CALLSIGN.pl and incoming filters -are in the form in_CALLSIGN.pl. Filters can be set for both nodes -and users. - -

-All filters work in basically the same way. There are several elements -delimited by commas. There can be many lines in the filter and they are -read from the top by the program. When writing a filter you need to think -carefully about just what you want to achieve. You are either going to write -a filter to accept or to reject. Think of a filter as -having 2 main elements. For a reject filter, you would have a line or multiple -lines rejecting the things you do not wish to receive and then a default line -accepting everything else that is not included in the filter. Likewise, for an -accept filter, you would have a line or multiple lines accepting the things you -wish to receive and a default line rejecting everthing else. - -

-In the example below, a user requires a filter that would only return SSB spots -posted in Europe on the HF bands. This is achieved by first rejecting the CW -section of each HF band and rejecting all of VHF, UHF etc based on frequency. -Secondly, a filter rule is set based on CQ zones to only accept spots posted in -Europe. Lastly, a default filter rule is set to reject anything outside the filter. - - -$in = [ - [ 0, 0, 'r', # reject all CW spots - [ - 1800.0, 1850.0, - 3500.0, 3600.0, - 7000.0, 7040.0, - 14000.0, 14100.0, - 18068.0, 18110.0, - 21000.0, 21150.0, - 24890.0, 24930.0, - 28000.0, 28180.0, - 30000.0, 49000000000.0, - ] ,1 ], - [ 1, 11, 'n', [ 14, 15, 16, 20, 33, ], 15 ], #accept EU - [ 0, 0, 'd', 0, 1 ], # 1 = want, 'd' = everything else -]; - +

+You will only require this functionality if you are +"well-connected". What that means is that you are connected to several +different parts of (say) the EU cluster and, at the same time, also +connected to two or three places in the US which, in turn are +connected back to the EU. This is called a "loop" and if you are +seriously looped then you need filtering.

-The actual elements of each filter are described more fully in the following -sections. - -Spots +I should at this stage give a little bit of background on filters. All +the filters in Spider work in basically the same way. You can either +accept or reject various options in order to create the filter rules +you wish to achieve. Some filters are user settable, others can only +be altered by the sysop. Route filtering can only be done by the sysop. -

-The elements of the Spot filter are .... +

+Anyway, without further discouragement, let me start the process +of explanation. - -[action, field_no, sort, possible_values, hops] - +The node_default filter

-There are 3 elements here to look at. Firstly, the action element. This is -very simple and only 2 possible states exist, accept (1) or drop (0). +All normal systems should have a default routing filter and it should +usually be set to send only the normal, unlooped, view of your +"national" network. Here in the UK that means nodes from the UK and +Eire, in EU it is more complex as the networks there grew up in a more +intertwined way. -

-The second element is the field_no. There are 13 possiblities to choose from -here .... +

+The generic commands are:- - 0 = frequency - 1 = call - 2 = date in unix format - 3 = comment - 4 = spotter - 5 = spotted dxcc country - 6 = spotter's dxcc country - 7 = origin - 8 = spotted itu - 9 = spotted cq - 10 = spotter's itu - 11 = spotter's cq - 12 = callsign of the channel on which the spot has appeared +reject/route node_default <filter_option> + +or + +accept/route node_default <filter_option> -

-The third element tells us what to expect in the fourth element. There are -4 possibilities .... +where filter_option is one of the following ... - n - numeric list of numbers e.g. [ 1,2,3 ] - r - ranges of pairs of numbers e.g. between 2 and 4 or 10 to 17 - [ 2,4, 10,17 ] - a - an alphanumeric regex - d - the default rule +call <prefixes> +call_dxcc <numbers> +call_itu <numbers> +call_zone <numbers> +channel <prefixes> +channel_dxcc <numbers> +channel_itu <numbers> +channel_zone <numbers> -

-The fifth element is simply the hops to set in this filter. This would only -be used if the filter was for a node of course and overrides the hop count in -hop_table.pl. +Please be careful if you alter this setting, it will affect +ALL your links! -

-So, let's look at an example spot filter. It does not matter in the example -who the filter is to be used for. So, what do we need in the filter? We need -to filter the spots the user/node requires and also set a default rule for -anything else outside the filter. Below is a simple filter that stops spots -arriving from outside Europe. +

+For the default routing filter then you have two real choices: either +a "national" view or the "safe" option of only your own +callsign. Examples of each (for my node: GB7DJK) are:- -$in = [ - [ 0, 4, 'a', '^(K|N|A|W|VE|VA|J)'], # 0 = drop, 'a' = alphanumeric - [ 1, 0, 'd', 0, 1 ], # 1 = want, 'd' = everything else - ]; + +acc/route node_default call_dxcc 61,38 +acc/route node_default call gb7djk -

-So the filter is wrapped in between a pair of square brackets. This tells -Spider to look in between these limits. Then each line is contained within -its own square brackets and ends with a comma. Lets look carefully at the first -line. The first element is 0 (drop). Therefore anything we put on this line -will not be accepted. The next element is 4. This means we are filtering by -the spotter. The third element is the letter "a" which tells the program to -expect an alphanumeric expression in the fourth element. The fourth element -is a list of letters separated by the pipe symbol. - -

-What this line does is tell the program to drop any spots posted by anyone in -the USA, Canada or Japan. +GB7DJK uses the first of these. The DXCC countries can be obtained from the +show/prefix command. -

-The second line is the default rule for anything else. The "d" tells us this -and the line simply reads... accept anything else. +

+The example filters shown control output TO all your +partner nodes unless they have a specific filter applied to them (see +next section). -

-You can add as many lines as you need to complete the filter but if there are -several lines of the same type it is neater to enclose them all as one line. -An example of this is where specific bands are set. We could write this like -this .... +

+It is also possible to control the incoming routing +information that you are prepared to accept FROM your partner +nodes. The reason this is necessary is to make sure that stuff like +mail, pings and similar commands a) go down the correct links and b) +don't loop around excessively. Again using GB7DJK as an example a typical +default input filter would be something like: -[ 0,0,'r',[1800.0, 2000.0], 1], -[ 0,0,'r',[10100.0, 10150.0], 1], -[ 0,0,'r',[14000.0, 14350.0], 1], -[ 0,0,'r',[18000.0, 18200.0], 1], +rej/route node_default input call_dxcc 61,38 and not channel_dxcc 61,38 -

-But the line below achieves the same thing and is more efficient .... +What this does is accept node and user information for our national +network from nodes that are in our national network, but rejects such +information from anyone else. Although it doesn't explicitly say so, +by implication, any other node information (not from the UK and Eire) +is accepted. + +

+As I imagine it will take a little while to get one's head around all of this you +can study the effect of any rules that you try by watching the debug output +after having done:- - [ 0, 0, 'r', - [ - 1800.0, 2000.0, # top band - 10100.0, 10150.0, # WARC - 14000.0, 14350.0, # 20m - 18000.0, 18200.0, # WARC - [ ,1 ], +set/debug filter +After you have got tired of that, to put it back the way it was:- + + +unset/debug filter + -Announcements +General route filtering

+Exactly the same rules apply for general route filtering. You would +use either an accept filter or a reject filter like this ... + +reject/route <node_call> <filter_option> -# This is an example announce or filter allowing only West EU announces -# -# The element list is:- -# 0 - callsign of announcer -# 1 - destination * = all, = routed to the node -# 2 - text -# 3 - * - sysop, - special list eg 6MUK, ' ', normal announce -# 4 - origin -# 5 - 0 - announce, 1 - wx -# 6 - channel callsign (the interface from which this spot came) +or -$in = [ - [ 1, 0, 'a', '^(P[ABCDE]|DK0WCY|G|M|2|EI|F|ON)' ], - [ 0, 0, 'd', 0 ] -]; +accept/route <node_call> <filter_option> -In this example, only the prefixes listed will be allowed. It is possible to -be quite specific. The Dutch prefix "P" is followed by several secondary -identifiers which are allowed. So, in the example, "PA" or "PE" would be ok -but not "PG". It is even possible to allow information from a single callsign. -In the example this is DK0WCY, to allow the posting of his Aurora Beacon. - -WWV -

+Here are some examples of route filters ... + +rej/route gb7djk call_dxcc 61,38 (everything except UK+EIRE nodes) +rej/route all (equiv to [very] restricted mode) +acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes) +acc/route gb7djk call gb7djk (equiv to SET/ISOLATE) + -# This is an example WWV filter -# -# The element list is:- -# 0 - nominal unix date of spot (ie the day + hour:13) -# 1 - the hour -# 2 - SFI -# 3 - K -# 4 - I -# 5 - text -# 6 - spotter -# 7 - origin -# 8 - incoming interface callsign - -# this one doesn't filter, it just sets the hop count to 6 and is -# used mainly just to override any isolation from WWV coming from -# the internet. +In practice you will either be opening the default filter out for a +partner by defining a specific filter for that callsign:- + + +acc/route gb7baa all +acc/route gb7baa input all + -$in = [ - [ 1, 0, 'd', 0, 6 ] -]; +or restricting it quite a lot, in fact making it very nearly like an isolated node, like this:- + +acc/route pi4ehv-8 call gb7djk +rej/route pi4ehv-8 input call_dxcc 61,38 -

-It should be noted that the filter will start to be used only once a user/node -has logged out and back in again. -

-I am not going to spend any more time on these filters now as they will become -more "comprehensive" in the near future. +This last example takes everything except UK and Eire from PI4EHV-8 +but only sends him my local configuration (just a PC19 for GB7DJK and +PC16s for my local users). + +

+It is possible to do much more complex rules, there are up to 10 +accept/reject pairs per callsign per filter. For more information see the +next section. -Filtering (New Style v1.45 and later) General filter rules @@ -1183,7 +243,7 @@ generally at filtering. There are a number of things you can filter in the DXSpider system. They all use the same general mechanism.

-In general terms you can create a 'reject' or an 'accept' filter which can have +In general terms you can create a "reject" or an "accept" filter which can have up to 10 lines in it. You do this using, for example ... @@ -1377,6 +437,116 @@ what happens is that the reject is executed first, any non hf/cw spot is passed to the accept line, which lets through everything else on HF. The next filter line lets through just VHF/UHF spots from EU. +Basic hop control + +

+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 ... + + +# +# hop table construction +# + +package DXProt; + +# default hopcount to use +$def_hopcount = 5; + +# some variable hop counts based on message type +%hopcount = +( + 11 => 10, + 16 => 10, + 17 => 10, + 19 => 10, + 21 => 10, +); + + +# the per node hop control thingy + + +%nodehops = + + GB7ADX => { 11 => 8, + 12 => 8, + 16 => 8, + 17 => 8, + 19 => 8, + 21 => 8, + }, + + 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, + }, +}; + + +

+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. + +

+You can alter this file at any time, including whilst the cluster is running. +If you alter the file during runtime, the command load/hops will +bring your changes into effect. + +Isolating networks + +

+It is possible to isolate networks from each other on a "gateway" node using the + set/isolate <node_call> command. + +

+The effect of this is to partition an isolated network completely from another +node 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. + +

+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. + +

+If you use isolate on a node connection you will continue to receive all +information from the isolated partner, however you will not pass any information +back to the isolated node. There are times when you would like to forward only +spots across a link (maybe during a contest for example). To do this, isolate +the node in the normal way and put in a filter in the /spider/filter/spots +directory to override the isolate. This filter can be very simple and consists +of just one line .... + + +$in = [ + [ 1, 0, 'd', 0, 3] # The last figure (3) is the hop count +]; + Other filters @@ -2312,6 +1482,50 @@ default for nodes and users eg:- accept/ann user_default by G,M,2 +accept/route (8) + +

+ +accept/route <call> [0-9] <pattern> Set an 'accept' filter line for routing + + +

+Create an 'accept this routing PC Protocol' line for a filter. + +

+An accept filter line means that if a PC16/17/19/21/24/41/50 matches this filter +it is passed thru that interface. See HELP FILTERING for more info. Please read this +to understand how filters work - it will save a lot of grief later on. + +

+You can use any of the following things in this line:- + + + call the callsign of the thingy + call_dxcc eg: 61,62 (from eg: sh/pre G) + call_itu + call_zone + origin really the interface it came in on + origin_dxcc eg: 61,62 (from eg: sh/pre G) + origin_itu + origin_zone + + +

+some examples:- + + + acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes) + acc/route gb7djk call gb7djk (equiv to SET/ISOLATE) + + +

+You can use the tag 'all' to accept everything eg: + + + acc/route all + + accept/spots (0)

@@ -2498,7 +1712,9 @@ default for nodes and users eg:-

Send an announcement to LOCAL users only, where <text> is the text -of the announcement you wish to broadcast +of the announcement you wish to broadcast. If you do not wish to receive +announces, use the set/noannounce command. Any announces made by +a sysop will override set/noannounce. announce full (0) @@ -3337,6 +2553,47 @@ default for nodes and users eg:- reject/ann user_default by G,M,2 +reject/route (8) + +

+ +reject/route <call> [0-9] <pattern> Set an 'reject' filter line for routing + + +

+Create an 'reject this routing PC Protocol' line for a filter. + +

+An reject filter line means that if a PC16/17/19/21/24/41/50 matches this filter +it is NOT passed thru that interface. See HELP FILTERING for more info. Please +read this to understand how filters work - it will save a lot of grief later on. +You can use any of the following things in this line:- + + + call the callsign of the thingy + call_dxcc eg: 61,62 (from eg: sh/pre G) + call_itu + call_zone + origin really the interface it came in on + origin_dxcc eg: 61,62 (from eg: sh/pre G) + origin_itu + origin_zone + + +

+some examples:- + + + rej/route gb7djk call_dxcc 61,38 (everything except UK+EIRE nodes) + + +

+You can use the tag 'all' to reject everything eg: + + + rej/route all (equiv to [very] restricted mode) + + reject/spots (0)

@@ -3687,6 +2944,13 @@ Use with extreme care. This command may well be superceded by FILTERing.

Add a beep to DX and other terminal messages. +set/bbs (5) + +

+ +set/bbs <call> [<call>..]Make <call> a BBS + + set/clx (5)

@@ -4172,6 +3436,43 @@ for more information. Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER for more information. +show/configuration (0) + +

+ +show/configuration [<node>] Show all visible nodes and their users + + +

+This command allows you to see all the users that can be seen +and the nodes to which they are connected. With the optional node, +you can specify a particular node to look at. + +This command is normally abbreviated to: sh/c + +BE WARNED: the list that is returned can be VERY long + +show/configuration/node (0) + +

+ +show/configuration/node Show all the nodes connected + + +

+Show all the nodes connected locally and the nodes they have connected. + +show/connect (1) + +

+ +show/connect Show all the active connections + + +

+This command shows information on all the active connections known to +the node. This command gives slightly more information than WHO. + show/date (0)

@@ -4741,6 +4042,24 @@ Only the fields that are defined (in perl term) will be displayed. This command shows the internal status of a message and includes information such as to whom it has been forwarded, its size, origin etc etc. +

+If no message number is given then the status of the message system is +displayed. + +stat/route_node (5) + +

+ +stat/route_node <callsign> Show the data in a Route::Node object + + +stat/route_user (5) + +

+ +stat/route_user <callsign> Show the data in a Route::User object + + stat/user (5)