'\" t
.\"     Title: mailping-cron
.\"    Author: Tommi Virtanen <tv@havoc.fi>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 
      2004-04-15
    
.\"    Manual: Mailping
.\"    Source: 
      mailping
     
      0.0.4
    
.\"  Language: English
.\"
.TH "MAILPING\-CRON" "1" "2004\-04\-15" "mailping 0." "Mailping"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
mailping-cron \- run periodic processing to test email service availability and functioning
.SH "SYNOPSIS"
.HP \w'\fBmailping\-cron\fR\ 'u
\fBmailping\-cron\fR
.SH "DESCRIPTION"
.PP
 \fBmailping\-cron\fR processes incoming emails, updates status and sends out probe messages\&.
.PP
The idea is to configure multiple email \(lqcircuits\(rq, send probe messages regularly, and see whether they complete the circuit and how long it took\&.
.SS "Setting up a circuit"
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
Give a name to the circuit, hereafter referred to as
\fBcircuit\fP\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
Arrange for a local email address to be delivered to maildir
\fI/var/lib/mailping/state/\fBcircuit\fP/incoming/\fP\&. See
\fBmailping\-store\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
Create a configuration for the circuit, by creating directory
\fI/etc/mailping/\fBcircuit\fP\fP\&.
.sp
If you need non\-default sender and/or recipient addresses, create files
\fIfrom\fP
and
\fIto\fP
there, containing the sender and recipient addresses suitable for the circuit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  4." 4.2
.\}
You\*(Aqre done! Munin should now see the data\&.
.RE
.SS "Testing multiple servers"
.PP
To test functioning of more than one email server, arrange an email alias at a remote site pointing to an address on your server, and set the address of that alias here\&.
.PP
Here\*(Aqs an example of testing a system consisting of two email servers and everything in that path (smarthosts, primary MXs, virus checkers, etc\&.):
.PP
Local address <mailping+that@this\&.example\&.com> is delivered with \fBmailping\-store\fR to \fI/var/lib/mailping/state/that/incoming/\fP\&.
.PP
Remote address <echo@that\&.example\&.com> is an alias that redirects all email to <mailping+that@this\&.example\&.com>\&.
.PP
 \fI/etc/mailping/that/to\fP is set to <echo@that\&.example\&.com>\&.
.SH "FILES"
.PP
\fI/etc/mailping/\fBcircuit\fP/from\fP
.RS 4
Sender address for the probe emails\&. Default:
<\fBcurrentuserid\fP@\fBfullyqualifiedhostname\fP>\&.
.RE
.PP
\fI/etc/mailping/\fBcircuit\fP/to\fP
.RS 4
Recipient address for the probe emails\&. You must arrange for the email to eventually get delivered to the maildir
\fI/var/lib/mailping/state/\fBcircuit\fP/incoming/\fP\&.
\fBmailping\-store\fR
will probably be useful in that\&. Default:
<\fBcurrentuserid\fP+\fBcircuit\fP@\fBfullyqualifiedhostname\fP>
.RE
.PP
\fI/etc/mailping/\fBcircuit\fP/admin\fP
.RS 4
Admistrative address, set as
\fIReply\-To\fP
in probe messages\&. Default: do not add
\fIReply\-To\fP\&.
.RE
.PP
\fI/etc/mailping/\fBcircuit\fP/interval\fP
.RS 4
How often a probe message is sent, in seconds\&. Default: 600 seconds\&.
.RE
.PP
\fI/var/lib/mailping/state/\fBcircuit\fP/\fP
.RS 4
Stored state for the probing\&.
.RE
.PP
\fI/var/lib/mailping/state/\fBcircuit\fP/junk/\fP
.RS 4
Maildir used to store all messages in
\fIincoming\fP
that do not look like probe messages\&. Read and delete them regularly\&.
.RE
.PP
\fI/var/lib/mailping/state/\fBcircuit\fP/broken/\fP
.RS 4
Maildir used to store all messages in
\fIincoming\fP
that do look like probe messages, but a corresponding
\fIpending\fP
entry cannot be found\&. Duplicated probe messages cause these\&. Read and delete them regularly\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBMAILPING_CONFIGDIR\fP
.RS 4
Override the location of the configuration directory\&. Default:
\fI/etc/mailping\fP
.RE
.PP
\fBMAILPING_STATEDIR\fP
.RS 4
Override the location of the state directory\&. Circuit states are stored in the
\fIstate\fP
subdirectory of this directory, in subdirectories named after the circuit name\&. Default:
\fI/var/lib/mailping\fP
.RE
.SH "SEE ALSO"
.PP
 mailping\-store(1), mailping\-success(1), mailping\-latency(1) 
.SH "AUTHOR"
.PP
\fBTommi Virtanen\fR <\&tv@havoc\&.fi\&>
.br
Havoc Consulting
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2004 Havoc Consulting
.br