~epylog/epylog/main

« back to all changes in this revision

Viewing changes to man/epylog.conf.5

  • Committer: Frode Egeland
  • Date: 2009-03-28 01:37:12 UTC
  • Revision ID: egeland@gmail.com-20090328013712-m3kzz0zjzxhirhxk
Imported from http://archive.ubuntu.com/ubuntu/pool/universe/e/epylog/epylog_1.0.3-6.tar.gz source

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "epylog.conf" "5" "1.0" "Konstantin Ryabitsev" "Applications/System"
 
2
 
 
3
.SH NAME
 
4
\fBepylog.conf\fR \- epylog configuration
 
5
 
 
6
.SH SYNOPSIS
 
7
\fBepylog\fR config file is a simple plaintext file in win.ini style
 
8
format.
 
9
 
 
10
.SH "Location"
 
11
Epylog will look in /etc/epylog/epylog.conf by default, but you can
 
12
override that by passing \-c switch on the command line.
 
13
 
 
14
.SH "[main]"
 
15
.TP
 
16
.B cfgdir
 
17
This is where epylog should look for other configuration information,
 
18
most notably, \fBmodules.d\fR directory. See \fIepylog-modules(5)\fR
 
19
for more info.
 
20
.TP
 
21
.B tmpdir
 
22
Where to create temporary directories and put temporary files. Note
 
23
that log files can grow VERY big and epylog might create several
 
24
copies of them for processing purposes. Make sure there is no danger
 
25
of filling up that partition. A good place on a designated loghost is
 
26
/var/tmp, since that is usually a separate partition dedicated
 
27
entirely for logs.
 
28
.TP
 
29
.B vardir
 
30
Where epylog should save its state data, namely the offsets.xml
 
31
file. The sanest place for this is /var/lib/epylog.
 
32
.TP
 
33
.B multimatch
 
34
By default, if a line is matched against a module, no other modules
 
35
will be tried. This helps speed things up tremendously. However, you
 
36
may have several modules that process the same lines (although this is
 
37
not a very good setup). In that case you may set this to "yes". The
 
38
default value is "no".
 
39
.TP
 
40
.B threads
 
41
How many processing threads to start. 50 is a good default value, but
 
42
you may set it to less or more, depending on your system.
 
43
 
 
44
.SH "[report]"
 
45
.TP
 
46
.B title 
 
47
What should be the title of the report. For mailed reports, this is
 
48
the subject of the message. For the ones published on the web, this is
 
49
the title of the page (as in <title></title>).
 
50
.TP
 
51
.B template
 
52
Which html template should be used for the final report. See the
 
53
source of the default template for the format used.
 
54
.TP
 
55
.B include_unparsed
 
56
Can be either "yes" or "no". If "no" is specified, strings that didn't
 
57
match any of the modules will not be appended to the report. Not very
 
58
wise! A good setting is "yes".
 
59
.TP
 
60
.B publishers
 
61
Lists the publishers to use. The value is the name of the section
 
62
where to look for the publisher configuration. E.g.:
 
63
.br
 
64
.B publishers = nfspub
 
65
.br
 
66
will look for a section called "[nfspub]" for publisher
 
67
initialization. The name of the publisher has nothing to do with the
 
68
method it uses for publishing. The fact that the default are named
 
69
[file] and [mail] is only a matter of convenience. List multiple
 
70
values separated by a comma.
 
71
 
 
72
.SH "Mail Publisher"
 
73
.TP
 
74
.B method
 
75
Method must be set to "mail" for this publisher to be considered a
 
76
mail publisher.
 
77
.TP
 
78
.B smtpserv
 
79
Can be either a hostname of an SMTP server to use, or the location of
 
80
a sendmail binary. If the value starts with a "/" it will be
 
81
considered a path. E.g. valid entries:
 
82
.br
 
83
.B smtpserv = mail.example.com
 
84
.br
 
85
.B smtpserv = /usr/sbin/sendmail -t
 
86
.TP
 
87
.B mailto
 
88
The list of email addresses where to mail the report. Separate
 
89
multiple entries by a comma. If ommitted, "root@localhost" will be
 
90
used.
 
91
.TP
 
92
.B format
 
93
Can be one of the following: \fBhtml\fR, \fBplain\fR, or \fBboth\fR. If
 
94
you use a mail client that doesn't support html mail, then you better
 
95
use "plain" or "both", though you will miss out on visual cueing that
 
96
epylog uses to notify of important events.
 
97
.TP
 
98
.B lynx
 
99
This is only useful if you use format other than "html". Epylog will
 
100
use a lynx-compliant tool to transform HTML into plain text. The
 
101
following browsers are known to work: lynx, elinks, w3m.
 
102
.TP
 
103
.B include_rawlogs
 
104
Whether to include the gzipped raw logs with the message. If set to
 
105
"yes", it will attach the file with all processed logs with the
 
106
message. If you use a file publisher in addition to the mail
 
107
publisher, this may be a tad too paranoid.
 
108
.TP
 
109
.B rawlogs_limit
 
110
If the size of rawlogs.gz is more than this setting (in kilobytes),
 
111
then raw logs will not be attached. Useful if you have a 50Mb log and
 
112
check your mail over a slow uplink.
 
113
 
 
114
.SH "File Publisher"
 
115
.TP
 
116
.B method
 
117
Method must be set to "file" for this config to work as a file
 
118
publisher.
 
119
.TP
 
120
.B path
 
121
Where to place the directories with reports. A sensible location would
 
122
be in /var/www/html/epylog. Note that the reports may contain
 
123
sensitive information, so make sure you place a .htaccess in that
 
124
directory and require a password, or limit by host.
 
125
.TP
 
126
.B dirmask, filemask
 
127
These are the masks to be used for the created directories and
 
128
files. For format values look at strftime documentation here:
 
129
http://www.python.org/doc/current/lib/module-time.html
 
130
.TP
 
131
.B expire_in
 
132
A digit specifying the number of days after which the old directories
 
133
should be removed. Default is 7.
 
134
.TP
 
135
.B notify
 
136
Optionally send notifications to these email addresses when new
 
137
reports become available. Comment out if no notification is
 
138
desired. This is definitely redundant if you also use the mail
 
139
publisher.
 
140
.TP
 
141
.B smtpserv
 
142
Use this smtp server when sending notifications. Can be either a
 
143
hostname or a path to sendmail. Defaults to "/usr/sbin/sendmail -t".
 
144
.TP
 
145
.B pubroot
 
146
When generating a notification message, use this as publication root
 
147
to make a link. E.g.:
 
148
.br
 
149
.B pubroot = http://www.example.com/epylog
 
150
.br
 
151
will make a link: http://www.example.com/epylog/dirname/filename.html
 
152
 
 
153
.SH "COMMENTS"
 
154
Lines starting with "#" will be considered commented out.
 
155
 
 
156
.SH "AUTHORS"
 
157
.LP 
 
158
Konstantin Ryabitsev <icon@linux.duke.edu>
 
159
 
 
160
.SH "SEE ALSO"
 
161
.LP 
 
162
epylog(3), epylog(8), epylog-modules(5)
 
163