[cvs] [Wiki] created: InstallDoc

Fri Jul 7 00:59:40 PDT 2006

guest [195.145.104.81]  Fri, 07 Jul 2006 00:59:40 -0700

Created page: http://wiki.horde.org/InstallDoc

+ Installing DIMP

:Last update:   $Date: 2006/03/12 03:15:04 $
:Revision:      $Revision: 1.2 $
:Contact:       dev at lists.horde.org

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

This document contains instructions for installing the DIMP web-based mail
client on your system.

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

++ Obtaining DIMP

Bleeding-edge development versions of DIMP are available via CVS; see the
website http://www.horde.org/source/, for information on accessing the Horde
CVS repository.

++ Prerequisites

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

1. A working IMP installation.

>   DIMP runs on top of IMP.  Therefore, you will need to set-up IMP before you \
   can install DIMP.  Please see the `imp/docs/INSTALL`_ file in IMP for \
   directions on how to install IMP properly.

>   .. Important:: DIMP currently requires the current HEAD version of IMP to \
                  run.

++ Installing DIMP

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

Since DIMP 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::

<code>
   cd /usr/local/apache/htdocs/horde
   tar zxvf /path/to/dimp-x.y.z.tar.gz
   mv dimp-x.y.z dimp

</code>

and would then find DIMP at the URL::

>   http://your-server/horde/dimp/

++ Configuring DIMP

1. Configuring Horde for DIMP

>   a. Register the application

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

>   b. Enable IMP authentication [OPTIONAL]

>>      See IMP's `imp/docs/INSTALL`_ file for details.

2. Configuring DIMP

>   To configure DIMP, change to the ``dimp/config/`` directory of the installed \
   distribution, and make copies of all of the configuration ``dist`` files \
   without the ``dist`` suffix::

<code>
      cd config/
      for foo in *.dist; do cp $foo `basename $foo .dist`; done

</code>

>   Or on Windows::

<code>
      copy *.dist *.

</code>

>   Documentation on the format and purpose of those files can be found in each \
   file.

>   You must login to Horde as a Horde Administrator to finish the \
   configuration of DIMP.  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 ``Mail`` from the selection list of \
   applications.  Fill in or change any configuration values as needed.  When \
   done click on ``Generate Dynamic Mail Configuration`` to generate the \
   ``conf.php`` file.  If your web server doesn't have write permissions to the \
   DIMP 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 ``dimp/config/conf.php``.

>   Note for international users: DIMP 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. 

3. Securing DIMP

>   Before you can secure DIMP, you need a secure Horde installation.  Please \
   read the file in `horde/docs/SECURITY`_ for Horde security information \
   before proceeding.

>   See IMP's `imp/docs/INSTALL`_ file for further details on how to secure IMP/DIMP.

4. Tuning DIMP (Performance)

>   See `horde/docs/PERFORMANCE`_.

++ Obtaining Support

If you encounter problems with DIMP, 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 also make occasional
appearances on IRC, on the channel #horde on the Freenode Network
(irc.freenode.net).

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

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

Thanks for using DIMP!

The DIMP team

.. _README: ?f=README.html
.. _`imp/docs/INSTALL`: ../../imp/docs/?f=INSTALL.html
.. _`horde/docs/PERFORMANCE`: ../../horde/docs/?f=PERFORMANCE.html
.. _`horde/docs/SECURITY`: ../../horde/docs/?f=SECURITY.html
.. _`horde/docs/TRANSLATIONS`: ../../horde/docs/?f=TRANSLATIONS.html