This document contains instructions for installing the Mottle software
on your system.

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


Obtaining Mottle
~~~~~~~~~~~~~~~~

Mottle is currently available from CVS.  See the file docs/HACKING
in the Horde (not Mottle) distribution for information on accessing
the Horde CVS repository.


PREREQUISITES
~~~~~~~~~~~~~

To function properly, Mottle REQUIRES the following:

  1. A working Horde installation.

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

     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/

     Mottle's prerequisites are also Horde prerequisites.
     Be sure to have completed all of the steps in the INSTALL
     file for the Horde Framework before installing Mottle.


Other things you may need
~~~~~~~~~~~~~~~~~~~~~~~~~

Other things which are recommended, but not required are:

  * An sql or ldap server
  * PHP support to access the above sql or ldap server

Installing Mottle
~~~~~~~~~~~~~~~~~

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

Since Mottle is written in PHP, there is no compilation necessary;
simply install 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.

CONFIGURING Mottle
~~~~~~~~~~~~~~~~~~

1. Configuring Horde for Mottle

   a. Register the application

      You will first need to add a Mottle stanza to your version of the
      horde/config/registry.php file.  Edit this file, and add the
      following stanza where appropriate (after the other entries like it
      or between existing stanzas to position it in the menu where you
      like):

$this->applications['mottle'] = array(
    'fileroot' => dirname(__FILE__) . '/../mottle',
    'webroot' => $this->applications['horde']['webroot'] . '/mottle',
    'name' => _("MOTD"),
    'allow_guests' => false,
    'status' => 'active',
//    'menu_parent' => 'webserver'
);

      If you have changed the location of Mottle relative to Horde,
      either in the URL or in the file system or both, you must
      update the 'fileroot' and/or 'webroot' settings to their correct
      values.  Uncomment the 'menu_parent' part if you want it included
      under the 'webserver' (or modify it or another) grouping.

2. Configuring  Mottle
~~~~~~~~~~~~~~~~~~~~~~

   To configure Mottle, change to the config/ directory of the
   installed distribution, and make copies of all of the configuration
   "dist" files without the "dist" suffix.  An example of how to copy
   the files on a unix based system is:

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

   Documentation on the format and purpose of those files can be found in
   each file.   You may edit these files if you wish to customize Mottle's
   appearance and behavior.  The default values, while reasonable, may not
   be appropriate for your site, so it is best to check them and make any
   desired changes before proceeding.  

   You must then login to Horde as a Horde Administrator to finish the
   configuration of Mottle.  Use the Horde "Administration" menu item to get
   the the Administration page, and then on the click on the "Configuration"
   icon to get the Configuration page.  Select "MOTF" from the selection
   list of applications, and click on the "Configure" button.  Fill in or
   change any configuration values as needed.  When done click on "Generate
   MOTD Configuration" to generate the conf.php file.  If your web server
   doesn't have write permissions to the Mottle configuration directory or
   file, it will not be able to write the file.  In this case, cut and
   paste the returned configuration information into the file
   mottle/config/conf.php.

OBTAINING SUPPORT
-----------------

If you encounter problems with mottle or want to contribute to its
developement, 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 Mottle is free software written by volunteers.
For information on reasonable support expectations, please read

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

The Mottle team

$Horde: mottle/docs/INSTALL,v 1.5 2007-06-19 09:56:37 jan Exp $
