=========================
 Installing Forwards 3.0
=========================

:Last update:   $Date: 2008/10/09 17:36:36 $
:Revision:      $Revision: 1.16.2.3 $
:Contact:       sork@lists.horde.org

.. contents:: Contents
.. section-numbering::

This document contains instructions for installing the Forwards Email
Forwarding Manager.

For information on the capabilities and features of Forwards, see the file
README_ in the top-level directory of the Forwards distribution.


Obtaining Forwards
==================

Forwards can be obtained from the Horde website and FTP server, at

   http://www.horde.org/forwards/

   ftp://ftp.horde.org/pub/forwards/

Or use the mirror closest to you:

   http://www.horde.org/mirrors.php

Bleeding-edge development versions of Forwards are available via CVS; see the
file `horde/docs/HACKING`_ in the Horde distribution, or the website
http://www.horde.org/source/, for information on accessing the Horde CVS
repository.


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

To function properly, Forwards **requires** the following:

1. A working Horde installation.

   Forwards runs within the `Horde Application Framework`_, a set of common
   tools for Web applications written in PHP.  You must install Horde before
   installing Forwards.

   .. Important:: Forwards 3.0 requires version 3.0+ of the Horde Framework -
                  earlier versions of Horde will **not** work.

   .. _`Horde Application Framework`: http://www.horde.org/horde/

   The Horde Framework can be obtained from the Horde website and FTP server,
   at

      http://www.horde.org/horde/

      ftp://ftp.horde.org/pub/horde/

   Many of Forwards's prerequisites are also Horde prerequisites.

   .. Important:: Be sure to have completed all of the steps in the
                  `horde/docs/INSTALL`_ file for the Horde Framework before
                  installing Forwards.

2. The following PHP capabilities:

   a. FTP support ``--enable-ftp`` [OPTIONAL]

      FTP support is necessary if you want to use one of the FTP drivers.

   b. LDAP support ``--with-ldap`` [OPTIONAL]

      LDAP support is necessary if you want to use the LDAP driver.

3. The following PEAR modules:
   (See `horde/docs/INSTALL`_ for instructions on installing PEAR modules)

   a. SOAP [OPTIONAL]
  
      Forwards uses the SOAP package in the SOAP driver.

4. An FTP server installed, running, and working if you want to use one of the
   FTP drivers.

5. A mail program that respects .forward files or whatever Forwards driver you
   have choosen.


Installing Forwards
===================

Forwards 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, Forwards is installed directly underneath Horde in
the web server's document tree.

Since Forwards 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 web server's default document root of
``/usr/local/apache/htdocs``, you would type::

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

and would then find Forwards at the URL::

   http://your-server/horde/forwards/


Configuring Forwards
====================

1. Configuring Horde for Forwards

   a. Register the application

      In ``horde/config/registry.php``, find the ``applications['forwards']``
      stanza.  The default settings here should be okay, but you can change
      them if desired.  If you have changed the location of Forwards relative
      to Horde, either in the URL, in the filesystem or both, you must update
      the ``fileroot`` and ``webroot`` settings to their correct values.

2. Configuring Forwards

   You must login to Horde as a Horde Administrator to finish the
   configuration of Forwards.  Use the Horde ``Administration`` menu item to
   get to the administration page, and then click on the ``Configuration``
   icon to get the configuration page.  Select ``Forwards`` from the selection
   list of applications.  Fill in or change any configuration values as
   needed.  When done click on ``Generate Forwards Configuration`` to generate
   the ``conf.php`` file.  If your web server doesn't have write permissions
   to the Forwards configuration directory or file, it will not be able to
   write the file.  In this case, go back to ``Configuration`` and choose one
   of the other methods to create the configuration file
   ``forwards/config/conf.php``.

   Note for international users: Forwards uses GNU gettext to provide local
   translations of text displayed by applications; the translations are found
   in the ``po/`` directory.  If a translation is not yet available for your
   locale (and you wish to create one), see the ``horde/po/README`` file, or
   if you're having trouble using a provided translation, please see the
   `horde/docs/TRANSLATIONS`_ file for instructions.


Known Problems
==============

FTP/Dot-forward Driver
----------------------

Realize that this driver works by setting up a ``.forward`` file in the user's
account.  It does this (at the moment) in a exclusive fashion.  If a
``.forward`` already exists, it must be removed first, it does not
append/prepend to the existing file.  This means you cannot set both a
forward and a vacation message at the same time.  This is rarely an issue, as
you rarely want to both forward your mail and have a vacation notice on the
forwarding (rather than receiving) end.

If in doubt, please run the ``horde/test.php`` file and make sure FTP is
enabled in php.

Courier
-------

We were told this module will work okay with courier if you add the line::

   || dotforward

to the user's .courier file.  Otherwise courier won't use the .forward file.
So, an example .courier file might contain::

   || dotforward
   ./Maildir

Someday we may add code to the module to check for, and if missing insert this
code in the .courier file, but then again maybe we won't.  Until then, either
add this line to all their files, or find another way of enabling this
functionality (anyone know how to set courier's ``DEFAULTDELIVERY`` to do
this?).  Tjeerd van der Zee wrote "or set this as default delivery in
``etc/courierd``" so this may work to make it a global change?

Qmail
-----

The driver tries to set the mode (permissions) on the file, but this may or
may not work.  This may be significant, if your FTP server sets strange
permissions and we can't change them, as Qmail will not work right with the
wrong permissions.

You should also be able to use the ``forwards`` driver if you install a
dot-forward patch to Qmail.  But the ``qmail`` driver should work without any
patches or packages being added to Qmail.


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

If you encounter problems with Forwards, help is available!

The Horde Frequently Asked Questions List (FAQ), available on the Web at

  http://www.horde.org/faq/

The Horde Project runs a number of mailing lists, for individual applications
and for issues relating to the project as a whole.  Information, archives, and
subscription information can be found at

  http://www.horde.org/mail/

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

Please keep in mind that Forwards is free software written by volunteers.
For information on reasonable support expectations, please read

  http://www.horde.org/support.php

Thanks for using Forwards!

The Forwards team


.. _README: ?f=README.html
.. _`horde/docs/HACKING`: ../../horde/docs/?f=HACKING.html
.. _`horde/docs/INSTALL`: ../../horde/docs/?f=INSTALL.html
.. _`horde/docs/TRANSLATIONS`: ../../horde/docs/?f=TRANSLATIONS.html