1 STUMP Configuration Directory
3 This directory contains files that the supporter of the robomoderator
4 for your newsgroup (you) is supposed to edit to reflect the
5 details of your newsgroup. You will have to edit most of the files
6 under this directory to set such parameters as your newsgroup
7 name, maximum number of crossposts, specify email addresses of
8 your human moderators, and so on.
10 Below is a short summary of what files you should edit and what they
11 are for. Refer to comments in individual files for more details on
12 how you should modify them.
14 I suggest editing the files in the order they are listed here. It
17 ==================================================> added-headers
19 Edit this file and put the header lines that you want to see appended
20 to all approved articles. Put there something to the effect that you
21 are not responsible for contents of approved posts, put your
22 submission and complaint addresses, and if possible provide an
23 URL of the Web page with your FAQ and Charter.
25 ==================================================> approval.key.txt
27 To set this file, you MUST have already created your PGP keys
28 needed for moderation. Please refer to the online documentation
29 explaining what keys to create and how to do it. Here's how
30 to extract the key AFTER you have created it:
32 pgp -kxaf csfm-approval-key > $HOME/stump/etc/approval.key.txt
34 ==================================================> rejection-reasons.lst
36 This file should list exactly the same reasons as mentioned
37 in "reject" perl script, BUT in a different format
39 reason::textual explanation of the reason.
41 This file is used by the ModScape subsystem.
43 ==================================================> conforms_charter
45 This shell script allows you to define newsgroup-specific
46 checks for submissions. If conforms_charter returns a non-zero
47 exit code, the submission will be rejected automatically.
48 soc.culture.russian.moderated uses this script to reject
51 ==================================================> crontab
53 This file specifies which programs should be run at regular intervals.
54 You can skip it if you just started setting up STUMP.
56 ==================================================> messages
58 This DIRECTORY contains explanations for various reasons for rejection.
59 Refer to "reject" script for details on rejection reasons, names and
62 ==================================================> modack.approved
64 This shell script is used to send acknowledgments to posters whose messages
65 get approved by the robomoderator. Edit this script so that the
66 text message is specific to your newsgroups.
68 ==================================================> modack.received
70 This shell script is used to send acknowledgments to posters whose
71 messages were received by the robomoderator. Edit this script so that
72 the text message is specific to your newsgroups.
74 ==================================================> modenv
76 This is the main configuration file for your newsgroup. It has extensive
77 instructions. Edit it very carefully and make sure that PATH includes all
80 ==================================================> moderators
82 This file lists all human moderators and member of moderator
83 board for your newsgroup, along with some flags. Please refer to
84 the file itself for more details.
86 Besides initial setup, you will need to edit this file to support
87 moderators going to vacations.
89 ==================================================> mods-message
91 This shell script is responsible for sending messages for your
92 moderator board to the members of said board. You do not really
95 ==================================================> mods.sig
97 Signature for the moderators-only mailing list. It is appended at the
98 bottom of every message that is distributed to human moderators.
99 Edit it and put whatever you want there.
101 ==================================================> posted_log
103 This little shell script created a posted log file
104 in your home directory. Ignore it.
106 ==================================================> procmail
108 This DIRECTORY contains some procmail rc files for archiving
109 messages. You only need to edit them if you have procmail and
110 formail in some non-standard place.
112 ==================================================> procmailrc
114 This file defines rules for processing incoming mail. You will
115 need to edit it extensively if your group relies on different
116 system of aliases than those that I recommend (a bad idea!).