1 <!doctype linuxdoc system>
\r
5 <!-- Title information -->
\r
7 <title>The DXSpider Administration Manual v1.50</title>
\r
8 <author>Ian Maude, G0VGS, (g0vgs@gb7mbc.net), and
\r
9 Charlie Carroll, K1XX, (k1xx@ptcnh.net)</author>
\r
10 <date>February 2003 revision 0.4</date>
\r
13 A reference for SysOps of the DXSpider DXCluster program.
\r
16 <!-- Table of contents -->
\r
19 <!-- Begin the document -->
\r
21 <sect>Routing and Filtering
\r
26 From DXSpider version 1.48, major changes were introduced to the way
\r
27 node connections are treated. This is part of an ongoing process to
\r
28 remove problems with loops and to enable talk and other functions to
\r
29 propagate across the whole of the worldwide cluster network. In fact,
\r
30 in a Spider network, it would be useful, perhaps even necessary to
\r
31 have loops. This would give real resilience to the network, meaning
\r
32 that if a link dropped, the information flow would simply come in and
\r
33 go out via a different route. Of course, we do not have a complete
\r
34 network of Spider nodes, there are other programs out there. Some of
\r
35 these do not have any protection from loops. Certainly AK1A does not
\r
36 handle loops well at all. It is therefore necessary to have some form
\r
37 of protection for these nodes.
\r
40 In fact DXSpider has had a simple system for some time which is called
\r
41 <it>isolation</it>. This is similar to what in other systems such as
\r
42 <bf>clx</bf>, is called <it>passive mode</it>. A more detailed explanation
\r
43 of <it>isolation</it> is given further below. This system is still available
\r
44 and, for simple networks, is probably all that you need.
\r
47 The new functionality introduced in version 1.48 allows filtering the node
\r
48 and user protocol frames on a "per interface" basis. We call this
\r
49 <it>route filtering</it>. This is used <bf>instead of</bf>
\r
50 <it>isolation</it>.
\r
53 What this really means is that you can control more or less completely
\r
54 which user and node management PC protocol frames pass to each of your
\r
55 partner nodes. You can also limit what comes into your node from your
\r
56 partners. It is even possible to control the settings that your partner
\r
57 node has for the routing information that it sends to you
\r
58 (using the <it>rcmd</it> command).
\r
60 <sect1>Route Filters
\r
63 Initially when route filters were being tested we generated a
\r
64 "default" filter. Unfortunately it quickly became apparent that this
\r
65 might suit the UK cluster network but didn't really fit anybody else.
\r
66 However using a default filter is an appropriate thing to do. How, is
\r
67 explained further on.
\r
70 The first thing that you must do is determine whether you need to use
\r
71 route filtering <bf>at all</bf>. If you are a "normal" node with two or
\r
72 three partners and you arranged in an "official" non-looping tree type
\r
73 network, then <bf>you do not need to do route filtering</bf> and you will
\r
74 feel a lot better for not getting involved. If you are successfully using
\r
75 <it>isolation</it> then you also probably don't need to use route filtering.
\r
78 To put it simply, you should not mix Isolation and Route Filtering. It
\r
79 will work, of sorts, but you will not get the expected results. If you
\r
80 are using Isolation sucessfully at the moment, do not get involved in
\r
81 Route Filtering unless you have a good supply of aspirin! Once you have
\r
82 started down the road of Route Filtering, do not use Isolation either.
\r
83 Use one or the other, not both.
\r
86 You will only require this functionality if you are "well-connected". What
\r
87 that means is that you are connected to several different parts of (say)
\r
88 the EU cluster and, at the same time, also connected to two or three places
\r
89 in the US which, in turn are connected back to the EU. This is called a
\r
90 "loop" and if you are seriously looped then you need filtering.
\r
93 I should at this stage give a little bit of background on filters. All
\r
94 the filters in Spider work in basically the same way. You can either
\r
95 accept or reject various options in order to create the filter rules
\r
96 you wish to achieve. Some filters are user settable, others can only
\r
97 be altered by the sysop. Route filtering can only be done by the sysop.
\r
100 Anyway, without further discouragement, let me start the process
\r
103 <sect1>The node_default filter
\r
106 All normal systems should have a default routing filter and it should
\r
107 usually be set to send only the normal, unlooped, view of your
\r
108 "national" network. Here in the UK that means nodes from the UK and
\r
109 Eire, in EU it is more complex as the networks there grew up in a more
\r
113 The generic commands are:-
\r
116 reject/route node_default <filter_option>
\r
120 accept/route node_default <filter_option>
\r
123 where filter_option is one of the following ...
\r
126 call <prefixes>
\r
127 call_dxcc <numbers>
\r
128 call_itu <numbers>
\r
129 call_zone <numbers>
\r
130 channel <prefixes>
\r
131 channel_dxcc <numbers>
\r
132 channel_itu <numbers>
\r
133 channel_zone <numbers>
\r
136 Please be careful if you alter this setting, it will affect
\r
137 <bf><it>ALL</it></bf> your links! Remember, this is a <it>default</it>
\r
138 filter for node connections, not a <it>per link</it> default.
\r
141 For the default routing filter then you have two real choices: either
\r
142 a "national" view or the "safe" option of only your own
\r
143 callsign. Examples of each (for my node: GB7DJK) are:-
\r
146 acc/route node_default call_dxcc 61,38
\r
147 acc/route node_default call gb7djk
\r
150 GB7DJK uses the first of these. The DXCC countries can be obtained from the
\r
151 <it>show/prefix</it> command.
\r
154 The example filters shown control <it>output</it> <bf>TO</bf> all your
\r
155 partner nodes unless they have a specific filter applied to them (see
\r
159 It is also possible to control the <it>incoming</it> routing
\r
160 information that you are prepared to accept <bf>FROM</bf> your partner
\r
161 nodes. The reason this is necessary is to make sure that stuff like
\r
162 mail, pings and similar commands a) go down the correct links and b)
\r
163 don't loop around excessively. Again using GB7DJK as an example a typical
\r
164 default input filter would be something like:
\r
167 rej/route node_default input call_dxcc 61,38 and not channel_dxcc 61,38
\r
170 What this does is accept node and user information for our national
\r
171 network from nodes that are in our national network, but rejects such
\r
172 information from anyone else. Although it doesn't explicitly say so,
\r
173 by implication, any other node information (not from the UK and Eire)
\r
177 As I imagine it will take a little while to get one's head around all of
\r
178 this you can study the effect of any rules that you try by watching the
\r
179 debug output after having done:-
\r
185 After you have got tired of that, to put it back the way it was:-
\r
191 <sect1>General route filtering
\r
194 Exactly the same rules apply for general route filtering. You would
\r
195 use either an accept filter or a reject filter like this ...
\r
198 reject/route <node_call> <filter_option>
\r
202 accept/route <node_call> <filter_option>
\r
206 Here are some examples of route filters ...
\r
209 rej/route gb7djk call_dxcc 61,38 (send everything except UK+EIRE nodes)
\r
210 rej/route all (equiv to [very] restricted mode)
\r
211 acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)
\r
212 acc/route gb7djk call gb7djk (equiv to SET/ISOLATE)
\r
215 In practice you will either be opening the default filter out for a
\r
216 partner by defining a specific filter for that callsign:-
\r
219 acc/route gb7baa all
\r
220 acc/route gb7baa input all
\r
223 or restricting it quite a lot, in fact making it very nearly like an
\r
224 <it>isolated</it> node, like this:-
\r
227 acc/route pi4ehv-8 call gb7djk
\r
228 rej/route pi4ehv-8 input call_dxcc 61,38
\r
231 This last example takes everything except UK and Eire from PI4EHV-8
\r
232 but only sends him my local configuration (just a PC19 for GB7DJK and
\r
233 PC16s for my local users).
\r
236 It is possible to write <bf>much</bf> more complex rules, there are up
\r
237 to 10 accept/reject pairs per callsign per filter. For more information
\r
238 see the next section.
\r
241 <sect1>General filter rules
\r
244 Upto v1.44 it was not possible for the user to set their own filters. From
\r
245 v1.45 though that has all changed. It is now possible to set filters for just
\r
246 about anything you wish. If you have just updated from an older version of
\r
247 DXSpider you will need to update your new filters. You do not need to do
\r
248 anything with your old filters, they will be renamed as you update.
\r
251 There are 3 basic commands involved in setting and manipulating filters. These
\r
252 are <em>accept</em>, <em>reject</em> and <em>clear</em>. First we will look
\r
253 generally at filtering. There are a number of things you can filter in the
\r
254 DXSpider system. They all use the same general mechanism.
\r
257 In general terms you can create a "reject" or an "accept" filter which can have
\r
258 up to 10 lines in it. You do this using, for example ...
\r
265 where ..... are the specific commands for that type of filter. There are filters
\r
266 for spots, wwv, announce, wcy and (for sysops) connects. See each different
\r
267 accept or reject command reference for more details.
\r
269 There is also a command to clear out one or more lines in a filter. They are ...
\r
276 There is clear/xxxx command for each type of filter.
\r
279 and you can check that your filters have worked by the command ...
\r
286 For now we are going to use spots for the examples, but you can apply the same
\r
287 principles to all types of filter.
\r
289 <sect1>Types of filter
\r
292 There are two main types of filter, <em>accept</em> or <em>reject</em>. You
\r
293 can use either to achieve the result you want dependent on your own preference
\r
294 and which is more simple to do. It is pointless writing 8 lines of reject
\r
295 filters when 1 accept filter would do the same thing! Each filter has 10
\r
296 lines (of any length) which are tried in order. If a line matches then the
\r
297 action you have specified is taken (ie reject means ignore it and accept
\r
301 If you specify reject filters, then any lines that arrive that match the filter
\r
302 will be dumped but all else will be accepted. If you use an accept filter,
\r
303 then ONLY the lines in the filter will be accepted and all else will be dumped.
\r
304 For example if you have a single line <em>accept</em> filter ...
\r
307 accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
\r
310 then you will <em>ONLY</em> get VHF spots <em>from</em> or <em>to</em> CQ zones
\r
314 If you set a reject filter like this ...
\r
317 reject/spots on hf/cw
\r
320 Then you will get everything <em>EXCEPT</em> HF CW spots. You could make this
\r
321 single filter even more flexible. For example, if you are interested in IOTA
\r
322 and will work it even on CW even though normally you are not interested in
\r
323 CW, then you could say ...
\r
326 reject/spots on hf/cw and not info iota
\r
329 But in that case you might only be interested in iota and say:-
\r
332 accept/spots not on hf/cw or info iota
\r
335 which achieves exactly the same thing. You should choose one or the other
\r
336 until you are comfortable with the way it works. You can mix them if you
\r
337 wish (actually you can have an accept AND a reject on the same line) but
\r
338 don't attempt this until you are sure you know what you are doing!
\r
341 You can arrange your filter lines into logical units, either for your own
\r
342 understanding or simply convenience. Here is an example ...
\r
345 reject/spots 1 on hf/cw
\r
346 reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)
\r
349 What this does is to ignore all HF CW spots and also rejects any spots on VHF
\r
350 which don't either originate or spot someone in Europe.
\r
353 This is an example where you would use a line number (1 and 2 in this case), if
\r
354 you leave the digit out, the system assumes '1'. Digits '0'-'9' are available.
\r
355 This make it easier to see just what filters you have set. It also makes it
\r
356 more simple to remove individual filters, during a contest for example.
\r
359 You will notice in the above example that the second line has brackets. Look
\r
360 at the line logically. You can see there are 2 separate sections to it. We
\r
361 are saying reject spots that are VHF or above <em>APART</em> from those in
\r
362 zones 14, 15 and 16 (either spotted there or originated there). If you did
\r
363 not have the brackets to separate the 2 sections, then Spider would read it
\r
364 logically from the front and see a different expression entirely ...
\r
367 (on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16
\r
370 The simple way to remember this is, if you use OR - use brackets. Whilst we are
\r
371 here CASE is not important. 'And BY_Zone' is just the same as 'and by_zone'.
\r
373 As mentioned earlier, setting several filters can be more flexible than
\r
374 simply setting one complex one. Doing it in this way means that if you want
\r
375 to alter your filter you can just redefine or remove one or more lines of it or
\r
376 one line. For example ...
\r
379 reject/spots 1 on hf/ssb
\r
382 would redefine our earlier example, or
\r
388 To remove all the filter lines in the spot filter ...
\r
394 <sect1>Filter options
\r
397 You can filter in several different ways. The options are listed in the
\r
398 various helpfiles for accept, reject and filter.
\r
400 <sect1>Default filters
\r
403 Sometimes all that is needed is a general rule for node connects. This can
\r
404 be done with a node_default filter. This rule will always be followed, even
\r
405 if the link is isolated, unless another filter is set specifically. Default
\r
406 rules can be set for nodes and users. They can be set for spots, announces,
\r
407 WWV and WCY. They can also be used for hops. An example might look like
\r
411 accept/spot node_default by_zone 14,15,16,20,33
\r
412 set/hops node_default spot 50
\r
415 This filter is for spots only, you could set others for announce, WWV and WCY.
\r
416 This filter would work for ALL nodes unless a specific filter is written to
\r
417 override it for a particular node. You can also set a user_default should
\r
418 you require. It is important to note that default filters should be
\r
419 considered to be "connected". By this I mean that should you override the
\r
420 default filter for spots, you need to add a rule for the hops for spots also.
\r
422 <sect1>Advanced filtering
\r
425 Once you are happy with the results you get, you may like to experiment.
\r
428 The previous example that filters hf/cw spots and accepts vhf/uhf spots from EU
\r
429 can be written with a mixed filter, for example ...
\r
433 acc/spot on 0/30000
\r
434 acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
\r
437 Note that the first filter has not been specified with a number. This will
\r
438 automatically be assumed to be number 1. In this case, we have said <em>reject all
\r
439 HF spots in the CW section of the bands but accept all others at HF. Also
\r
440 accept anything in VHF and above spotted in or by operators in the zones
\r
441 14, 15 and 16</em>. Each filter slot actually has a 'reject' slot and
\r
442 an 'accept' slot. The reject slot is executed BEFORE the accept slot.
\r
445 It was mentioned earlier that after a reject test that doesn't match, the default
\r
446 for following tests is 'accept', the reverse is true for 'accept'. In the example
\r
447 what happens is that the reject is executed first, any non hf/cw spot is passed
\r
448 to the accept line, which lets through everything else on HF. The next filter line
\r
449 lets through just VHF/UHF spots from EU.
\r
451 <sect1>Basic hop control
\r
454 In /spider/data you will find a file called hop_table.pl. This is the file
\r
455 that controls your hop count settings. It has a set of default hops on the
\r
456 various PC frames and also a set for each node you want to alter the hops for.
\r
457 You may be happy with the default settings of course, but this powerful tool
\r
458 can help to protect and improve the network. The file will look something
\r
463 # hop table construction
\r
468 # default hopcount to use
\r
471 # some variable hop counts based on message type
\r
482 # the per node hop control thingy
\r
487 GB7ADX => { 11 => 8,
\r
495 GB7UDX => { 11 => 8,
\r
514 Each set of hops is contained within a pair of curly braces and contains a
\r
515 series of PC frame types. PC11 for example is a DX spot. The figures here
\r
516 are not exhaustive but should give you a good idea of how the file works.
\r
519 SHould any of the nodecalls include an ssid, it is important to wrap the
\r
520 whole call in single quotes, like this ...
\r
533 If you do not do this, you will get errors and the file will not work as
\r
537 You can alter this file at any time, including whilst the cluster is running.
\r
538 If you alter the file during runtime, the command <em>load/hops</em> will
\r
539 bring your changes into effect.
\r
541 <sect1>Hop Control on Specific Nodes
\r
543 <p>You can set a callsign specific hop count for any of the standard filter
\r
547 set/hops gb7djk spot 4
\r
548 set/hops node_default route 10
\r
549 set/hops gb7baa wcy 5
\r
552 all work on their specific area of the protocol.
\r
555 The <em>set/hops</em> command overrides any hops that you have set otherwise.
\r
558 You can show what hops have been set using the <em>show/hops</em> command.
\r
560 <sect1>Isolating networks
\r
563 It is possible to isolate networks from each other on a "gateway" node using the
\r
564 <em>set/isolate <node_call></em> command.
\r
567 The effect of this is to partition an isolated network completely from another
\r
568 node connected to your node. Your node will appear on and otherwise behave
\r
569 normally on every network to which you are connected, but data from an isolated
\r
570 network will not cross onto any other network or vice versa. However all the
\r
571 spot, announce and WWV traffic and personal messages will still be handled
\r
572 locally (because you are a real node on all connected networks), that is locally
\r
573 connected users will appear on all networks and will be able to access and
\r
574 receive information from all networks transparently. All routed messages will
\r
575 be sent as normal, so if a user on one network knows that you are a gateway for
\r
576 another network, he can still still send a talk/announce etc message via your
\r
577 node and it will be routed across.
\r
580 If you use isolate on a node connection you will continue to receive
\r
581 all information from the isolated partner, however you will not pass
\r
582 any information back to the isolated node. There are times when you
\r
583 would like to forward only spots across a link (maybe during a contest
\r
584 for example). To do this, isolate the node in the normal way and use
\r
585 an <em>acc/spot >call< all</em> filter to override the isolate.
\r
587 <sect>Other filters
\r
589 <sect1>Filtering Mail
\r
592 In the /spider/msg directory you will find a file called badmsg.pl.issue. Rename
\r
593 this to badmsg.pl and edit the file. The original looks something like this ....
\r
597 # the list of regexes for messages that we won't store having
\r
598 # received them (bear in mind that we must receive them fully before
\r
602 # The format of each line is as follows
\r
604 # type source pattern
\r
605 # P/B/F T/F/O/S regex
\r
607 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
\r
608 # source: T - to field, F - from field, O - origin, S - subject
\r
609 # pattern: a perl regex on the field requested
\r
611 # Currently only type B and P msgs are affected by this code.
\r
613 # The list is read from the top down, the first pattern that matches
\r
614 # causes the action to be taken.
\r
616 # The pattern can be undef or 0 in which case it will always be selected
\r
617 # for the action specified
\r
625 'B', 'T', 'WANTED',
\r
626 'B', 'S', 'WANTED',
\r
635 I think this is fairly self explanatory. It is simply a list of subject
\r
636 headers that we do not want to pass on to either the users of the cluster or
\r
637 the other cluster nodes that we are linked to. This is usually because of
\r
638 rules and regulations pertaining to items for sale etc in a particular country.
\r
641 <sect1>Filtering words from text fields in Announce, Talk and DX spots
\r
644 From version 1.48 onwards the interface to this has changed. You can now
\r
645 use the commands <em>set/badword</em> to add words that you are not prepared
\r
646 to see on the cluster, <em>unset/badword</em> to allow that word again and
\r
647 <em>show/badword</em> to list the words that you have set.
\r
650 If you have a previous <em>/spider/data/badwords</em>, the first time you start
\r
651 the node, it will read and convert this file to the new commands. The old style
\r
652 file will then be removed.
\r
654 <sect1>Stopping (possibly bad) DX Spots from Nodes or Spotters
\r
657 There are a number of commands that control whether a spot progresses
\r
658 any further by regarding it as "bad" in some way.
\r
661 A DX Spot has a number of fields which can be checked to see whether they
\r
662 contain "bad" values, they are: the DX callsign itself, the Spotter and
\r
663 the Originating Node.
\r
666 There are a set of commands which allow the sysop to control whether a
\r
675 These work in the same as the <em>set/badword</em> command, you can add
\r
676 any words or callsigns or whatever to the appropriate database. For
\r
677 example, to stop a spot from a particular node you do:
\r
680 set/badnode gb7djk gb7dxc
\r
686 set/badspotter b0mb p1rat nocall
\r
692 set/baddx video wsjt
\r
695 You can remove a word using the appropriate unset command
\r
696 (<em>unset/baddx, unset/badspotter, unset/badnode</em>) or list them
\r
697 using one of <em>show/baddx, show/badspotter</em> and
\r
698 <em>show/badnode</em>.
\r
703 DXSpider deals seamlessly with standard AK1A type mail. It supports both
\r
704 personal and bulletin mail and the sysop has additional commands to ensure
\r
705 that mail gets to where it is meant. DXSpider will send mail almost
\r
706 immediately, assuming that the target is on line. However, only one
\r
707 mail message is dealt with at any one time. If a mail message is already
\r
708 being sent or recieved, then the new message will be queued until it has
\r
711 The cluster mail is automatically deleted after 30 days unless the sysop
\r
712 sets the "keep" flag using the <em>msg</em> command.
\r
714 <sect1>Personal mail
\r
717 Personal mail is sent using the <em>sp</em> command. This is actually the
\r
718 default method of sending mail and so a simple <em>s</em> for send will do.
\r
719 A full list of the send commands and options is in the <em>command set</em>
\r
720 section, so I will not duplicate them here.
\r
722 <sect1>Bulletin mail
\r
725 Bulletin mail is sent by using the <em>sb</em> command. This is one of the
\r
726 most common mistakes users make when sending mail. They send a bulletin
\r
727 mail with <em>s</em> or <em>sp</em> instead of <em>sb</em> and of course
\r
728 the message never leaves the cluster. This can be rectified by the sysop
\r
729 by using the <em>msg</em> command.
\r
731 <P>Bulletin addresses can be set using the Forward.pl file.
\r
736 DXSpider receives all and any mail sent to it without any alterations needed
\r
737 in files. Because personal and bulletin mail are treated differently, there
\r
738 is no need for a list of accepted bulletin addresses. It is necessary, however,
\r
739 to tell the program which links accept which bulletins. For example, it is
\r
740 pointless sending bulletins addresses to "UK" to any links other than UK
\r
741 ones. The file that does this is called forward.pl and lives in /spider/msg.
\r
742 At default, like other spider files it is named forward.pl.issue. Rename it
\r
743 to forward.pl and edit the file to match your requirements.
\r
744 The format is below ...
\r
748 # this is an example message forwarding file for the system
\r
750 # The format of each line is as follows
\r
752 # type to/from/at pattern action destinations
\r
753 # P/B/F T/F/A regex I/F [ call [, call ...] ]
\r
755 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
\r
756 # to/from/at: T - to field, F - from field, A - home bbs, O - origin
\r
757 # pattern: a perl regex on the field requested
\r
758 # action: I - ignore, F - forward
\r
759 # destinations: a reference to an array containing node callsigns
\r
761 # if it is non-private and isn't in here then it won't get forwarded
\r
763 # Currently only type B msgs are affected by this code.
\r
765 # The list is read from the top down, the first pattern that matches
\r
766 # causes the action to be taken.
\r
768 # The pattern can be undef or 0 in which case it will always be selected
\r
769 # for the action specified
\r
771 # If the BBS list is undef or 0 and the action is 'F' (and it matches the
\r
772 # pattern) then it will always be forwarded to every node that doesn't have
\r
773 # it (I strongly recommend you don't use this unless you REALLY mean it, if
\r
774 # you allow a new link with this on EVERY bull will be forwarded immediately
\r
775 # on first connection)
\r
781 'B', 'T', 'LOCAL', 'F', [ qw(GB7MBC) ],
\r
782 'B', 'T', 'ALL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
783 'B', 'T', 'UK', 'F', [ qw(GB7BAA GB7ADX) ],
\r
784 'B', 'T', 'QSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
785 'B', 'T', 'QSLINF', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
786 'B', 'T', 'DX', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
787 'B', 'T', 'DXINFO', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
788 'B', 'T', 'DXNEWS', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
789 'B', 'T', 'DXQSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
790 'B', 'T', 'SYSOP', 'F', [ qw(GB7BAA GB7ADX) ],
\r
791 'B', 'T', '50MHZ', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
795 Simply insert a bulletin address and state in the brackets where you wish
\r
796 that mail to go. For example, you can see here that mail sent to "UK" will
\r
797 only be sent to the UK links and not to PA4AB-14.
\r
800 To force the cluster to reread the file use load/forward
\r
803 NB: If a user tries to send mail to a bulletin address that does not exist
\r
804 in this file, they will get an error.
\r
806 <sect1>The msg command
\r
809 The <em>msg</em> command is a very powerful and flexible tool for the
\r
810 sysop. It allows the sysop to alter to and from fields and make other
\r
811 changes to manage the cluster mail.
\r
813 Here is a full list of the various options ...
\r
816 MSG TO <msgno> <call> - change TO callsign to <call>
\r
817 MSG FRom <msgno> <call> - change FROM callsign to <call>
\r
818 MSG PRrivate <msgno> - set private flag
\r
819 MSG NOPRrivate <msgno> - unset private flag
\r
820 MSG RR <msgno> - set RR flag
\r
821 MSG NORR <msgno> - unset RR flag
\r
822 MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
\r
823 MSG NOKEep <msgno> - unset the keep flag
\r
824 MSG SUbject <msgno> <new> - change the subject to <new>
\r
825 MSG WAittime <msgno> - remove any waiting time for this message
\r
826 MSG NOREad <msgno> - mark message as unread
\r
827 MSG REad <msgno> - mark message as read
\r
828 MSG QUeue - queue any outstanding bulletins
\r
829 MSG QUeue 1 - queue any outstanding private messages
\r
832 These commands are simply typed from within the cluster as the sysop user.
\r
834 <sect1>Message status
\r
837 You can check on a message from within the cluster by using the command
\r
838 <em>stat/msg</em>. This will give you additional information on the
\r
839 message number including which nodes have received it, which node it
\r
840 was received from and when etc. Here is an example of the output of
\r
844 G0VGS de GB7MBC 28-Jan-2001 1308Z >
\r
847 Msg Time: 26-Jan-2001 1302Z
\r
851 Subject: AMSAT 2line KEPS 01025.AMSAT
\r
853 Got it Nodes: GB7BAA, GB7ADX
\r
857 G0VGS de GB7MBC 28-Jan-2001 1308Z >
\r
860 <sect1>Filtering mail
\r
863 This is described in the section on <em>Other filters</em> so I will not
\r
866 <sect1>Distribution lists
\r
869 Distribution lists are simply a list of users to send certain types of
\r
870 mail to. An example of this is mail you only wish to send to other
\r
871 sysops. In /spider/msg there is a directory called <em>distro</em>. You
\r
872 put any distibution lists in here. For example, here is a file called
\r
873 SYSOP.pl that caters for the UK sysops.
\r
876 qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
\r
877 GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH
\r
878 GB7DXK GB7DXI GB7DXS)
\r
881 Any mail sent to "sysop" would only be sent to the callsigns in this list.
\r
883 <sect1>BBS interface
\r
886 Spider provides a simple BBS interface. No input is required from the sysop
\r
887 of the cluster at all. The BBS simply sets the cluster as a BBS and pushes
\r
888 any required mail to the cluster. No mail can flow from Spider to the BBS,
\r
889 the interface is one-way.
\r
892 Please be careful not to flood the cluster network with unnecessary mail.
\r
893 Make sure you only send mail to the clusters that want it by using the
\r
894 Forward.pl file very carefully.
\r
899 From 1.48 onwards it will become increasingly possible to control DXSpider's
\r
900 operation with scripts of various kinds.
\r
903 The directory /spider/scripts is where it all happens and is used for several
\r
904 things. Firstly it contains a file called startup that can be used to call
\r
905 in any changes to the cluster from the default settings on startup. This
\r
906 script is executed immediately after all initialisation of the node is done
\r
907 but before any connections are possible. Examples of this include how many
\r
908 spots it is possible to get with the sh/dx command, whether you want
\r
909 registration/passwords to be permanently on etc. An example file is shown
\r
910 below and is included in the distribution as startup.issue.
\r
914 # startup script example
\r
916 # set maximum no of spots allowed to 100
\r
917 # set/var $Spot::maxspots = 100
\r
919 # Set registration on
\r
920 # set/var $main::reqreg = 1
\r
923 # set/var $main::passwdreq = 1
\r
928 As usual, any text behind a # is treated as a comment and not read. To use
\r
929 this file, simply rename it from startup.issue to startup. In our example
\r
930 above there are three options. The first option is the amount of spots that
\r
931 a user can request with the <em>sh/dx</em> command. Normally the default is
\r
932 to give 10 spots unless the user specifies more. Without this line enabled,
\r
933 the maximum a user can request is 100 spots. Depending on your link quality
\r
934 you may wish to enable more or less by specifying the number.
\r
937 The other 2 options are dealt with more fully in the security section.
\r
940 Secondly, it is used to store the login scripts for users and nodes. Currently
\r
941 this can only be done by the sysop but it is envisaged that eventually users will
\r
942 be able to set their own. An example is included in the distibution but here is
\r
958 The lines in between commands can simply insert a blank line or a character
\r
959 such as a + sign to make the output easier to read. Simply create this script
\r
960 with your favourite editor and save it with the callsign of the user as the
\r
961 filename. Filenames should always be in lower case.
\r
964 Commands can be inserted in the same way for nodes. A node may wish a series
\r
965 of commands to be issued on login, such as a merge command for example.
\r
968 Thirdly, there are 2 default scripts for users and nodes who do not have a
\r
969 specifically defined script. These are <em>user_default</em> and
\r
970 <em>node_default</em>
\r
975 Spider allows the creation of local or remote databases. It supports
\r
976 chained databases, allowing several different databases to be scanned
\r
977 with one simple command. Importing of databases is limited at present
\r
978 to the standard AK1A databases such as OBLAST and the DB0SDX QSL
\r
979 database but will expand with time.
\r
981 <sect1>Creating databases
\r
984 Creating a database could not be more simple. All the commands are
\r
985 sent from the cluster prompt as the <em>sysop</em> user.
\r
987 To create a database you use the command <em>dbcreate</em>. It can
\r
988 be used in 3 different ways like so ..
\r
994 To simply create a database locally, you just tell the command the
\r
995 name of the database. This does not create the actual database, it
\r
996 simply defines it to say that it exists.
\r
999 dbcreate <name> chain <name> [<name>...]
\r
1002 This creates a chained database entry. The first database will be
\r
1003 scanned, then the second, the third etc...
\r
1006 dbcreate <name> remote <name>
\r
1009 This creates a remote entry. the first name field is the database
\r
1010 name at the remote node, then the remote switch, then the actual
\r
1011 node_call of the remote node, for example...
\r
1014 dbcreate buckmaster remote gb7dxc
\r
1017 Remote databases cannot be chained, however, the last database in a
\r
1018 chain can be a remote database.
\r
1020 <sect1>Importing databases
\r
1023 The only databases that Spider can currently import are the standard
\r
1024 AK1A databases such as OBLAST or the DB0SDX qsl and address database.
\r
1025 This will be added to with time.
\r
1027 To import such a database, first put the file somewhere useful like /tmp
\r
1028 and then issue the following command ...
\r
1031 dbimport oblast /tmp/OBLAST.FUL
\r
1034 This will update the existing local oblast database or create it if
\r
1035 it does not exist.
\r
1037 <sect1>Checking available databases
\r
1040 Once a database is created, you will want to check that it has been
\r
1041 added. To do this use the <em>dbavail</em> command. This will
\r
1042 output the available databases. For example ...
\r
1046 DB Name Location Chain
\r
1050 G0VGS de GB7MBC 3-Feb-2001 1925Z >
\r
1053 <sect1>Looking up databases
\r
1056 To look for information in a defined database, simply use the <em>dbshow</em>
\r
1057 command, for example ...
\r
1060 dbshow buckmaster G0YLM
\r
1063 will show the information for the callsign G0YLM from the buckmaster
\r
1064 database if it exists. To make things more standard for the users
\r
1065 you can add an entry in the Aliases file so that it looks like a standard
\r
1066 <em>show</em> command like this ...
\r
1069 '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
\r
1072 Now you can simply use show/buckmaster or an abreviation.
\r
1074 <sect1>Removing databases
\r
1077 To delete an existing database you use the <em>dbremove</em> command.
\r
1084 would remove the oblast database and its associated datafile from the
\r
1085 system. There are no warnings or recovery possible from this command.
\r
1086 If you remove a database it ceases to exist and would have to be created
\r
1087 from scratch if you still required it.
\r
1089 <sect>Information, files and useful programs
\r
1094 One of the more important things a cluster sysop needs to do is to get
\r
1095 information to his users. The simplest way to do this is to have a banner
\r
1096 that is sent to the user on login. This is know as a "message of the day"
\r
1097 or "motd". To set this up, simply create a file in /spider/data called motd
\r
1098 and edit it to say whatever you want. It is purely a text file and will be
\r
1099 sent automatically to anyone logging in to the cluster.
\r
1104 This message of the day file lives in the same directory as the standard
\r
1105 motd file but is only sent to non-registered users. Once registered they
\r
1106 will receive the same message as any other user.
\r
1108 <sect1>Downtime message
\r
1111 If for any reason the cluster is down, maybe for upgrade or maintenance but
\r
1112 the machine is still running, a message can be sent to the user advising them
\r
1113 of the fact. This message lives in the /spider/data directory and is called
\r
1114 "offline". Simply create the file and edit it to say whatever you wish.
\r
1115 This file will be sent to a user attempting to log into the cluster when
\r
1116 DXSpider is not actually running.
\r
1118 <sect1>Other text messages
\r
1121 You can set other text messages to be read by the user if they input the file
\r
1122 name. This could be for news items or maybe information for new users.
\r
1123 To set this up, make a directory under /spider called <em>packclus</em>.
\r
1124 Under this directory you can create files called <em>news</em> or <em>newuser</em>
\r
1125 for example. In fact you can create files with any names you like. These can
\r
1126 be listed by the user with the command ....
\r
1132 They can be read by the user by typing the command ....
\r
1138 If the file they want to read is called <em>news</em>. You could also set
\r
1139 an alias for this in the Alias file to allow them just to type <em>news</em>
\r
1142 You can also store other information in this directory, either directly or
\r
1143 nested under directories. One use for this would be to store DX bulletins
\r
1144 such as the OPDX bulletins. These can be listed and read by the user.
\r
1145 To keep things tidy, make a directory under /spider/packclus called
\r
1146 <em>bulletin</em>. Now copy any OPDX or similar bulletins into it. These
\r
1147 can be listed by the user in the same way as above using the <em>show/files</em>
\r
1148 command with an extension for the bulletin directory you have just created,
\r
1152 show/files bulletin
\r
1156 An example would look like this ....
\r
1160 bulletin DIR 20-Dec-1999 1715Z news 1602 14-Dec-1999 1330Z
\r
1163 You can see that in the files area (basically the packclus directory) there is a
\r
1164 file called <em>news</em> and a directory called <em>bulletin</em>. You can
\r
1165 also see that dates they were created. In the case of the file <em>news</em>,
\r
1166 you can also see the time it was last modified, a good clue as to whether the
\r
1167 file has been updated since you last read it. To read the file called
\r
1168 <em>news</em> you would simply issue the command ....
\r
1174 To look what is in the bulletin directory you issue the command ....
\r
1177 show/files bulletin
\r
1178 opdx390 21381 29-Nov-1999 1621Z opdx390.1 1670 29-Nov-1999 1621Z
\r
1179 opdx390.2 2193 29-Nov-1999 1621Z opdx391 25045 29-Nov-1999 1621Z
\r
1180 opdx392 35969 29-Nov-1999 1621Z opdx393 15023 29-Nov-1999 1621Z
\r
1181 opdx394 33429 29-Nov-1999 1621Z opdx394.1 3116 29-Nov-1999 1621Z
\r
1182 opdx395 24319 29-Nov-1999 1621Z opdx396 32647 29-Nov-1999 1621Z
\r
1183 opdx396.1 5537 29-Nov-1999 1621Z opdx396.2 6242 29-Nov-1999 1621Z
\r
1184 opdx397 18433 29-Nov-1999 1621Z opdx398 19961 29-Nov-1999 1621Z
\r
1185 opdx399 17719 29-Nov-1999 1621Z opdx400 19600 29-Nov-1999 1621Z
\r
1186 opdx401 27738 29-Nov-1999 1621Z opdx402 18698 29-Nov-1999 1621Z
\r
1187 opdx403 24994 29-Nov-1999 1621Z opdx404 15685 29-Nov-1999 1621Z
\r
1188 opdx405 13984 29-Nov-1999 1621Z opdx405.1 4166 29-Nov-1999 1621Z
\r
1189 opdx406 28934 29-Nov-1999 1621Z opdx407 24153 29-Nov-1999 1621Z
\r
1190 opdx408 15081 29-Nov-1999 1621Z opdx409 23234 29-Nov-1999 1621Z
\r
1191 Press Enter to continue, A to abort (16 lines) >
\r
1194 You can now read any file in this directory using the type command, like this ....
\r
1197 type bulletin/opdx391
\r
1198 Ohio/Penn DX Bulletin No. 391
\r
1199 The Ohio/Penn Dx PacketCluster
\r
1200 DX Bulletin No. 391
\r
1203 Editor Tedd Mirgliotta, KB8NW
\r
1204 Provided by BARF-80 BBS Cleveland, Ohio
\r
1205 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
\r
1206 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
\r
1207 Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH
\r
1208 & The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
\r
1209 Press Enter to continue, A to abort (508 lines) >
\r
1212 The page length will of course depend on what you have it set to!
\r
1214 <sect1>The Aliases file
\r
1217 You will find a file in /spider/cmd/ called Aliases. This is the file that
\r
1218 controls what a user gets when issuing a command. It is also possible to
\r
1219 create your own aliases for databases and files you create locally.
\r
1222 You should not alter the original file in /spider/cmd/ but create a new file
\r
1223 with the same name in /spider/local_cmd. This means that any new Aliases files
\r
1224 that is downloaded will not overwrite your self created Aliases and also that
\r
1225 you do not override any new Aliases with your copy in /spider/local_cmd/. You
\r
1226 must remember that any files you store in /spider/local/ or /spider/local_cmd
\r
1227 override the originals if the same lines are used in both files.
\r
1230 The best way of dealing with all this then is to only put your own locally
\r
1231 created Aliases in the copy in /spider/local_cmd. The example below is
\r
1232 currently in use at GB7MBC.
\r
1237 # Local Aliases File
\r
1244 '^news$', 'type news', 'type',
\r
1247 '^sh\w*/buck$', 'show/qrz', 'show',
\r
1248 '^sh\w*/hftest$', 'dbshow hftest', 'dbshow',
\r
1249 '^sh\w*/qsl$', 'dbshow qsl', 'dbshow',
\r
1250 '^sh\w*/vhf$', 'dbshow vhf', 'dbshow',
\r
1251 '^sh\w*/vhftest$', 'dbshow vhftest', 'dbshow',
\r
1258 Each alphabetical section should be preceded by the initial letter and the section
\r
1259 should be wrapped in square brackets as you can see. The syntax is straightforward.
\r
1260 The first section on each line is the new command that will be allowed once the
\r
1261 alias is included. The second section is the command it is replacing and the last
\r
1262 section is the actual command that is being used.
\r
1265 The eagle-eyed amongst you will have noticed that in the first section, the new
\r
1266 alias command has a '^' at the start and a '$' at the end. Basically these force
\r
1267 a perfect match on the alias. The '^' says match the beginning exactly and the
\r
1268 '$' says match the end exactly. This prevents unwanted and unintentional matches
\r
1269 with similar commands.
\r
1272 I have 3 different types of alias in this file. At the top is an alias for 'news'.
\r
1273 This is a file I have created in the /spider/packclus/ directory where I can inform
\r
1274 users of new developments or points of interest. In it's initial form a user would
\r
1275 have to use the command <em>type news</em>. The alias allows them to simply type
\r
1276 <em>news</em> to get the info. Second is an alias for the <em>show/qrz</em>
\r
1277 command so that those users used to the original <em>show/buck</em> command in
\r
1278 AK1A will not get an error, and the rest of the lines are for locally created
\r
1279 databases so that a user can type <em>show/hftest</em> instead of having to use
\r
1280 the command <em>dbshow hftest</em> which is not as intuitive.
\r
1283 This file is just an example and you should edit it to your own requirements.
\r
1284 Once created, simply issue the command <em>load/alias</em> at the cluster
\r
1285 prompt as the sysop user and the aliases should be available.
\r
1291 In later versions of Spider a simple console program is provided for the sysop.
\r
1292 This has a type ahead buffer with line editing facilities and colour for spots,
\r
1293 announces etc. To use this program, simply use console.pl instead of client.
\r
1296 To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the
\r
1297 file with your favourite editor.
\r
1299 <sect1>Updating kepler data
\r
1302 Spider has a powerful and flexible show/satellite command. In order for
\r
1303 this to be accurate, the kepler data has to be updated regularly. In
\r
1304 general, this data is available as an email or via cluster mail.
\r
1305 Updating it is simple. First you need to export the mail message as a
\r
1306 file. You do this with the <em>export</em> command from the cluster prompt
\r
1307 as the sysop. For example ...
\r
1310 export 5467 /spider/perl/keps.in
\r
1314 would export message number 5467 as a file called keps.in in the
\r
1315 /spider/perl directory.
\r
1318 Now login to a VT as sysop and cd /spider/perl. There is a command in
\r
1319 the perl directory called <em>convkeps.pl</em>. All we need to do now is
\r
1320 convert the file like so ...
\r
1323 ./convkeps.pl keps.in
\r
1327 Now go back to the cluster and issue the command ...
\r
1334 That is it! the kepler data has been updated.
\r
1336 <sect1>The QRZ callbook
\r
1339 The command <em>sh/qrz</em> will only work once you have followed a few
\r
1340 simple steps. First you need to get a user ID and password from qrz.com.
\r
1341 Simply go to the site and create one. Secondly you need to copy the file
\r
1342 /spider/perl/Internet.pm to /spider/local and alter it to match your user
\r
1343 ID and password. You also at this point need to set $allow=1 to complete
\r
1344 the setup. Many thanks to Fred Lloyd, the proprieter of
\r
1345 <htmlurl url="http://www.qrz.com" name="qrz.com"> for allowing this access.
\r
1347 <sect1>Connecting logging programs
\r
1350 There appear to be very few logging programs out there that support telnet
\r
1351 especially the popular ones like LogEQF, Turbolog etc. This can make it
\r
1352 difficult to connect to your own cluster!
\r
1353 The way to do it is to make the logging program think it has a TNC attached
\r
1354 to a com port on the logging PC and 'push' a linux login out to it.
\r
1355 This is achieved very simply by the use of <em>agetty</em>.
\r
1358 All that is required is to add a line in /etc/inittab to have the client
\r
1359 ready for a connection on the com port of your choice. Remember that in
\r
1360 Linux, the com ports start at ttyS0 for com1, ttyS1 for com2 etc.
\r
1363 c4:2345:respawn:/sbin/agetty -L 9600 ttyS1
\r
1367 Add this after the standard runlevel lines in /etc/inittab. The above
\r
1368 line works on ttyS1 (com2). Now as root, issue the command <em>telinit q</em>
\r
1369 and it should be ready for connection. All that is required is a 3 wire
\r
1370 serial lead (tx, rx and signal ground). Tell you logging program to use
\r
1371 8n1 at 9600 baud and you should see a Linux login prompt. Login as normal
\r
1372 and then telnet from there to the cluster.
\r
1374 <sect>Java Web applet
\r
1377 In the spider tree will be a directory <em>spider-web</em>. This is a
\r
1378 neat little java web applet that can be run from a website. The applet
\r
1379 must run on the same machine as the cluster. The included README file is
\r
1383 I should comment here that the applet is precompiled, that is, ready to go.
\r
1384 It was compiled using JDK1.3.1. If your version is earlier than this then it
\r
1385 may not work. Should that be the case you need to recompile or update your
\r
1386 JDK. To recompile do the following ...
\r
1389 cd /spider/spider-web
\r
1391 /usr/bin/javac spiderclient.java
\r
1395 I have used /usr/bin/javac as an example, your path to javac may be different.
\r
1400 Completely based on a clx web client written in Java by dl6dbh
\r
1401 (ftp://clx.muc.de/pub/clx/clx-java_10130001.tgz)
\r
1403 The webserver has to run on the same machine as your DxSpider software!
\r
1405 It is assumed that you have Java installed. You need JDK1.3.1 at least.
\r
1407 Installation instructions (Performed as root):
\r
1409 Put all the files in the spider-web directory into a newly created directory
\r
1410 under the DocumentRoot of your websever for instance 'client'. In my case
\r
1411 this is: /home/httpd/html/client/ although ymmv. For Suse the correct
\r
1412 path should be /usr/local/httpd/htdocs/client/ for example.
\r
1414 Move spider.cgi to the cgi-bin directory of your webserver, in my case that is
\r
1415 /home/httpd/cgi-bin/ although ymmv. For Suse the correct path should be
\r
1416 /usr/local/httpd/cgi-bin/ for example.
\r
1418 Change the permissions of the files to ensure they are correct, obviously you
\r
1419 will need to use the correct path the the files according to your system:
\r
1421 chmod 755 /home/httpd/html/cgi-bin/spider.cgi
\r
1422 chmod -R 755 /home/httpd/html/client/
\r
1424 By default the spider.cgi script should pick up your hostname (As long as this
\r
1425 is set correctly). If it does not or your hostname differs from the name that
\r
1426 you attach to the public address that you are using, then edit spider.cgi :
\r
1428 # Uncomment and set the hostname manually here if the above fails.
\r
1429 # $HOSTNAME = "gb7mbc.spoo.org" ;
\r
1432 'HOSTNAME' is the hostname of your cluster.
\r
1434 'PORT' is the portnumber that you use to connect to your DxSpider via
\r
1435 telnet (see Listeners.pm)
\r
1437 NOTE: If you can start the console but cannot connect to the cluster from it,
\r
1438 then it is possible that the machine you are on cannot resolve the hostname of
\r
1439 your cluster machine. If this is the case, you need to set your hostname
\r
1440 manually as above.
\r
1442 You also need to set the $NODECALL variable. This prints the name of your
\r
1443 choosing (probably your cluster callsign) on the html page.
\r
1445 You now can connect to Spider-Web via http://yourserver/cgi-bin/spider.cgi
\r
1448 <sect>Web based statistics
\r
1451 From version 1.50, you can use the freeware software MRTG to produce
\r
1452 really nice graphical statistics on your web site. For an example
\r
1453 try <htmlurl url="http://www.gb7mbc.net/mrtg/stats.html" name="http://www.gb7mbc.net/mrtg/stats.html">.
\r
1456 The following should help you get it all working.
\r
1459 First you need to download the latest version of MRTG from <htmlurl url="http://people.ee.ethz.ch/~oetiker/webtools/mrtg/" name="http://people.ee.ethz.ch/~oetiker/webtools/mrtg/">.
\r
1460 You will also need the following files..
\r
1463 libpng-1.0.14.tar.gz
\r
1468 Login to your machine as the root user, put all the downloaded files
\r
1469 in /usr/local/src/ (or wherever you prefer) and untar and compile them.
\r
1470 All the information to compile and install these sources come with them.
\r
1471 After compilation and installation, you will find MRTG in /usr/local/mrtg-2.
\r
1474 Now copy all the files in /usr/local/src/mrtg-2.9.22/images/ to
\r
1475 /spider/html/mrtg/
\r
1478 You now need to make 2 symbolic links like below...
\r
1481 ln -s /usr/local/mrtg-2/bin/mrtg /usr/bin/mrtg
\r
1482 ln -s /usr/local/mrtg-2/lib/mrtg2 /usr/lib/mrtg2
\r
1486 Now login to the cluster with your sysop callsign and run the command
\r
1489 <P>Now you are nearly there! Login as the sysop user and change to the
\r
1490 /spider/html/mrtg/ directory. Now run the command <em>indexmaker</em> as
\r
1494 indexmaker --output stats.html --columns=1 --title "MRTG statistics for GB7DJK" ../../mrtg/mrtg.cfg
\r
1497 Changing the callsign for your own cluster callsign of course!
\r
1500 And finally you need to login as the root user and create one last
\r
1501 symbolic link. Where this points will depend on where your html
\r
1502 documents are kept. For RedHat systems you use...
\r
1505 ln -s /home/sysop/spider/html/mrtg /home/httpd/html/mrtg
\r
1508 and for SuSE systems...
\r
1511 ln -s /home/sysop/spider/html/mrtg /usr/local/httpd/htdocs/mrtg
\r
1514 If you now point your browser to your website as below it should all
\r
1518 http://www.xxx.xxx/mrtg/stats.html
\r
1521 Of course, to get the stats to update, you need to add some information
\r
1522 in the spider crontab file as below...
\r
1525 # Update stats for mrtg on website
\r
1526 00,05,10,15,20,25,30,35,40,45,50,55 * * * * run_cmd('mrtg all')
\r
1529 This will update the site every 5 minutes.
\r
1534 From version 1.49 DXSpider has some additional security features. These
\r
1535 are not by any means meant to be exhaustive, however they do afford some
\r
1536 security against piracy. These two new features can be used independently
\r
1537 of each other or in concert to tighten the security.
\r
1539 <sect1>Registration
\r
1542 The basic principle of registration is simple. If a user is not registered
\r
1543 by the sysop, then they have read-only access to the cluster. The only
\r
1544 thing they can actually send is a talk or a message to the sysop. In
\r
1545 order for them to be able to spot, send announces or talks etc the sysop
\r
1546 must register them with the <em>set/register</em> command, like this ...
\r
1549 set/register g0vgs
\r
1552 The user g0vgs can now fully use the cluster. In order to enable
\r
1553 registration, you can issue the command ...
\r
1556 set/var $main::reqreg = 1
\r
1559 Any users that are not registered will now see the motd_nor file rather
\r
1560 than the motd file as discussed in the Information, files and useful
\r
1564 Entering this line at the prompt will only last for the time the cluster
\r
1565 is running of course and would not be present on a restart. To make the
\r
1566 change permanent, add the above line to /spider/scripts/startup. To
\r
1567 read more on the startup file, see the section on Information, files
\r
1568 and useful programs.
\r
1571 To unregister a user use <em>unset/register</em> and to show the list
\r
1572 of registered users, use the command <em>show/register</em>.
\r
1577 At the moment, passwords only affect users who login to a DXSpider
\r
1578 cluster node via telnet. If a user requires a password, they can
\r
1579 either set it themselves or have the sysop enter it for them by using
\r
1580 the <em>set/password</em> command. Any users who already have passwords,
\r
1581 such as remote sysops, will be asked for their passwords automatically
\r
1582 by the cluster. Using passwords in this way means that the user has a
\r
1583 choice on whether to have a password or not. To force the use of
\r
1584 passwords at login, issue the command ...
\r
1587 set/var $main::passwdreq = 1
\r
1590 at the cluster prompt. This can also be added to the /spider/scripts/startup
\r
1591 file as above to make the change permanent.
\r
1594 Of course, if you do this you will have to assign a password for each of
\r
1595 your users. If you were asking them to register, it is anticipated that
\r
1596 you would ask them to send you a message both to ask to be registered and
\r
1597 to give you the password they wish to use.
\r
1600 Should a user forget their password, it can be reset by the sysop by
\r
1601 first removing the existing password and then setting a new one like so ...
\r
1604 unset/password g0vgs
\r
1605 set/password g0vgs new_password
\r
1610 <sect1>CVS from a Linux platform
\r
1613 CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held
\r
1614 at <htmlurl url="http://www.sourceforge.net" name="Sourceforge">. This means
\r
1615 that it is possible to update your DXSpider installation to the latest
\r
1616 sources by using a few simple commands. A graphical interface to CVS for
\r
1617 Windows is explained in the next section.
\r
1620 Please be aware that if you update your system using CVS, it is possible that
\r
1621 you could be running code that is very beta and not fully tested. There is
\r
1622 a possibility that it could be unstable.
\r
1625 I am of course assuming that you have a machine with both DXSpider and
\r
1626 Internet access running.
\r
1629 BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR
\r
1630 ENTIRE SPIDER TREE!!
\r
1633 Assuming you are connected to the Internet, you need to login to the
\r
1634 CVS repository and then update your Spider source. There are several
\r
1635 steps which are listed below ...
\r
1638 First login as the user <em>sysop</em>. Next you need to connect to the CVS
\r
1639 repository. You do this with the command below ...
\r
1642 cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
\r
1645 You will get a password prompt. Simply hit return here and your machine should
\r
1646 return to a normal linux prompt.
\r
1649 What happens next depends on whether you have an existing installation that
\r
1650 you want to update with the latest and greatest or whether you just want
\r
1651 to see what is there and/or run it on a new machine for testing.
\r
1653 If you are installing Spider from CVS then change directory to /home/sysop
\r
1655 If you are wanting to update Spider then cd to /tmp
\r
1658 The next step will create a brand new 'spider' directory in your current
\r
1662 cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider co spider
\r
1665 This command is all on one line.
\r
1668 Hopefully your screen should show you downloading files. The -z3 simply compresses
\r
1669 the download to improve speed.
\r
1670 When this has finished, you will have exactly the same as if you had untarred a full
\r
1671 tarball PLUS some extra directories and files that CVS needs to do the magic that
\r
1675 Now if you are doing a new installation, that's it. Carry on as if you have
\r
1676 just downloaded and untarred the lastest tarball.
\r
1679 If you want to upgrade your current installation then do this ...
\r
1682 tar cvfz /tmp/s.tgz spider
\r
1684 tar xvfzp /tmp/s.tgz
\r
1687 This is assuming you downloaded to the /tmp directory of course.
\r
1690 NOTE: the 'p' on the end of the 'xvfz' is IMPORTANT! It keeps the permissions
\r
1691 correct. YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????
\r
1693 Remember to recompile the C client (cd /spider/src; make)
\r
1696 At this point the files have been upgraded. You can (usually) restart the cluster
\r
1697 in your own time. However, if you attempt to use any new commands or features
\r
1698 expect it to be fatal! At least your cluster will have been restarted then so it
\r
1699 will be too late to worry about it!
\r
1702 Now the magic part! From now on when you want to update, simply connect to the
\r
1703 Internet and then, as the user <em>sysop</em> ...
\r
1710 and your files will be updated. As above, remember to recompile the "C" client
\r
1711 if it has been updated (CVS will tell you) and restart if any of the perl scripts
\r
1712 have been altered or added, again, CVS will tell you.
\r
1715 You will find any changes documented in the /spider/Changes file.
\r
1717 <sect1>CVS from a Windows platform
\r
1720 After the initial setup, an update to your DXSpider software is no more than a couple
\r
1721 of clicks away. This section is intended to explain and illustrate the use of the
\r
1722 WinCVS application to update your DXSpider software. The current stable version of
\r
1723 WinCVS is Ver. 1.2. You can get this software at:
\r
1725 <htmlurl url="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip" name="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip">
\r
1727 Pick your download mirror and then install WinCVS after the download is complete.
\r
1729 In this next section I have included a series of links to .jpg files to take advantage of the
\r
1730 picture and 1000 words equivalency. The .jpg files are in the C:\spider\html directory. If
\r
1731 someone using a Linux system is reading this section from boredom, the files are in
\r
1732 /home/sysop/spider/html. One aside, a Linux user can also get a copy of gcvs and do your updates
\r
1733 graphically as opposed to from the command line. The following descriptions are almost identical
\r
1734 between WinCvs and gcvs. The following screen shots have duplicate links, depending upon whether
\r
1735 you are viewing this information under the Windows or Linux operating system.
\r
1737 When WinCVS is installed, running, and you are connected to the internet, the initial screen looks like:
\r
1739 <htmlurl url="initial.jpg" name="initial.jpg">
\r
1741 If you want, you can also look at these .jpg files with another viewer that might provide some
\r
1742 better clarity to the image. On the left is the directory tree for your hard disk. Notice that
\r
1743 the spider directory has a gray highlight.
\r
1745 To start configuring WinCVS, click on Admin at the top of the screen and then Preferences. This
\r
1748 <htmlurl url="pref-gen.jpg" name="pref-gen.jpg">
\r
1750 In the top line for CVSROOT, enter:
\r
1752 anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
\r
1757 "passwd" file on the cvs server
\r
1760 for Authentication on the General tab.
\r
1762 Next, move to the right to the Ports tab.
\r
1764 <htmlurl url="pref-ports.jpg" name="pref-ports.jpg">
\r
1766 In here, check the box on the second line down for the "pserver" port. Enter a port number of 2401.
\r
1768 Finally, go to the WinCvs tab all the way to the right.
\r
1770 <htmlurl url="pref-wincvs.jpg" name="pref-wincvs.jpg">
\r
1772 Enter Notepad as the viewer to open files. For the HOME folder, put "C:\spider" and click OK
\r
1773 because the configuration is now complete.
\r
1775 You are now ready to upgrade your copy of DXSpider. Click on the greyed Spider folder
\r
1776 shown in the directory tree on the left of the WinCVS display. Two things should happen. The Spider
\r
1777 folder will be selected and the greyed-out arrow located just below the word Query in the top line will
\r
1778 turn to solid green.
\r
1780 For anyone using gcvs under Linux, the green arrow is located on the extreme left of the display,
\r
1781 under the word File. A gcvs screen looks like:
\r
1783 <htmlurl url="gcvs.jpg" name="gcvs.jpg">
\r
1785 Click on the now green arrow to start the download process. An Update Settings box will be displayed
\r
1786 to which you can simply say OK.
\r
1788 <htmlurl url="update-OK.jpg" name="update-OK.jpg">
\r
1790 For future reference, the Update Settings box is the place where you can enter information to revert
\r
1791 to a prior version of DXSpider. Information on reverting to a Before Date is contained in the WinCVS
\r
1794 After a short period of time, a series of file names will scroll by in the lower pane of the WinCVS
\r
1795 window. Eventually you should see
\r
1797 *****CVS exited normally with code 0*****
\r
1800 appear in the lower pane. You're done. The updated files are in place ready for you to stop and then
\r
1801 restart your DXSpider. After the restart, you're running with the latest version of DXSpider.
\r
1803 <htmlurl url="completed.jpg" name="completed.jpg">
\r
1805 To paraphrase from the CVS section... Now the magic part! From now on when you want to update, simply
\r
1806 connect to the Internet and start WinCVS.
\r
1808 Click on the greyed-out Spider directory in the left screen
\r
1809 Click on the green down arrow
\r
1810 Click OK on the Update Settings dialog box
\r
1811 Restart your Spider software
\r
1814 <sect>The DXSpider command set
\r
projects / spider.git / blob