X-Git-Url: http://dxcluster.org/gitweb/gitweb.cgi?a=blobdiff_plain;f=sgml%2Fadminmanual.sgml;h=f075b7988bb9a35e03316d921e811fe9350b3e60;hb=629ca1bff41ef8c74e61267b36f4028581789789;hp=d91dab680b17f3f7de83b9d1201f4e6f61e257b0;hpb=71ce25e28013877858408ae610c9eaf6d1fb001c;p=spider.git diff --git a/sgml/adminmanual.sgml b/sgml/adminmanual.sgml index d91dab68..f075b798 100644 --- a/sgml/adminmanual.sgml +++ b/sgml/adminmanual.sgml @@ -6,7 +6,7 @@ The DXSpider Administration Manual v1.48 Ian Maude, G0VGS, (ianmaude@btinternet.com) -Version 1.48 August 2001 revision 1.1 +Version 1.48 September 2001 revision 1.2 A reference for SysOps of the DXSpider DXCluster program. @@ -37,23 +37,23 @@ of protection for these nodes.

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

-The new functionality introduced in version 1.48 is filtering the node +The new functionality introduced in version 1.48 allows filtering the node and user protocol frames on a "per interface" basis. We call this route filtering. This is used instead of isolation.

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 +which user and node management PC protocol frames pass to each of your +partner nodes. You can also limit what comes into your node from your +partners. It is even possible to control the settings that your partner +node has for the routing information that it sends to you (using the rcmd command). Route Filters @@ -66,19 +66,27 @@ However using a default filter is an appropriate thing to do. How, is explained further on.

-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. +The first thing that you must do is determine whether you need to use +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.

-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. +To put it simply, you should not mix Isolation and Route Filtering. It +will work, of sorts, but you will not get the expected results. If you +are using Isolation sucessfully at the moment, do not get involved in +Route Filtering unless you have a good supply of aspirin! Once you have +started down the road of Route Filtering, do not use Isolation either. +Use one or the other, not both. + +

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

I should at this stage give a little bit of background on filters. All @@ -125,7 +133,8 @@ channel_zone <numbers> Please be careful if you alter this setting, it will affect -ALL your links! +ALL your links! Remember, this is a default +filter for node connections, not a per link default.

For the default routing filter then you have two real choices: either @@ -164,9 +173,9 @@ 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:- +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:- set/debug filter @@ -196,8 +205,8 @@ accept/route <node_call> <filter_option> 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) +rej/route gb7djk call_dxcc 61,38 (send 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) @@ -210,7 +219,8 @@ acc/route gb7baa all acc/route gb7baa input all -or restricting it quite a lot, in fact making it very nearly like an isolated node, like this:- +or restricting it quite a lot, in fact making it very nearly like an +isolated node, like this:- acc/route pi4ehv-8 call gb7djk @@ -222,9 +232,9 @@ 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. +It is possible to write much more complex rules, there are up +to 10 accept/reject pairs per callsign per filter. For more information +see the next section. General filter rules @@ -509,6 +519,25 @@ 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. +Hop Control on Specific Nodes + +

You can set a callsign specific hop count for any of the standard filter +options so:- + + +set/hops gb7djk spot 4 +set/hops node_default route 10 +set/hops gb7baa wcy 5 + + +all work on their specific area of the protocol. + +

+The set/hops command overrides any hops that you have set otherwise. + +

+You can set what hops have been set using the show/hops command. + Isolating networks

@@ -529,24 +558,12 @@ 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 -]; - +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 use +an acc/spot >call< all filter to override the isolate. Other filters @@ -601,64 +618,65 @@ headers that we do not want to pass on to either the users of the cluster or the other cluster nodes that we are linked to. This is usually because of rules and regulations pertaining to items for sale etc in a particular country. -Filtering DX callouts (Depricated) -

-From version 1.47, this method is replaced by the command set/baddx +Filtering words from text fields in Announce, Talk and DX spots -

-In the same way as mail, there are some types of spot we do not wish to pass on -to users or linked cluster nodes. In the /spider/data directory you will find -a file called baddx.pl.issue. Rename this to baddx.pl and edit the file. The -original looks like this .... +

+From version 1.48 onwards the interface to this has changed. You can now +use the commands set/badword to add words that you are not prepared +to see on the cluster, unset/badword to allow that word again and +show/badword to list the words that you have set. - +

+If you have a previous /spider/data/badwords, the first time you start +the node, it will read and convert this file to the new commands. The old style +file will then be removed. -# the list of dx spot addresses that we don't store and don't pass on +Stopping (possibly bad) DX Spots from Nodes or Spotters +

+There are a number of commands that control whether a spot progresses +any further by regarding it as "bad" in some way. -package DXProt; +

+A DX Spot has a number of fields which can be checked to see whether they +contain "bad" values, they are: the DX callsign itself, the Spotter and +the Originating Node. -@baddx = qw - - FROG - SALE - FORSALE - WANTED - P1RATE - PIRATE - TEST - DXTEST - NIL - NOCALL -); - +

+There are a set of commands which allow the sysop to control whether a +spot continues:- -

-Again, this is simply a list of names we do not want to see in the spotted -field of a DX callout. + +set/baddx +set/badspotter +set/badnode + +These work in the same as the set/badword command, you can add +any words or callsigns or whatever to the appropriate database. For +example, to stop a spot from a particular node you do: -Filtering words from text fields in Announce, Talk and DX spots + +set/badnode gb7djk gb7dxc + -

-Create a file in /spider/data called badwords. The format is quite -simple. Lines beginning with # are ignored so comments can be added. An -example file is below ... +a bad spotter: -# Below is a list of words we do not wish to see on the cluster -grunge grunged grunging -splodge splodger splodging -grince -fluffle +set/badspotter b0mb p1rat nocall -Multiple words can be used on the same line as shown. Obviously these -are just examples :-) +and some bad dx: -

-You can reload the file from the cluster prompt as sysop with load/badwords. + +set/baddx video wsjt + + +You can remove a word using the appropriate unset command +(unset/baddx, unset/badspotter, unset/badnode) or list them +using one of show/baddx, show/badspotter and +show/badnode. Mail @@ -853,6 +871,47 @@ Please be careful not to flood the cluster network with unnecessary mail. Make sure you only send mail to the clusters that want it by using the Forward.pl file very carefully. +Scripts + +

+From 1.48 onwards it will become increasingly possible to control DXSpider's +operation with scripts of various kinds. + +

+In the first instance, in 1.48, the sysop can create, with their favorite +text editor, files in the directory /spider/scripts which contain +any legal command for a callsign or class of connection which will be executed +at logon. + +

+The filename is the callsign of the connection that you want the script to +operate on, eg: /spider/scripts/g1tlh. The filenames are always in +lower case on those architectures where this makes a difference. + +

+In addition to the callsign specific scripts there are three others:- + + +startup +user_default +node_default + + +The startup script is executed immediately after all +initialisation of the node is done, but before any connections are +possible. + +

+The user_default script is executed for every user that does +NOT already have a specific script. + +

+The node_default script is executed for every node that doesn't +have a specific script. + +

+There are a couple of examples in the /spider/scripts directory. + Databases

@@ -1299,14 +1358,9 @@ that it is possible to update your DXSpider installation to the latest sources by using a few simple commands.

-THIS IS NOT FOR THE FAINT HEARTED!!! ONLY DO THIS IF YOU HAVE A TEST -INSTALLATION OR ARE WILLING TO HAVE YOUR CLUSTER CRASH ON YOU!!! -THIS MUST BE CONSIDERED AT LEAST BETA TESTING AND MAYBE EVEN ALPHA!! -YOU HAVE BEEN WARNED!!! - -

-DID I MENTION..... ONLY DO THIS IF YOU ARE WILLING TO ACCEPT THE -CONSEQUENCES!!! +Please be aware that if you update your system using CVS, it is possible that +you could be running code that is very beta and not fully tested. There is +a possibility that it could be unstable.

I am of course assuming that you have a machine with both DXSpider and @@ -2263,19 +2317,6 @@ Reload the /spider/cmd/Aliases file after you have editted it. You will need to do this if you change this file whilst the cluster is running in order for the changes to take effect. - -load/baddx (9) - -

- -load/baddx Reload the bad DX table - - -

-Reload the /spider/data/baddx.pl file if you have changed it manually whilst -the cluster is running. This table contains the DX Calls that, if spotted, -will not be passed on. FR0G and TEST are classic examples. - load/badmsg (9)

@@ -2289,21 +2330,6 @@ the cluster is running. This table contains a number of perl regular expressions which are searched for in the fields targetted of each message. If any of them match then that message is immediately deleted on receipt. -load/badwords (9) - -

- -load/badwords Reload the badwords file - - -

-Reload the /spider/data/badwords file if you have changed it manually whilst -the cluster is running. This file contains a list of words which, if found -on certain text portions of PC protocol, will cause those protocol frames -to be rejected. It will all put out a message if any of these words are -used on the announce, dx and talk commands. The words can be one or -more on a line, lines starting with '#' are ignored. - load/bands (9)