<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Mail::Toaster::Setup</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:_mdnsresponder@jackson.apple.com" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a></li>
<li><a href="#DEPENDENCIES">DEPENDENCIES</a></li>
<li><a href="#AUTHOR">AUTHOR</a></li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Mail::Toaster::Setup - methods to configure and build all the components of a modern email server.</p>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>The meat and potatoes of toaster_setup.pl. This is where the majority of the work gets done. Big chunks of the code and logic for getting all the various applications and scripts installed and configured resides in here.</p>
<h1 id="METHODS">METHODS</h1>
<p>All documented methods in this package (shown below) accept two optional arguments, verbose and fatal. Setting verbose to zero will supress nearly all informational and debugging output. If you want more output, simply pass along verbose=>1 and status messages will print out. Fatal allows you to override the default behaviour of these methods, which is to die upon error. Each sub returns 0 if the action failed and 1 for success.</p>
<pre><code> arguments required:
varies (most require conf)
arguments optional:
verbose - print status messages
fatal - die on errors (default)
result:
0 - failure
1 - success
Examples:
1. $setup->apache( verbose=>0, fatal=>0 );
Try to build apache, do not print status messages and do not die on error(s).
2. $setup->apache( verbose=>1 );
Try to build apache, print status messages, die on error(s).
3. if ( $setup->apache( ) { print "yay!\n" };
Test to see if apache installed correctly.</code></pre>
<dl>
<dt id="new">new</dt>
<dd>
<p>To use any methods in Mail::Toaster::Setup, you must create a setup object:</p>
<pre><code> use Mail::Toaster::Setup;
my $setup = Mail::Toaster::Setup->new;</code></pre>
<p>From there you can run any of the following methods via $setup->method as documented below.</p>
<p>Many of the methods require $conf, which is a hashref containing the contents of toaster-watcher.conf.</p>
</dd>
<dt id="clamav">clamav</dt>
<dd>
<p>Install ClamAV, configure the startup and config files, download the latest virus definitions, and start up the daemons.</p>
</dd>
<dt id="config---personalize-your-toaster-watcher.conf-settings">config - personalize your toaster-watcher.conf settings</dt>
<dd>
<p>There are a subset of the settings in toaster-watcher.conf which must be personalized for your server. Things like the hostname, where you store your configuration files, html documents, passwords, etc. This function checks to make sure these settings have been changed and prompts for any necessary changes.</p>
<pre><code> required arguments:
conf</code></pre>
</dd>
<dt id="config_tweaks">config_tweaks</dt>
<dd>
<p>Makes changes to the config file, dynamically based on detected circumstances such as a jailed hostname, or OS platform. Platforms like FreeBSD, Darwin, and Debian have package management capabilities. Rather than installing software via sources, we prefer to try using the package manager first. The toaster-watcher.conf file typically includes the latest stable version of each application to install. This subroutine will replace those version numbers with with 'port', 'package', or other platform specific tweaks.</p>
</dd>
<dt id="daemontools">daemontools</dt>
<dd>
<p>Fetches sources from DJB's web site and installs daemontools, per his instructions.</p>
</dd>
<dt id="dependencies">dependencies</dt>
<dd>
<pre><code> $setup->dependencies( );</code></pre>
<p>Installs a bunch of dependency programs that are needed by other programs we will install later during the build of a Mail::Toaster. You can install these yourself if you would like, this does not do anything special beyond installing them:</p>
<p>ispell, gdbm, setquota, expect, maildrop, autorespond, qmail, qmailanalog, daemontools, openldap-client, Crypt::OpenSSL-RSA, DBI, DBD::mysql.</p>
<p>required arguments: conf</p>
<p>result: 1 - success 0 - failure</p>
</dd>
<dt id="djbdns">djbdns</dt>
<dd>
<p>Fetches djbdns, compiles and installs it.</p>
<pre><code> $setup->djbdns( );
required arguments:
conf
result:
1 - success
0 - failure</code></pre>
</dd>
<dt id="expect">expect</dt>
<dd>
<p>Expect is a component used by courier-imap and sqwebmail to enable password changing via those tools. Since those do not really work with a Mail::Toaster, we could live just fine without it, but since a number of FreeBSD ports want it installed, we install it without all the extra X11 dependencies.</p>
</dd>
<dt id="ezmlm">ezmlm</dt>
<dd>
<p>Installs Ezmlm-idx. This also tweaks the port Makefile so that it will build against MySQL 4.0 libraries if you don't have MySQL 3 installed. It also copies the sample config files into place so that you have some default settings.</p>
<pre><code> $setup->ezmlm( );
required arguments:
conf
result:
1 - success
0 - failure</code></pre>
</dd>
<dt id="filtering">filtering</dt>
<dd>
<p>Installs SpamAssassin, ClamAV, simscan, QmailScanner, maildrop, procmail, and programs that support the aforementioned ones. See toaster-watcher.conf for options that allow you to customize which programs are installed and any options available.</p>
<pre><code> $setup->filtering();</code></pre>
</dd>
<dt id="maillogs">maillogs</dt>
<dd>
<p>Installs the maillogs script, creates the logging directories (toaster_log_dir/), creates the qmail supervise dirs, installs maillogs as a log post-processor and then builds the corresponding service/log/run file to use with each post-processor.</p>
<pre><code> $setup->maillogs();</code></pre>
</dd>
<dt id="startup_script">startup_script</dt>
<dd>
<p>Sets up the supervised mail services for Mail::Toaster</p>
<pre><code> $setup->startup_script( );</code></pre>
<p>If they don't already exist, this sub will create:</p>
<pre><code> daemontools service directory (default /var/service)
symlink to the services script</code></pre>
<p>The services script allows you to run "services stop" or "services start" on your system to control the supervised daemons (qmail-smtpd, qmail-pop3, qmail-send, qmail-submit). It affects the following files:</p>
<pre><code> $prefix/etc/rc.d/[svscan|services].sh
$prefix/sbin/services</code></pre>
</dd>
<dt id="test">test</dt>
<dd>
<p>Run a variety of tests to verify that your Mail::Toaster installation is working correctly.</p>
</dd>
</dl>
<h1 id="DEPENDENCIES">DEPENDENCIES</h1>
<pre><code> IO::Socket::SSL</code></pre>
<h1 id="AUTHOR">AUTHOR</h1>
<p>Matt Simerson - matt@tnpi.net</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p>The following are all perldoc pages:</p>
<pre><code> Mail::Toaster
Mail::Toaster::Conf
toaster.conf
toaster-watcher.conf
http://mail-toaster.org/</code></pre>
</body>
</html>