Mail::Toaster::Apache

- NAME
- SYNOPSIS
- VERSION
- DESCRIPTION
- METHODS

- DEPENDENCIES

- AUTHOR
- BUGS
- TODO
- SEE ALSO
- COPYRIGHT AND LICENSE

# NAME

Mail::Toaster::Apache - modules for installing, configuring and managing Apache

# SYNOPSIS

Modules for working with Apache. Some are specific to Mail Toaster while most are generic, such as provisioning vhosts for an Apache 2 server. Using just these subs, Apache will be installed, SSL certs generated, and serving.

# VERSION

5.06

# DESCRIPTION

Perl methods for working with Apache. See METHODS.

# METHODS

new

         use Mail::Toaster::Apache
         my $apache = Mail::Toaster::Apache->new();

  use this function to create a new apache object. From there you can use all the functions included in this document.

  Each method expect to recieve one or two hashrefs. The first hashref must have a value set for <i>vhost</i> and optional values set for the following: ip, serveralias serveradmin, documentroot, redirect, ssl, sslcert, sslkey, cgi, customlog, customerror.

  The second hashref is key/value pairs from sysadmin.conf. See that file for details of what options you can set there to influence the behavior of these methods..

InstallApache1

              use Mail::Toaster::Apache;
              my $apache = new Mail::Toaster::Apache;

              $apache->install_apache1(src=>"/usr/local/src")

  Builds Apache from sources with DSO for all but mod_perl which must be compiled statically in order to work at all.

  Will build Apache in the directory as shown. After compile, the script will show you a few options for testing and completing the installation.

  Also installs mod_php4 and mod_ssl.

install_apache2

              use Mail::Toaster::Apache;
              my $apache = new Mail::Toaster::Apache;

              $apache->install_apache2($conf);

  Builds Apache from sources with DSO for all modules. Also installs mod_perl2 and mod_php4.

  Currently tested on FreeBSD and Mac OS X. On FreeBSD, the chosen version of php is installed. It installs both the PHP cli and mod_php Apache module. This is done because the SpamAssassin + SQL module requires pear-DB and the pear-DB port thinks it needs the lang/php port installed. There are other ports which also have this requirement so it's best to just have it installed.

  This script also builds default SSL certificates, based on your preferences in openssl.cnf (usually in /etc/ssl) and makes a few tweaks to your httpd.conf (for using PHP & perl scripts).

  Values in $conf are set in toaster-watcher.conf. Please refer to that file to see how you can influence your Apache build.

apache_conf_patch

              use Mail::Toaster::Apache;
              my $apache = Mail::Toaster::Apache->new();

              $apache->apache_conf_patch(conf=>$conf);

  Patch apache's default httpd.conf file. See the patch in contrib of Mail::Toaster to see what changes are being made.

install_ssl_certs

  Builds and installs SSL certificates in the locations that Apache expects to find them. This allows me to build a SSL enabled web server with a minimal amount of human interaction.

install_rsa_cert

  Builds and installs a RSA certificate.

              $apache->install_rsa_cert(crtdir=>$crtdir, keydir=>$keydir);

restart

  Restarts Apache.

  On FreeBSD, we use the rc.d script if it's available because it's smarter than apachectl. Under some instances, sending apache a restart signal will cause it to crash and not restart. The control script sends it a TERM, waits until it has done so, then starts it back up.

          $apache->restart($vals);

vhost_create

  Create an Apache vhost container like this:

        <VirtualHost *:80 >
          ServerName blockads.com
          ServerAlias ads.blockads.com
          DocumentRoot /usr/home/blockads.com/ads
          ServerAdmin admin@blockads.com
          CustomLog "| /usr/local/sbin/cronolog /usr/home/example.com/logs/access.log" combined
          ErrorDocument 404 "blockads.com
        </VirtualHost>

              my $apache->vhost_create($vals, $conf);

              Required values:

               ip  - an ip address
             name  - vhost name (ServerName)
           docroot - Apache DocumentRoot

          Optional values

       serveralias - Apache ServerAlias names (comma seperated)
       serveradmin - Server Admin (email address)
               cgi - CGI directory
         customlog - obvious
       customerror - obvious
            sslkey - SSL certificate key
           sslcert - SSL certificate

  This sub works great. :-)

vhost_enable

  Enable a (previously) disabled virtual host.

          $apache->vhost_enable($vals, $conf);

vhost_disable

  Disable a previously disabled vhost.

          $apache->vhost_disable($vals, $conf);

vhost_delete

  Delete's an Apache vhost.

          $apache->vhost_delete();

vhost_exists

  Tests to see if a vhost definition already exists in your Apache config file(s).

vhost_show

  Shows the contents of a virtualhost block that matches the virtual domain name passed in the $vals hashref.

              $apache->vhost_show($vals, $conf);

vhosts_get_file

  If vhosts are each in their own file, this determines the file name the vhost will live in and returns it. The general methods on my systems works like this:

         example.com would be stored in $apache/vhosts/example.com.conf

  so would any subdomains of example.com.

  thus, a return value for *.example.com will be ``$apache/vhosts/example.com.conf''.

  $apache is looked up from the contents of $conf.

vhosts_get_match

  Find a vhost declaration block in the Apache config file(s).

install_dsa_cert

  Builds and installs a DSA Certificate.

## DEPENDENCIES

Mail::Toaster - http://mail-toaster.org/

# AUTHOR

Matt Simerson <matt@tnpi.net>

# BUGS

None known. Report any to author.

# TODO

# SEE ALSO

The following are all man/perldoc pages:

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

     http://matt.simerson.net/computing/mail/toaster/

# COPYRIGHT AND LICENSE

Copyright (c) 2003-2008, 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.