updated documentation a bit
[spider.git] / html / adminmanual-2.html
index fd676b8dfd2362b4c9bb8a0304d96cab3f893535..25afaa266e8f6f55fb39b346a5924fafd611bf2f 100644 (file)
@@ -2,7 +2,7 @@
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Installation and Administration Manual: Quick installation guide (Linux version)</TITLE>
+ <TITLE>The DXSpider Administration Manual v1.48: Other filters</TITLE>
  <LINK HREF="adminmanual-3.html" REL=next>
  <LINK HREF="adminmanual-1.html" REL=previous>
  <LINK HREF="adminmanual.html#toc2" REL=contents>
 <A HREF="adminmanual-1.html">Previous</A>
 <A HREF="adminmanual.html#toc2">Contents</A>
 <HR>
-<H2><A NAME="s2">2. Quick installation guide (Linux version)</A></H2>
+<H2><A NAME="s2">2. Other filters</A></H2>
 
-<P>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.
+<H2><A NAME="ss2.1">2.1 Filtering Mail</A>
+</H2>
+
+<P>In the /spider/msg directory you will find a file called badmsg.pl.issue.  Rename
+this to badmsg.pl and edit the file.  The original looks something like this ....
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+
+# the list of regexes for messages that we won't store having
+# received them (bear in mind that we must receive them fully before
+# we can bin them)
+
+
+# The format of each line is as follows
+
+#     type      source             pattern 
+#     P/B/F     T/F/O/S            regex  
+
+# type: P - private, B - bulletin (msg), F - file (ak1a bull)
+# source: T - to field, F - from field,  O - origin, S - subject 
+# pattern: a perl regex on the field requested
+
+# Currently only type B and P msgs are affected by this code.
+# 
+# The list is read from the top down, the first pattern that matches
+# causes the action to be taken.
+
+# The pattern can be undef or 0 in which case it will always be selected
+# for the action specified
+
+
+
+package DXMsg;
+
+@badmsg = (
+'B',    'T',    'SALE', 
+'B',    'T',    'WANTED',
+'B',    'S',    'WANTED',
+'B',    'S',    'SALE', 
+'B',    'S',    'WTB',
+'B',    'S',    'WTS',
+'B',    'T',    'FS',
+);
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>
+<P>I think this is fairly self explanatory.  It is simply a list of subject 
+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.
+<P>
+<P>
+<H2><A NAME="ss2.2">2.2 Filtering words from text fields in Announce, Talk and DX spots</A>
+</H2>
+
+<P>From version 1.48 onwards the interface to this has changed. You can now
+use the commands <EM>set/badword</EM> to add words that you are not prepared
+to see on the cluster, <EM>unset/badword</EM> to allow that word again and 
+<EM>show/badword</EM> to list the words that you have set.
+<P>
+<P>If you have a previous <EM>/spider/data/badwords</EM>, 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.
+<P>
+<H2><A NAME="ss2.3">2.3 Stopping (possibly bad) DX Spots from Nodes or Spotters</A>
+</H2>
+
+<P> 
+There are a number of commands that control whether a spot progresses
+any further by regarding it as "bad" in some way.
+<P>
+<P>A DX Spot has a number of fields which can checked to see whether they
+contain "bad" values, they are: the DX callsign itself, the Spotter and
+the Originating Node.
+<P>
+<P>There are a set of commands which allow the sysop to control whether a
+spot continues:-
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/baddx
+set/badspotter
+set/badnode
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>These work in the same as the <EM>set/badword</EM> 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:
 <P>
-<UL>
-<LI>Login as root</LI>
-<LI>Get the additional CPAN modules and install them (root)</LI>
-<LI>Create the "sysop" user and set a password (root)</LI>
-<LI>Put the Spider tarball in &nbsp;sysop and untar it (root)</LI>
-<LI>ln -s &nbsp;sysop/spider /spider (root)</LI>
-<LI>groupadd -g 251 spider (root)</LI>
-<LI>Add any more users you need to the group entry in /etc/group (root)</LI>
-<LI>Set the permissions on the spider tree (root)</LI>
-<LI>Fix permissions on ax25_call and netrom_call (root)</LI>
-<LI>Login as the sysop user</LI>
-<LI>cd to /spider (sysop)</LI>
-<LI>mkdir local (sysop)</LI>
-<LI>mkdir local_cmd (sysop)</LI>
-<LI>cp perl/DXVars.pm.issue local/DXVars.pm (sysop)</LI>
-<LI>cd to /spider/local and edit DXVars to set your details (sysop)</LI>
-<LI>cd ../perl (sysop)</LI>
-<LI>./create_sysop.pl (sysop)</LI>
-<LI>./cluster.pl (sysop)</LI>
-</UL>
-<P>Spider should now be running and you should be able to login using the
-client program.
+<BLOCKQUOTE><CODE>
+<PRE>
+set/badnode gb7djk gb7dxc
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>a bad spotter:
 <P>
-<UL>
-<LI>Login as root</LI>
-<LI>Enter the correct line in ax25d.conf (root)</LI>
-<LI>Enter the correct line in /etc/services (root)</LI>
-<LI>Enter the correct line in /etc/inetd.conf (root)</LI>
-<LI>killall -HUP inetd (root)</LI>
-</UL>
-<P>Spider should now be able to accept logins via telnet, netrom and ax25.
+<BLOCKQUOTE><CODE>
+<PRE>
+set/badspotter b0mb p1rat nocall
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>and some bad dx:
 <P>
-<UL>
-<LI>Login as sysop</LI>
-<LI>Start the cluster (sysop)</LI>
-<LI>set/node and type for links (sysop)</LI>
-<LI>Write any connect scripts (sysop)</LI>
-<LI>Edit /spider/crontab as required (sysop)</LI>
-<LI>Edit any other files as necessary (sysop)</LI>
-<LI>Set filters, hops and forwarding files (sysop)</LI>
-<LI>Login as root</LI>
-<LI>Enter the correct line in /etc/inittab (root)</LI>
-</UL>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/baddx video wsjt
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>You can remove a word using the appropriate unset command
+(<EM>unset/baddx, unset/badspotter, unset/badnode</EM>) or list them
+using one of <EM>show/baddx, show/badspotter</EM> and
+<EM>show/badnode</EM>.
 <P>
 <HR>
 <A HREF="adminmanual-3.html">Next</A>