diff options
Diffstat (limited to '')
| -rw-r--r-- | contrib/README.mmdsr | 66 |
1 files changed, 38 insertions, 28 deletions
diff --git a/contrib/README.mmdsr b/contrib/README.mmdsr index d7aa2543..5159171e 100644 --- a/contrib/README.mmdsr +++ b/contrib/README.mmdsr @@ -5,31 +5,41 @@ for mailman. It was initially posted at <http://sourceforge.net/tracker/index.php?func=detail&aid=1123383&group_id=103&atid=300103> which see for possible patches and other enhancements. -It is intended that there will be a 'cleaner', more complete readme file in -the future. In the interim, here are Brad's original comments. - -I quickly whacked together a Daily Status Report script for Mailman (using -Bourne shell, not Python ;), and thought that other folks might be interested -in seeing it. - -The basic concept is a program that gets fired off at 23:59 every night, and -goes through a variety of log files looking for entries specific to that date, -and indicating problems or certain types of activity that might be of interest -to someone trying to administer the server. It also does an "ls -la" of -/usr/local/mailman/qfiles/*, so that you can see what is in the queue at the -time of the running of the script. - -My concept was that this daily report would get e-mailed to the admin, or -posted to a "reports" mailing list, where they could be archived and kept for -future reference. - -The script does not (yet) do any statistics calculations, although it should -be relatively easy to hack together some basic stats using awk, sort, etc.... - -Anyway, I thought I'd share it and let folks take a look at it, and if anyone -has any recommended improvements, we can incorporate those and share them back -out with everyone. - -The code is written under a BSD-style license, so if you don't want to -contribute any changes back to me, that's okay. Of course, I would prefer that -you did, but I leave the choice up to you. +Here goes the original mmdsr.readme by Brad ... + +======================================================================== +This is a basic Bourne shell script that I quickly hacked together for +my own purposes, designed to be fired off at 23:59 every night, going +through a variety of Mailman log files looking for entries specific +to that date, summarizing the activities, and indicating problems or +certain types of activity that might be of interest to someone trying +to administer the server. + +It also does an "ls -la" of /usr/local/mailman/qfiles/*, so that you +can see what is in the queue at the time of the execution of the script. + +This daily report will get e-mailed to the admin, or posted to a "reports" +mailing list, where they can be archived and kept for future reference. +If you don't define an address where the output e-mail should be sent, +it will instead be printed to the standard output (thus allowing you to +do something else with it). + + +Once I'd gone through a few revisions of my own on this tool, I +thought that I would release the code to the public and get comments +and suggestions from others in the Mailman community. This program is +currently being used actively on the mail servers for python.org (where +the mailman-users and other Mailman-related mailing lists are hosted), +as well as many others. + +Note that this script needs to be configured once to know where standard +commands are located, where log files are kept, etc... (see the top +500 lines or so of the script), but after that you don't need to feed +it any input, or capture the output to be sent anywhere. This script +takes care of all of that. All you should need to do is to call this +script from a cron job at 23:59 (local time) every night. + + +When looking at this script, perhaps during configuration, please keep +in mind that it is heavily commented at the top, and everything should +hopefully be self-evident. |