+-------------------------------------------------------------+
|                                                             |
| php-cyradm Installation Guide                               |
|                                                             |
| Copyright 1999 Gernot Stocker <muecketb@sbox.tu-graz.ac.at> |
|                                                             |
| This code is licensed under the GNU Public License.         |
| See the file COPYING in this directory.                     |
|                                                             |
| Last Updated: 07/07/99                                      |
|                                                             |
+-------------------------------------------------------------+

---------------------------------- 
Requirements for php-cyradm 
==================================


 * PHP 3.0.11 or greater with IMAP support

 * A web server supported by PHP (Apache is most widely used)

 * An IMAP server to connect to.

 * An Authentication-System of the web-server for the admin-users with the
   same password of the mailserver-Admin.

----------------------
Optional Requirements:
======================


 * An SSL Web-server so the admin connection is secure (HIGHLY RECOMMENDED)
   Otherwise the ADMIN-Password passes the NET in plane-text.



--------------
Basic Features
==============


Languages Supported:

    English

Options Supported:

      Administration of all mailboxes existing on the imap-system(create, rename, delete, recursive delete, recursive rename)
      Administration of the ACL for each folder on the imap-system(add, delete, change ACL)
      Configuration of the cyrus-imap-server(editing /etc/imapd.conf)

------------
Introduction
============

        1. What does this package do?

	   This scripts allows the hole administration of the IMAP-Mailboxes over a webinterface.

	   
	2. Who needs it?
	
	   The package was developed for administrators of imap-mailsystems(tested with Cyrus). The 
	   hole administrative work should be doable with this package 

	   
	3. How does it work?
	   
	   Commands are sent by this scripts to the mailserver and the scripts evaluate the responses 
	   of the mailserver.


	4. Configuration

	   All scripts are pretty well configurable:
	   
	    A single configfile "config/config.php3" has to be changed.
	    PLEASE EDIT IT BEFOR USING!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

        5. WARNING
	   
	   Please press on the OK Image only if you know what you are doing!!!!!!!!!!


--------------
How to install
==============

	[ Please read the "Introduction" section first, to understand how the system works and to
	  prevent unwanted effects ]

	1. Unpack the package to a folder in the document-root of your webserver.
	   e.g. /usr/local/apache/htdocs/settings/
  
	2. Edit the config file ./config/config.php3 and create the necessary
	   directories with rights for the user under which the webserver runs.

	3. Configure your Apache-System and add there your ADMIN-USERS with the same password 
	   on the mailsystem.
	
	Done!!

	--------------------------------------------------------------------------
	
	NOTE!!
	
             If you have problems, please check all your settings and try 110 times
	     to solve the problems by yourself before sending me an e-mail. ;-)
	     
	===========================================================================

Gernot
<muecketb@sbox.tu-graz.ac.at>

