phpQLAdmin - Installation Guide
-------------------------------

$Id: INSTALL,v 1.0 2001/05/21 09:52:15 mb Exp $


Software Requirements:
----------------------

- qmail-ldap (this is not required to get phpQLAdmin working, but why use
  phpQLAdmin w/o qmail-ldap ? :)
- LDAP server with support for "qmailuser" objectclass (tested with OpenLDAP 1.2.11)
- root access to the qmail-ldap DN
- Webserver (tested with Apache 1.3.14)
- PHP 4.0.x (tested with PHP 4.0.4pl) with compiled in LDAP support

Additional Requirements for qmail-ldap/control patch support:
-------------------------------------------------------------

- LDAP server with support for "qmailcontrol" objectclass
- "qmailcontrol" objectclass must contain all attributes which you want
  to administrate trough phpQLAdmin

Optional:
---------

- mhash-library compiled in PHP to support MD5 and SHA password encryption


Install:
--------

1. Untar the distribution (tar -zxf phpQLAdmin-x.x.tar.gz) to a directory
   below webserver's root.

2. Move all files in the include directory to a php include
   directory (look at phpinfo() to see which directory is set
   as include_path). It's better to set the include_path to a
   directory outside webserver's root, but if you don't want this
   you can simply move all *.inc files to the root directory of the
   application (in the php default configuration, a script's current directory
   is always set to include_path)

3. Avoid unauthorized access to phpQLAdmin. If a user has access the
   application, he has FULL access to all mail accounts. phpQLAdmin does
   NOT provide protection itself.

4. If your webserver doesn't support 'index.php' as a directory index
   file, rename it to index.html or whatever your webserver supports.
   The index.php - file does not contain any php code, so it must not
   be interpreted with php engine.

5. Edit config.inc and change the properties needed to access your
   LDAP database (have a look at the configuration section in the
   documentation)

6. Try out :)