Cyrusmaster README file
	-----------------------

1. Overview 

Cyrusmaster is an LDAP enabled Cyrus IMAP server administering tool 
with a web based frontend. Cyrusmaster uses an LDAP server to store 
data such as user attributes, shared folder properties, access permission 
information and various other metadata used for its function. It is 
developed in the PHP web scripting language by the University
of Athens, Email Development Team and is publicly available under the
General Public License Version 2 (See LICENSE file)

Cyrusmaster is not just another port of cyradm to a web interface. In fact,
it is a full email service architecture which extends some of the features
Cyrus delivers. It was created bearing in mind large email installations with 
hundreds of thousands of users and hence it is ideal for Internet Service 
Providers, University campus setups and large corporate networks. 

For more up-to-date information, please visit http://email.uoa.gr/cyrusmaster

2. Requirements

Cyrusmaster is not a piece of software that may be installed out of the box 
and interact with any Cyrus IMAP server. Cyrusmaster is part of a whole 
architecture, consisting of several projects developed here at the University 
of Athens. 

* First and foremost Cyrusmaster is strongly coupled with a patched version of
Cyrus and not the standard Cyrus version. This patched version of Cyrus provides
Cyrusmaster with a lot of extended features and makes the IMAP server "LDAP friendly".
You should download also the cyrus_patch, which can be found under this directory
and patch your cyrus against it.

* An LDAP server with the LDAP schema released by the University of 
Athens is necessary. Currently only interaction with OpenLDAP whas been tested.

* Sendmail SMTP server, set up using LDAP mailrouting is also needed. For Sendmail
there are no customization patches. The one distributed by sendmail.org is enough. 

* Apache web server with PHP support is used for the user interface. In fact, any
HTTP server with PHP support is fine. However, only an Apache environment has been
tested.

* PHP version 4.3.0 or greater is necessary. PHP must have been built with SSL,
LDAP client, multibyte characters, magic quotes and iconv support.


3. Limitations

Currently Cyrusmaster is in its infancy. This means it has some limitations and 
shortcomings. The most important of them are :

* No support for Cyrus alternate namespace or unix hierarchy separator.

* No support for Cyrus virtual domains.

* No support for MURDER architecture.


4. TODO

* Support for Cyrus 2.2.x virtual domains.

* Support for MURDER architecture. Implement mailbox referrals support.

* Support for Cyrus alternate namespaces and unix hierarchy separator.

* Produce decent documentation


5. Credits

Cyrusmaster is developed at the University of Athens, under the auspices of
the Network Operations Center.

It started as a patch to php-cyradm project (http://freshmeat.net/projects/php-cyradm)
but php-cyradm was inefficient for our needs and thus it undercame a total rewrite.
Nevertheless, small parts of its code may still be found in Cyrusmaster's codebase.

Cyrusmaster developers are

 * Pavlos Drandakis (pdrados at noc.uoa.gr)
 * Christos Soulios (soulbros at noc.uoa.gr)
 * Alexanros Vellis (avel at noc.uoa.gr - homepage: http://www.noc.uoa.gr/~avel)

 Important contributions in its design were made by 
 * Nikos Voutsinas (nvoutsin at noc.uoa.gr)

 Cyrusmaster logo was created by 

 * Nikos Deligaris (ndeligaris at hotmail.com - homepage: http://www.geocities.com/deligaris)

						      
IMPORTANT NOTE: For Cyrusmaster bug reports, feature requests or anything else, 
please do not send emails directly to the developers. 
Instead, send emails to "email at edunet.gr"


6. Links

Cyrusmaster homepage can be reached at
http://email.uoa.gr/cyrusmaster

The whole University of Athens email architecture homepage is at
http://email.uoa.gr

Cyrus IMAP server homepage is
http://asg.web.cmu.edu/cyrus/imapd

All the necessary patches for Cyrus IMAP server can be found at
http://email.uoa.gr/projects/cyrus

Sendmail SMTP server homepage is 
http://www.sendmail.org

OpenLDAP homepage is 
http://www.openldap.org