NAME

toaster_setup.pl

SYNOPSIS

Everything you need to turn a computer into a secure, full-featured, high-performance mail server.

DESCRIPTION

The mail toaster is a collection of open-source software which provides a full-featured mail server running on FreeBSD and MacOS X. The system is built around the qmail mail transport agent, with many additions and modifications. Matt Simerson is the primary author and maintainer of the toaster. There is an active and friendly community of toaster owners which supports the toaster on a mailing list and web forum.

The toaster is built around qmail, a robust mail transfer agent by Daniel J. Bernstein, and vpopmail, a virtual domain manager by Inter7 systems. Matt keeps up with releases of the core software, evaluates them, decides when they are stable, and then integrates them into the toaster. Matt has also added several patches which add functionality to these core programs.

A complete set of instructions for building a mail toaster are on the toaster install page. There is a substantial amount of documenation available for the "Mail::Toaster" toaster. Much of it is also readable via "perldoc Mail::Toaster", and the subsequent pages. Don't forget to read the Install, Configure, and FAQ pages on the web site. If you still have questions, there is a Web Forum and mailing list. Both are browseable and searchable for your convenience.

http://www.tnpi.biz/internet/mail/toaster/

command line flags

toaster_setup.pl can be passed several flags. -s [ section ] - run without a parameter to see the available options -d [ debug ] - enabled (very) verbose debugging output -a [ action ] - default action is "install".

An -a upgrade option is planned.

USAGE

toaster_setup.pl -s [ section ] [-debug]

         pre - installs a list of programs and libraries other toaster components need
        perl - installs or upgrades perl
      config - walks through configuring toaster*.conf files

                   FreeBSD Specific
       ports - updates your ports tree, installs the pkg_* tools
     sources - update your FreeBSD sources (/usr/src)
     jailadd - creates a new jail
   jailstart - starts up an existing jail
  jaildelete - deletes an existing jail

                  Standard Daemons & Utilities
       mysql - installs MySQL
  phpmyadmin - installs phpMyAdmin
      apache - installs Apache 
   apachessl - installs self signed SSL certs for Apache
  apacheconf - patches httpd.conf for use with Mail::Toaster

                   Qmail and related tools
       ucspi - install ucspi-tcp w/MySQL patch
 daemontools - install daemontools
       ezmlm - install EzMLM idx
    vpopmail - installs vpopmail
   vpeconfig - configure ~vpopmail/etc/tcp.smtp
   vpopmysql - run the vpopmail MySQL grant and db create commands
     vqadmin - install vqadmin
       qmail - installs qmail with toaster patches
   qmailconf - configure various qmail control files
    netqmail - installs netqmail 
 netqmailmac - installs netqmail with no patches
      djbdns - install the djbdns program

     courier - installs courier imap & pop3 daemons
 courierconf - post install configure for courier

                 Web Mail and Admin interfaces
  qmailadmin - installs qmailadmin
   sqwebmail - installs sqwebmail (webmail app)
squirrelmail - installs squirrelmail (webmail app)

                   Mail Filtering
      filter - installs SpamAssassin, ClamAV, DCC, razor, and more
       razor - installs the razor2 agents
    maildrop - installs maildrop and mailfilter
      clamav - installs just ClamAV
qmailscanner - installs Qmail-Scanner & qmailscanner stats
     simscan - install simscan
     simconf - configure simscan 
     simtest - run email tests to verify that simscan is working

                Logs, Statistics, and Monitoring
    maillogs - creates the mail logging directories
         qss - installs qmailscanner stats
     socklog - installs socklog
     isoqlog - installs and configured isoqlog
     rrdutil - installs rrdutil
   supervise - creates the directories to be used by svscan

        test - runs a complete test suite against your server
  filtertest - runs the simscan and qmail-scanner email scanner tests
    authtest - authenticates against pop, imap, and smtp servers

     toaster - install Mail::Toaster
  mattbundle - install MATT::Bundle
         mrm - install Mysql::Replication
  logmonster - install Apache::Logmonster
         all - installs everything shown on the toaster INSTALL page

AUTHOR

Matt Simerson <matt@tnpi.biz>

BUGS

None known. Report any to author.

TODO

Add -s dnscache section to install a DNS stub resolver
Check if daemons are running before installs. - mostly done
Turn entire process into a ./install_it_all script  - done

SEE ALSO

The following are all man/perldoc pages:

Mail::Toaster
Mail::Toaster::Apache
Mail::Toaster::CGI 
Mail::Toaster::DNS
Mail::Toaster::Darwin
Mail::Toaster::Ezmlm
Mail::Toaster::FreeBSD
Mail::Toaster::Logs
Mail::Toaster::Mysql
Mail::Toaster::Passwd
Mail::Toaster::Perl
Mail::Toaster::Provision
Mail::Toaster::Qmail
Mail::Toaster::Setup
Mail::Toaster::Utility

Mail::Toaster::Conf
toaster.conf 
toaster-watcher.conf

http://matt.simerson.net/computing/mail/toaster/
http://matt.simerson.net/computing/mail/toaster/docs/
http://matt.simerson.net/computing/mail/toaster/faq.shtml
http://matt.simerson.net/computing/mail/toaster/changelog.shtml

COPYRIGHT

Copyright (c) 2004-2005, The Network People, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the The Network People, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.