Upgrading to 3.0¶
Note
This guide assumes that you are familiar and comfortable with administration of a Cyrus installation, and system administration in general.
Upgrading: an overview
- 1. Preparation
- 2. Install new 3.0 Cyrus
- 3. Shut down existing Cyrus
- 4. Backup existing data
- 5. Copy config files and update
- 6. Upgrade specific items
- 7. Start new 3.0 Cyrus and verify
- 8. Reconstruct databases and cache
- 9. Do you want any new features?
- 10. Upgrade complete
- Special note for Murder configurations
1. Preparation¶
Things to consider before you begin:
Installation from tarball¶
It takes some time before platform packages are up to date. It is likely you will need to install from our packaged tarball, at least initially. We provide a full list of libraries that Debian requires, but we aren’t able to test all platforms: you may find you need to install additional or different libraries to support v3.0.
How are you planning on upgrading?¶
Ideally, you will do a sandboxed test installation of 3.0 using a snapshot of your existing data before you switch off your existing installation. The rest of the instructions are assuming a sandboxed 3.0 installation.
If you’re familiar with replication, and your current installation is 2.4 or newer, you can set up your existing installation to replicate data to a new 3.0 installation and failover to the new installation when you’re ready. The replication protocol has been kept backwards compatible.
If you are upgrading in place, you will need to shut down Cyrus entirely while you install the new package. If your old installation was using berkeley DB format databases, you will need to convert or upgrade the databases before you upgrade. Cyrus v3.0 does not support berkeley at all.
We strongly recommend that you read this entire document before upgrading.
2. Install new 3.0 Cyrus¶
Download the release 3.0 package tarball.
Fetch the libraries for your platform. The list for Debian is:
sudo apt-get install -y autoconf automake autotools-dev bash-completion bison build-essential comerr-dev \
debhelper flex g++ git gperf groff heimdal-dev libbsd-resource-perl libclone-perl libconfig-inifiles-perl \
libcunit1-dev libdatetime-perl libdb-dev libdigest-sha-perl libencode-imaputf7-perl libfile-chdir-perl \
libglib2.0-dev libical-dev libio-socket-inet6-perl libio-stringy-perl libjansson-dev libldap2-dev \
libmysqlclient-dev libnet-server-perl libnews-nntpclient-perl libpam0g-dev libpcre3-dev libsasl2-dev \
libsnmp-dev libsqlite3-dev libssl-dev libtest-unit-perl libtool libunix-syslog-perl liburi-perl \
libxapian-dev libxml-generator-perl libxml-xpath-perl libxml2-dev libwrap0-dev libzephyr-dev lsb-base \
net-tools perl php5-cli php5-curl pkg-config po-debconf tcl-dev \
transfig uuid-dev vim wamerican wget xutils-dev zlib1g-dev sasl2-bin rsyslog sudo acl telnet
If you’re on another platform and can provide the list of dependencies, please let us know via a GitHub issue or documentation pull request or send mail to the developer list.
Follow the general install instructions.
Note
It’s best to ensure your new Cyrus will not start up automatically if your server restarts in the middle of the upgrade.
How this is best achieved will depend upon your OS and distro, but may involve
something like systemctl disable cyrus-imapd
or update-rc.d cyrus-imapd disable
3. Shut down existing Cyrus¶
Shut down your existing Cyrus installation with its init script or whatever method you normally use.
This is necessary to guarantee a clean data snapshot.
4. Backup existing data¶
We recommend backing up all your data before continuing.
- Sieve scripts
- Config files
- Mail spool
- Cyrus Databases
(You do already have a backup strategy in place, right? Once you’re on 3.0, you can consider using the new inbuilt backup tools.)
5. Copy config files and update¶
Check to see if your imapd.conf file contains any deprecated options:
cyr_info conf-lint -C <path to imapd.conf> -M <path to cyrus.conf>
You need to provide both imapd.conf and cyrus.conf so that conf-lint knows the names of all your services and can check service-specific overrides.
To check your entire system’s configuration you can use conf-all. This command takes all the system defaults, along with anything you have provided overrides for in your config files:
cyr_info conf-all -C <path to imapd.conf> -M <path to cyrus.conf>
Important config options: unixhierarchysep:
and altnamespace:
defaults have changed in imapd.conf(5). Implications are
outlined in the Note in User Namespace Mode and
Switching the Alternative Namespace.
- unixhierarchysep: on
- altnamespace: on
Note
If your installation is using groups, don’t turn reverseacls:
on. Reverseacl support
only works well for sites without groups.
6. Upgrade specific items¶
Special-Use flags
If your 2.4 imapd.conf(5) made use of the
xlist-XX
directive(s), you can convert these to per-user special-use annotations in your new install with the cvt_xlist_specialuse(8) tool
You don’t need to copy the following databases as Cyrus 3.0 will recreate these for you automatically:
- duplicate delivery (deliver.db),
- TLS cache (tls_sessions.db),
- PTS cache (ptscache.db),
- STATUS cache (statuscache.db).
Note
You may wish to consider relocating these four databases to ephemeral
storage, such as /run/cyrus
(Debian/Ubuntu) or /var/run/cyrus
or whatever suitable tmpfs is provided on your distro. It will place
less IO load on your disks and run faster.
Note
Please be warned that some packages place tasks such as tlsprune
(tls_prune(8)) in the START{}
stanza of
cyrus.conf(5). This will cause a startup problem if the
tls_sessions_db
is not present. The solution to this is to
remove the tlsprune
task from START{}
and schedule it in
EVENTS{}
, further down.
Warning
Berkeley db format no longer supported
If you have any databases using Berkeley db, they’ll need to be converted to skiplist or flat in your existing installation. And then optionally converted to whatever final format you’d like in your 3.0 installation.
Databases potentially affected: mailboxes, annotations, conversations, quotas.
On old install, prior to migration:
cvt_cyrusdb /<confdir>mailboxes.db berkeley /tmp/new-mailboxes.db skiplist
If you don’t want to use flat or skiplist for 3.0, you can use the new 3.0 cvt_cyrusdb(8) to swap to new format:
cvt_cyrusdb /tmp/new-mailboxes.db skiplist /<confdir>/mailboxes.db <new file format>
Note
The cvt_cyrusdb(8) command does not accept relative paths.
7. Start new 3.0 Cyrus and verify¶
sudo ./master/master -d
Check /var/log/syslog
for errors so you can quickly understand potential problems.
When you’re satisfied version 3.0 is running and can see all its data correctly, start the new Cyrus up with your regular init script.
If something has gone wrong, contact us on the mailing list. You can revert to backups and keep processing mail using your old version until you’re able to finish your 3.0 installation.
8. Reconstruct databases and cache¶
The following steps can each take a long time, so we recommend running them one at a time (to reduce locking contention and high I/O load).
To upgrade all the mailboxes to the latest version. This will take hours, possibly days.
reconstruct -V max
New configuration: if turning on conversations, you need to create conversations.db for each user. This is required for jmap.:
ctl_conversationsdb -b -r
To check (and correct) quota usage:
quota -f
If you’ve been using CalDAV/CardDAV/all of the DAV from earlier releases, then the user.dav databases need to be reconstructed due to format changes.:
dav_reconstruct -a
9. Do you want any new features?¶
3.0 comes with many lovely new features. Consider which ones you want to enable. Here are some which may interest you. Check the 3.0 release notes for the full list.
- JMAP
- Backups
- Xapian for searching
- Cross-domain support. See
crossdomains
in imapd.conf(5)
10. Upgrade complete¶
Your upgrade is complete! We have a super-quick survey (3 questions only, anonymous responses) we would love for you to fill out, so we can get a feel for how many Cyrus installations are out there, and how the upgrade process went.
I'll fill in the survey right now (opens in a new window)
Special note for Murder configurations¶
If you upgrade murder frontends before you upgrade all the backends, they may advertise features to clients which the backends don’t support, which will cause the commands to fail when they are proxied to the backend.
Generally accepted wisdom when upgrading a Murder configuration is to upgrade all your back end servers first. This can be done one at a time.
Upgrade your mupdate master and front ends last.