=========================
 Installing kolab-filter
=========================

This document contains instructions for installing the Kolab MTA
filters on your server. Usually you won't need to do this manually
since it is part of the OpenPKG based installation of the Kolab
Groupware Server. These instructions are only relevant if you wish to
install the filters on a non-OpenPKG platform.


Obtaining kolab-filter
======================

Currently no source packages of kolab-filter are being
distributed. You will have to use CVS to check out the source code and
build a package by running

 make dist


Prerequisites
=============

To function properly, kolab-filter requires the following:

1. PHP:

   You need a PHP variant that has been patched for Kolab. It needs to
   support IMAP annotations. You are advised to use PHP 5

2. The following Kolab PEAR packages:

   a. Kolab_Filter


Installing kolab-filter
=======================

kolab-filter is written in PHP and two scripts that should be called
over the command line. You should install the scripts in a suitable
directory on your system. The config.php file needs to be placed
alongside with the two PHP scripts.

Since kolab-filter is written in PHP, there is no compilation
necessary; simply expand the source package and make sure the scripts
end up in a sensible location. You will need to replace the "@PHP@"
entry at the top of the scripts with the path to your PHP executable.


Configuring kolab-filter
==========================

You can modify the config.php within the kolab-filter base directory
to suit you needs but on a standard Kolab Server installation you will
usually have a configuration template somewhere in your
kolab/templates directory that will get rewritten to the location of
the config.php file.

Make sure the values within that template match your platform.


Obtaining Support
=================

If you encounter problems with kolab-filter, help is available!

1. Wiki

   A lot of typical question have been collected in the Kolab wiki at

     http://wiki.kolab.org

   You'll find both a FAQ and a troubleshooting section there.

2. Mailing lists

   The Kolab project also runs a number of mailing lists where you ask
   all the question left unanswered by the wiki.  Information,
   archives, and subscription information can be found at
  
     http://www.kolab.org

3. IRC

   Kolab developers, contributors and users may also be found on IRC,
   on the channel #kolab on the Freenode Network (irc.freenode.net).

4. Commercial support

   Commercial support is available at 

     http://www.kolab-konsortium.com
