%BOOK_ENTITIES; ]> Instructions on Using Cyrus IMAP as the Kolab IMAP Server This part of the Kolab &PRODUCT_VERSION; Installation Manual applies to installing, configuring, managing, upgrading, migrating and tweaking the Cyrus IMAP component of the Kolab Groupware Solution. Make sure you have the Kolab Systems software repositories configured properly on the system, before executing any of the following commands. For more information on configuring the Kolab Systems software repositories, please refer to .

The package name for Cyrus IMAP is kolab-cyrus-imapd. To install Cyrus IMAP on APT-based systems such as Debian and Ubuntu Long-Term Support, execute the following command; # apt-get -y install kolab-cyrus-imapd To install Cyrus IMAP on RPM-based systems such as Fedora, Red Hat, CentOS and Scientific Linux, execute the following command; # yum -y install kolab-cyrus-imapd kolab-cyrus-imapd will be installed on the system, including any software Cyrus IMAP depends on. The service cyrus-imapd will not yet be started, as you require configuration first. TODO: We can't automatically configure the software; we don't know where the configuration should come from and any hit is a lucky hit. We also don't know what the system is intended for. Nor can we figure such out. Maybe develop and contruct in the Kolab Systems packaging a means for Cyrus IMAP to in fact be automatically configured using a slipstream command, so that the next step is to verify, not configure.

The following configuration files are installed on the system: Configure which services Cyrus IMAP is to offer, using &CYRUS_CONFIG;. By default, POP and IMAP services have both been enabled for normal (plaintext) only, as you require a certificate for TLS and SSL configurations. Please refer to for more details if you seek to secure communications. The behaviour of Cyrus IMAP is controlled using &CYRUS_IMAPD_CONFIG;. Please refer to for standard configurations, and for a list of options. &CYRUS_ANNOTATIONS_CONFIG; contains the Kolab annotations for use with the Kolab Groupware Solution. While the location depends on whether you use an APT-based or RPM-based system, the contents of the file describe system-wide configuration and service defaults, such as the location of &CYRUS_CONFIG; should you require such file to be in a different, non-default location. Please refer to for more information on available options. On APT-based Systems, please use &APT_CYRUS_SYS_DEFAULTS; as the system configuration defaults file. On RPM-based Systems, please use &RPM_CYRUS_SYS_DEFAULTS; as the system configuration defaults file. The system configuration defaults normally suffice, and should not have to be altered unless you have very specific requirements. In addition to these configuration files, the following directories are used for Cyrus IMAP by default: Cyrus IMAP stores it's databases and transactional data here, such as Sieve scripts. The primary (default) IMAP partition. Please refer to for TODO: Quick To Go: Small deployments TODO: While the defaults shipped in the Kolab Systems software packages are good to go for most common Cyrus IMAP deployments, ... TODO: Describe TODO TODO: list/table of options The following options are available in the system configuration defaults file (&APT_CYRUS_SYS_DEFAULTS; for APT-based systems and &RPM_CYRUS_SYS_DEFAULTS; for RPM-based systems); The location of the Cyrus master configuration file, &CYRUS_CONFIG; by default. Valid options are existing Cyrus configuration files. The location of the Cyrus IMAP configuration file, controlling aspects such as authentication, storage locations, database types and other general Groupware infrastructure. &CYRUS_IMAPD_CONFIG; by default. Valid options are existing Cyrus IMAP coniguration files. The size of the listen queue. 32 by default. Only integers are valid. TODO: Figure out the maximum length/size of LISTENQUEUE What cyrus-master process. Not set by default. TODO: Figure out useful values for CYRUS_VERBOSE Additional options to pass on to the cyrus-master process. Not set by default. To get a list of valid options, please refer to the cyrus-master(8) man page. TODO

TODO

TODO: on unified, replica, etc.

TODO

TODO

TODO

TODO