Do It Yourself

The following guides outline building Cyrus IMAP from a fresh clone of the GIT repository’s branches, or a tarball of a released version.

Unless you specifically need unreleased patches, the tarball package is recommended as it comes with a number of resources pre-built for you, such as the documentation.



1. Fetch the source

From Tarball

Download the latest stable tarball : version 3.0.1.

Extract the tarball:

$ tar xzvf cyrus-imapd-x.y.z.tar.gz

Continue with 2. Build Dependencies.

From GIT

Read our Guide to GitHub for details on how to access our GitHub repository, and fork/clone the source.

Continue with 2. Build Dependencies.

2. Build Dependencies

Required Build Dependencies

Building a basic Cyrus that can send and receive email: the minimum libraries required to build a functional Cyrus.

Build Dependencies
Package Debian RedHat
autoconf autoconf autoconf
automake automake automake
bison bison bison
Cyrus SASL libsasl2-dev cyrus-sasl-devel
flex flex flex
gcc gcc gcc
gperf gperf gperf
jansson libjansson-dev jansson-devel
libtool libtool libtool
ICU libicu-dev libicu-devel
uuid uuid-dev libuuid-devel
openssl libssl-dev openssl-devel
pkgconfig pkg-config pkgconfig
sqlite libsqlite3-dev sqlite-devel

To install all dependencies from packages on Debian Jessie, use this:

sudo apt-get install git build-essential autoconf automake libtool \
    pkg-config bison flex libssl-dev libjansson-dev libxml2-dev \
    libsqlite3-dev libical-dev libsasl2-dev libpcre3-dev uuid-dev \
    libicu-dev
sudo apt-get -t jessie-backports install libxapian-dev

Optional Build Dependencies

The following build dependencies are optional, and enable functionality, code maintenance tasks or building the documentation.

Developers only

Package Debian RedHat Required for make check? Notes
CUnit libcunit1-dev cunit-devel yes Development headers for compiling Cyrus IMAP’s unit tests.
perl(ExtUtils::MakeMaker) ?? ?? no

Perl library to assist in building extensions to Perl.

Configure option: --with-perl

perl-devel perl-dev perl-devel no

Perl development headers to allow building binary perl libraries. Needs version 5+.

Configure option: --with-perl

valgrind valgrind valgrind no Performance and memory testing.

SASL Authentication

Package Debian RedHat Required for make check? Notes
Cyrus SASL Plain libsasl2-modules cyrus-sasl-plain yes Cyrus SASL package that ships the library required to pass Cyrus IMAP’s PLAIN authentication unit tests.
Cyrus SASL MD5 libsasl2-modules cyrus-sasl-md5 yes Cyrus SASL library required to pass Cyrus IMAP’s DIGEST-MD5 authentication unit tests
sasl binaries sasl2-bin sasl2-bin no Administration tools for managing SASL
Kerberos libsasl2-modules-gssapi-mit krb5-devel no

Development headers required to enable Kerberos v5 authentication capabilities. Otherwise also known as the authentication mechanism GSSAPI.

Configure option: --with-krbimpl=mit

Alternate database formats

Package Debian RedHat Required for make check? Notes
lmdb lmdb-dev lmdb no Lightning Memory-Mapped Database Manager (LMDB) backend for Cyrus IMAP databases. LMDB requires database environments to be set to a (user-configurable) maximum size. The Cyrus backend uses 512MB as default size. Cyrus installations may override this by setting the environment variable CYRUSDB_LMDB_MAXSIZE. The value of this variable must be an integer, optionally followed (without space) by ‘mb’ or ‘gb’ to define the maximum size in bytes, megabytes or gigabytes. The size should be a multiple of the OS page size.
mysql or mariadb libmysqlclient-dev or libmariadb-dev mysql-devel or mariadb-devel no

MariaDB or MySQL development headers, to allow Cyrus IMAP to use it as the backend for its databases.

Configure option: --with-mysql, --with-mysql-incdir, --with-mysql-libdir

postgresql postgresql-dev postgresql-devel no  

CalDAV and/or CardDAV

Package Debian RedHat Required for make check? Notes
libical libical-dev libical-devel no libical >= 0.48 required for scheduling support. Note: Linux distributions Enterprise Linux 6 and Debian Squeeze are known to ship outdated libical packages versions 0.43 and 0.44 respectively. The platforms will not support scheduling.
libxml libxml2-dev libxml2-devel   no

Other

Package Debian RedHat Required for make check? Notes
net-snmp libsnmp-dev net-snmp-devel no version 4.2 or higher
openldap libldap2-dev openldap-devel no

Development headers to enable ptloader to interface with LDAP directly, for canonification of login usernames to mailbox names, and verification of login usernames, ACL subjects and group membership.

Configure option: --with-ldap

tcp_wrappers tcp_wrappers xx no  
transfig transfig xx no  
zlib zlib1g-dev zlib-devel no Compression support for httpd
nghttp2 libnghttp2-dev libnghttp2-devel no HTTP/2 support for httpd

Continue with 3. Configure the Build

3. Configure the Build

Default build: mail only

$ autoreconf -i
$ ./configure [options]

Check the summary after ./configure completes to ensure it matches your expectations.

To view all options, and disable or enable specific features, please see:

# ./configure --help

Tip

Passing environment variables as an argument to configure, rather than setting them in the environment before running configure, allows their values to be logged in config.log. This is useful for diagnosing problems.

Optional dependencies

Some features are disabled by default and must be explicitly enable-idled via configure.

Sieve is enabled by default.

CalDAV and CardDAV

./configure --enable-http --enable-calalarmd

Murder

`./configure --enable-murder

Replication

`./configure --enable-replication

4. Compile and install

cd /path/to/cyrus-imapd

autoreconf -i
./configure [options]

make

make check

make install  # optional if you're just developing on this machine

If this is the first time you’ve installed Cyrus, read our Basic Server Configuration guide. It walks through the steps of configuring the server and sending a sample piece of test mail.