===========================
 Installing kolab-freebusy
===========================

This document contains instructions for installing the Kolab free/busy
support 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 free/busy on a non-OpenPKG platform.


Obtaining kolab-freebusy
========================

Currently no source packages of kolab-freebusy 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-freebusy 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 Horde PEAR packages (They should be availabe if you
   installed horde-framework):

   a. Horde_Util

   b. Horde_String

3. The following Kolab PEAR packages:

   a. Kolab_Freebusy


Installing kolab-freebusy
=========================

kolab-freebusy is written in PHP, and must be installed in a
web-accessible directory.  The precise location of this directory will
differ from system to system.  Conventionally, kolab-freebusy is
installed in the /freebusy directory in the webserver's document tree.

Since kolab-freebusy is written in PHP, there is no compilation
necessary; simply expand the distribution where you want it to reside
and rename the root directory of the distribution to whatever you wish
to appear in the URL.  For example, with the Apache webserver's
default document root of ``/usr/local/apache/htdocs``, you would
type::

   cd /usr/local/apache/htdocs/horde
   tar zxvf /path/to/kolab-freebusy-x.y.z.tar.gz

and would then find the free/busy information at the URL

   http://your-server/freebusy/


Configuring kolab-freebusy
==========================

You can modify the config.php within the kolab-freebusy 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-freebusy, 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
