summaryrefslogtreecommitdiffabout
path: root/man/dudki.conf.5.in
blob: 7186eebc221af9cc033a41196a2131a1ca029aa0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
.TH dudki.conf 5 "November 8th, 2006" "dudki.conf(5)" "Klever Group (http://www.klever.net/)"
.hla en

.SH NAME

dudki.conf \- The configuration file for the dudki process
monitoring daemon

.SH SYNOPSIS

The dudki.conf file is a runtime configuration file for the dudki
process monitoring daemon. It contains the information about the process
being monitored and the instruction on how to cope with the processes.

.SH FILE FORMAT

The file consist of the global configuration and per-process
configuration sections. The global configuration controls general
dudki behaviour and sets defaults for per-process configuration
directives.

.SH GLOBAL CONFIGURATION

.TP
\fBCheckInterval\fR \fIseconds\fR
Specifies interval in seconds at wich dudki performs checks.
.TP
\fBDaemonize\fR \fIon/off\fR
Specifies whether dudki daemon should fork itself into background.
Normally, you don't want it to run in foreground. Unless you want to run
it from \fIinit(8)\fR process (I've nevetr tried it) via
\fIinittab(5)\fR.
.TP
\fBPidFile\fR \fIfilename\fR
Specifies where to store dudki's process id (default is
/var/run/dudki.pid)
.TP
\fBMailtoHeader\fR \fIheader\fR \fIcontent\fR
Sets global defaults for process section's MailtoHeader directive. See
below.
.TP
\fBNotify\fR \fIschema\fR:\fItarget\fR
Sets global default for per process notification. See below.

.TP
\fB<Process\fR \fIidentifier\fR\fB>\fR
Starts per process configuration section. The process will be referenced
using the short descriptive name specified (for example in email
notifications).

.SH PER-PROCESS CONFIGURATION

Per-process configuration sections specifies the processes to monitor.
And parameters pertaining to the process.

.TP
\fBPidFile\fR \fIfilename\fR
Specifies the file where to fetch process id of the process being
monitored from. The absence of file, as well as the absence of process
specified by the pid stored in the file signifies the process death and
triggers restart.
.TP
\fBProcessName\fR \fIprocess name\fR
Specifies the name of the process. The alternative way to find process if it
doesn't keep pid in the file. Similar to \fBpidof\fR(1).
.TP
\fBRestartCommand\fR \fIcommand\fR
Specifies the command to run in order to restart the process.
.TP
\fBUser\fR \fIuser\fR
Specifies the unix user to change to before executing the command
specified by \fBRestartCommand\fR.
.TP
\fBGroup\fR \fIgroup\fR
Specifies the unix group to change to before executing the command
specified by \fBRestartCommand\fR.
.TP
\fBChroot\fR \fIpath\fR
Specifies the directory to set filesystem root to before executing the
command specified by by \fBRestartCommand\fR.
.TP
\fBMailtoHeader\fR \fIheader\fR \fIcontent\fR
Specifies extra headers to add to mailto: notifications sent by the
dudki daemon. Headers specified in per-process section override the
ones specified globally.A
.TP
\fBNotify\fR \fIschema\fR:\fItarget\fR
Specifies the contact to be notified whenever something notable happens
to the process. The only schema currently supported is 'mailto:'.
.TP
\fB</Process>\fR
Signifies the end of process section.

.SH EXAMPLE

.br
CheckInterval 60
.br
PidFile /var/run/dudki.pid
.br
Daemonize on
.br
MailtoHeader From "Dudki <root@klever.net>"
.br
MailtoHeader Reply-To devnull@klever.net
.br
Notify mailto:hacker@klever.net
.br 

.br
<Process apache>
.br
 PidFile /var/run/httpd.pid
.br
 RestartCommand "exec /usr/sbin/apachectl start"
.br
</Process>
.br
<Process named>
.br
 PidFile /var/run/named.pid
.br
 RestartCommand "exec /usr/sbin/named"
.br
</Process>

.SH AUTHOR

Written by Michael 'hacker' Krelin <hacker@klever.net>

.SH COPYRIGHT

Copyright (c) 2004-2006 Klever Group (http://www.klever.net/)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

.SH BUGS

You tell me. Send reports to <dudki-bugs@klever.net>

.SH SEE ALSO
\fBdudki\fR(8), \fBinit\fR(8), \fBinittab\fR(5)