README
1##### Overview
2
3The postfix-logwatch(1) utility is a Postfix MTA log parser, that pro-
4duces summaries, details, and statistics regarding the operation of
5Postfix.
6
7This utility can be used as a standalone program, or as a Logwatch fil-
8ter module to produce Postfix summary and detailed reports from within
9Logwatch.
10
11A key feature of postfix-logwatch is its ability to produce a very wide
12range of reports with data grouped and sorted as much as possible to
13reduce noise and highlight patterns. Brief summary reports provide a
14quick overview of general Postfix operations and message delivery,
15calling out warnings that may require attention. Detailed reports pro-
16vide easy to scan, hierarchically-arranged and organized information,
17with as much or little detail as desired.
18
19##### Installation: standalone
20
21The included Makefile will install the postfix-logwatch utility
22for you. Run:
23
24 make install-standalone
25
26to install the utility and its configuration file. Installation
27will default to /usr/local/bin and /usr/local/etc/postfix-logwatch, respectively.
28
29##### Installation: logwatch
30
31To use postfix-logwatch as a logwatch script, the files:
32
33 postfix-logwatch
34 postfix-logwatch.conf
35
36will need to be installed into one of logwatch's known directories.
37To avoid overwriting your existing default logwatch filter files,
38the enclosed files can be installed into the global logwatch
39installation directory, which is typically:
40
41 /etc/logwatch
42
43The included Makefile can be used to install the files into
44/etc/logwatch for you. To install the filter into an existing
45logwatch installation, run:
46
47 make install-logwatch
48
49NOTE: the files postfix-logwatch and postfix-logwatch.conf must be
50renamed (by removing the "-logwatch" suffix), for logwatch to
51function correctly. The Makefile takes care of this. The
52Makefile also disables perl's taint mode (-T) when running under
53logwatch. If you install the files manually, be sure to remove
54the -T from the first line of the postfix filter.
55
56For non-standard installations, you will need to determine your
57global logwatch directory, and define "prefix" in the attached
58Makefile.
59
60Alternatively, you can manually copy the files to their proper
61locations:
62
63 cp postfix-logwatch /etc/logwatch/scripts/services/postfix
64 cp postfix-logwatch.conf /etc/logwatch/conf/services/postfix.conf
65 [ remove -T from line 1 of /etc/logwatch/scripts/services/postfix ]
66
67 Optional:
68 cp postfix-logwatch.1 /usr/local/man/man1/postfix-logwatch.1
69
70##### Usage
71
72The postfix-logwatch utility is used standalone as:
73
74 postfix-logwatch /path/to/maillog
75
76For brief help:
77
78 postfix-logwatch --help
79
80To use within logwatch:
81
82 logwatch --service postfix ...
83
84See the postfix-logwatch(1) man page for complete details, and
85see comments in the postfix-logwatch.conf file for additional
86information.
87
88Mike Cappella
89mike (at) cappella (dot) us
90last updated: 01/11/2012
91