Serverside Filter 1.0 README

	ServerSideFilter - Server Side mail filter plugin for SquirrelMail
	By Patrick Swieskowski, Rick Sheaffer, and Jon Stroud.  This plugin is
        meant to be a replacement to the existing procfilter plugin and the
        existing Server Side Filters plugin.

	ServerSideFilter is a SquirrelMail plugin that allows users to 
        configure procmail or maildrop filters for their mail.
        
        ServerSideFilters supports standard shell users and Virtual Domains.

        ServerSideFilter can be configured to store the filter file in a local
        directory or to use FTP to put the file in the users home directory.
        See the configure.php file to select this option.
        FTP support in PHP is required to use this FTP version.

        FTP method must be used for maildrop due to file permission requirements.

        For qmail users, this script can also be configured to create the proper
        dot-qmail files for delivery.


Requirements
        SquirrelMail 1.2.x, 1.4.x (tested on 1.4.1 but should work on 
           other releases.)
        Compatibility plugin
        Maildrop or procmail
        ftp support in php if using ftp backend
        libmcrypt support if mcrypt is used for encryption

INSTALLATION
	1) extract the serversidefilter tarball in the SquirrelMail
        plugins directory

        2) cp config.php.sample config.php
        
        3) edit config.php

        4) reconfigure SquirrelMail to enable the ServerSideFilter plugin.

    apache.conf
        This is taken straight from the vadmin plugin.  If you already have
        vadmin setup and working, you do not need to mess with this at all.

        Edit apache.conf and change two things -- the path to your
        squirrelmail directory if it's not /usr/share/squirrelmail (in which
        case some people at FHS might want to have a word or two with you), 
        and change "LLAMA" to some unique string. This is the encryption
        hash that will be used to encrypt your vadmin data, including
        domain passwords. Make it something good. If you don't change it
        from "LLAMA," you will suffer the consequences when someone logs in
        and runs porn warez from your server.

        Once you have edited the file, you have two options. If you have
        /etc/httpd/conf.d directory (which is true for at least Red Hat
        Linux 8 and above), then just move that file into that dir. I.e.:
        mv apache.conf /etc/httpd/conf.d/vadmin-apache.conf. 
    
        If you don't have /etc/httpd/conf.d directory, then move the file
        into /etc/httpd/conf and add the following line into your global
        apache.conf:
        Include vadmin-apache.conf

        !!!IMPORTANT!!!
        Wherever you have moved the file, run the following commands on it:
        chown root:root vadmin-apache.conf
        chmod 0600 vadmin-apache.conf

        
	ServerSideFilters is released under the terms of the GNU GPL.

Contacts
        the author can be contacted at accounts@bsclimbing.com

	Many thanks to all those users who helped clean up the bugs in this plugin.
