"Fossies" - the Fresh Open Source Software Archive
Member "cyrus-imapd-3.0.10/doc/legacy/install-upgrade.html" (27 May 2019, 32806 Bytes) of package /linux/misc/cyrus-imapd-3.0.10.tar.gz:
Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links.
You can here alternatively try to browse
the pure source code or just view
the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the cyrus-imapd-3.0.10.tar.gz
project site itself.
Upgrading From Previous Versions
Upgrading from all 2.4 series to 2.5
- It is strongly advised to shut down the server completely while
performing the upgrade, because newer daemons will write
mailboxes.db entries which aren't compatible with the old
daemons, and may cause crashes if you try to upgrade
a running server. You can start the server again immediately
with the new daemons installed.
- The most important change is that index file upgrades are
no longer automatic. This avoids the IO storm caused by
upgrades from 2.3 to 2.4. Even if you are upgrading from
Cyrus 2.2, it won't cause an IO storm any more.
Instead, you need to run reconstruct -V max to
upgrade each mailbox in turn. This will upgrade all
mailboxes to the current minor version 13. This can
be safely done while the server is running.
- Older version mailboxes will continue to work "forever",
though newer features like annotation quotas will fail,
since there's no space in the mailbox header to store them.
There may be slightly inconsistent search results until you upgrade.
The cyrus.cache format in 2.3 and earlier ran words together
in cache, so searches won't obey word boundaries like they
do in 2.4+
- If you were running Cyrus 2.3.x with expunge_mode: delayed,
then the contents of the cyrus.expunge file will be removed
the first time the mailbox is opened, and the mailbox will
act as if expunge_mode: immediate was set until it is upgraded.
This is because version 2.3 mailboxes used the cyrus.expunge
file, and it's not worth the complexity to try to recreate
- After all mailboxes are upgraded, you should run quota -f
to make sure all the message and folder count quotas are correct.
Cyrus 2.5 supports new quota types, and the counts need to be
- Many configuration options have changed and new features
have been added, read the release notes.
- Mailboxes.db and quota internal formats have changed.
- Just go read the release notes already:
Upgrading from 2.4.17-caldav-beta10 or earlier
- The schema used for the CalDAV database has changed. ALL sites
MUST run the dav_reconstruct utility for each of their
Upgrading from 2.4.17-caldav-beta9 or earlier
- The time span calculations for recurring events in which the
component containing the RRULE is not the first component have
been fixed. We recommend ALL sites run
the dav_reconstruct utility for each of their CalDAV
Upgrading from 2.4.17-caldav-beta6 or earlier
- The time span calculations for various VCALENDAR components,
especially VTODO (tasks), have been fixed. We recommend ALL sites
run the dav_reconstruct utility for each of their CalDAV
Upgrading from 2.4.12
- some LOG_DEBUG level messages are no longer created by
default in the duplicate delivery system, so you won't
see them in syslog any more
- mailboxes in the DELETED. heirarchy are now always
suppressed for non-admin users, even if delayed delete
is not enabled (see Bug #3604). If you happen to be
using this namespace at your site for something else,
you're crazy - but you can set "deletedprefix" in
imapd.conf to an invalid value (e.g. '-') if you
Upgrading from 2.4.11
- To support bug-interoperability with older versions of Cyrus,
the quota command now supports "-1" as a synonym for
Upgrading from 2.4.10
- Duplicate database formats have changed, so any duplicate or
vacation data will be lost - meaning that vacation responses
will be sent again, and duplicates just across the upgrade
time will both get delivered.
Upgrading from 2.4.9
- quota -f now works correctly. If you are upgrading from earlier
than 2.4.9 we recommend that you run quota -f to ensure that all
quotas are now correct. There is a slight race condition in the
quota command, so it's safest to run with the server shut down,
but this has always existed.
- On the topic of quota -f, the documentation has been updated to
make it quite clear that you need to give "complete" prefixes if
using quotalegacy, as it doesn't implement quite the same semantics
as other databases. If you run 'quota -f a' and you have domains
starting with 'a', you will be quite sad at the results. So don't
do that. Running quota -f with no argument, or with a full domain
or full user specification is perfectly safe.
Upgrading from 2.4.8
- CYRUS_PREFIX environemnt varabile. If you have an environment
variable "CYRUS_PREFIX" then config files will be searched for
in there first, so for example the file /var/cyrus/etc/imapd.conf
will override /etc/imapd.conf if your CYRUS_PREFIX is /var/cyrus.
This is to make things easier for sites with multiple installs
on a single machine. You will want to check that there aren't
unexpected files in those locations when upgrading.
- New config options: *_db_path allow moving individual DB files
to different partitions - for example you may want to put the
deliver.db onto tmpfs to improve performance.
- KNOWN BUG: quota -f can double ALL quota usage values for all
users. This is particularly bad because of the bug fixed in
this release where quotaroots were not correctly updated on
folder rename. Recommended workaround: run quota -f
Upgrading from 2.4.7
- New config option: proc_path allows setting the
path to the proc directory onto tmpfs more easily
Upgrading from 2.4.6
- New config option: failedloginpause allows you to
change the pause after a failed login from the existing default
of 3 seconds
- On Solaris: now getpassphrase is used, so passwords longer
than 8 characters will work with management tools
- $confdir/proc now gets created automatically if it doesn't
exist, which may impact init script design
- If you have damaged mailboxes that weren't previously
fixable, a reconstruct of those mailboxes may be advised
Upgrading from 2.4.5
- New config option: suppress_capabilities, which
takes a space separated list of capabilities which will NOT
be given in any imap capability response. This can be used
on frontends to not display capabilities that older backends
don't have, so clients don't get confused
Upgrading from 2.4.4
- sync_client no longer forks two process - it just pre-forks
a single process in rolling replication mode and uses it
"forever". This is to avoid the bug where it used to open
the BDB environment once before forking, then close it in
every child, causing the reference count to go negative.
This also means you can start it without '-o' and still
have the master start without the replica already running.
Upgrading from 2.4.3
- Actually, it's more upgrading directly to here from 2.3.x or
older. ALL upgrades from previous versions now incur a full
re-parse of all messages, which may take a while. In
exchange you get reliable upgrades though, and guaranteed
still-searchable cyrus.cache records.
Upgrading from 2.4.2
- The AFS ptloader configure options have changed. If you were
previously specifying --with-afs when you built, you'll now
want to use --enable-afs instead. Additionally, you may
now specify --with-afs-libdir and --with-afs-incdir to
facilitate finding the AFS libraries and header files.
- The sync_log_names option has been replaced with
sync_log_channels and the documentation and tools
updated to match. This is to use a less overloaded term
and allow multi-channel replication to be used.
- Cyrus 2.4.3 can now XFER mailboxes back to earlier
version (at least as far back as Cyrus 2.2.12) in a
- sync_client in rolling mode now only connects after
forking, so it no longer blocks startup. You can
remove the '-o' option from your cyrus.conf entry
if you want, and not have to start sync_client
Upgrading from 2.4.0
- The response to the "ID" command has changed slightly to include
git metadata rather than CVS metadata - so your in-house tools
expecting a particular value may need changing (very unlikely)
Upgrading from 2.3.16
Upgrading from 2.3.15
- The SQL detection code in configure has been reworked. Separate
options for the include directories and lib directories have been
added. Previous SQL options may not work as expected.
Upgrading from 2.3.10
- STARTTLS is now allowed for externally preauth'd LMTP connections.
If you don't want STARTTLS to be advertised and used by preauth'd
clients, you can set <service_name>_tls_cert_file:
disabled in imapd.conf.
Upgrading from 2.3.9
- The method used for generating Globally Unique IDentifiers used
for replication has been changed to be the SHA1 hash of the messages.
If you wish to upgrade the existing GUIDs in particular mailbox(es) or
the entire server, perform the following steps in the listed order.
Note that is is NOT REQUIRED that existing GUIDs be upgraded.
- Zero GUIDs on the replica (reconstruct -g)
- Regenerate GUIDs on the master (reconstruct -G)
- Regenerate GUIDs on the replica (reconstruct -G)
Upgrading from 2.3.8
- You must install and configure Cyrus SASL version 2.1.17 or later
to use Cyrus IMAP 2.3.9 and later. You can download SASL at
- The default value of the allowplaintext option has been
changed to disabled (0). If you need to allow cleartext passwords on
the wire, then you will have to explicitly enable the
allowplaintext option in imapd.conf.
Upgrading from 2.3.3 or later (64-bit machines)
- Due to byte alignment issues in cyrus.index, all mailboxes
will have to be reconstructed.
Upgrading from 2.3.4 or 2.3.5
- Any mailboxes which had messages appended/delivered/copied with a
2.3.4 service or copied with a 2.3.5 imapd MUST be
reconstructed in order for the new messages to be displayed by
Upgrading from 2.2.x or earlier
- If you wish to use separate metadata partition(s), you MUST
first shut down Cyrus and then perform the following:
- Set the metapartition-* and metapartition_files
options to suit your configuration. For a full description of these
options, see the imapd.conf(5) man page.
- Create the metadata partition directory(s) listed in the
metapartition-* option(s), setting the ownership and
permissions in same fashion as step 6 of install-configure.
- Run the tools/migrate-metadata script (as the cyrus user)
to move the metadata files listed in the
metapartition_files option from the spool partition(s) to the
new metadata partition(s). This script may take a long time to run
depending on the number of mailboxes on the server, but presumably the
metadata partitions are located on high speed storage, so the writes
should be relatively fast.
- Restart Cyrus.
Upgrading from 2.2.2 or earlier
- The Cyrus database backend configuration is now handled at runtime
using imapd.conf options. If you are not using the default
backend for any of the databases, make sure that you specify the
correct backend(s) in appropriate option(s).
- The format of the newspeer option has been changed.
The existing format will still be parsed, but the option should be
upgraded to use the new format (see imapd.conf(5) for
Upgrading from 2.2.1 or earlier
Upgrading from 2.2.0 or earlier
Upgrading from 2.1.x or earlier
General information (ALL SITES)
Specialized information (Murder, AFS, etc.)
- The IMAP IDLE command is now supported by proxyd and is controlled
by the imapidlepoll option, which is enabled by default (60
seconds). To disable IMAP IDLE in proxyd, set imapidlepoll
- User moves via RENAME and XFER are now controlled by the
allowusermoves option, which defaults to off.
- If you use ptloader, it now runs as a regular cyrus
service. This means that you will need master to acquire and maintain
AFS tokens for it. You will also need to create the ptclient
directory under your imap configdirectory, to hold the PTS cache (now
a full-fledged cyrusdb) and UNIX socket. In cyrus.conf,
ptloader should be setup to listen on
<configdirectory>/ptclient/ptsock. See the
master/test/cmu-backend.conf example configuration file.
- Also, ptloader has been given a generic interface. You
should now specify "--with-auth=pts" (instead of
"--with-auth=krb_pts") to configure. There is also
a --with-pts= configure option that defaults to
afskrb (Kerberos Canonicalization, AFS PTS Groups). There is
also an experimental ldap module. Note also that if ptloader
fails the lookup, authorization (and therefore authentication) will
now fail, as canonicalization is done inside of ptloader.
- The format of sieve referrals has changed to be more consistant
with the current managesieve draft, this may cause interoperability
problems when using managesieve clients and servers from different
- Clients that use old-style ACL commands that include the
"MAILBOX" directive will no longer function.
We do not know of any clients that have this problem currently.
- Any applications that link libcyrus.a now need to link libcyrus_min.a
Upgrading from 2.1.13 or earlier
- We are now more forgiving of MIME boundry headers generated by earlier
versions of eudora. However, if you have messages already in the mailstore
that you want to fix you will need to reconstruct the affected mailboxes
to regenerate the cached bodystructure data to take this into account.
Nothing needs to be done for new messages to be treated in this way.
Upgrading from 2.1.12 or earlier
- timsieved was corrected to behave properly in the altnamespace configuration.
However, this means that it was previously looking for sieve scripts in
"user.name" format instead of the (correct) "user^name"
format. A sample script to do this (which should be run in the top level of
the sieve directory) is in tools/convert-sieve.pl. Note that this
is only needed if you are running with altnamespace turned on.
Upgrading from 2.1.3 or earlier
- If you use notifications (previously notify_zephyr or
notify_unix) this functionality has been seperated out to
notifyd. See the notifyd manpage and example
entries in master/conf.
Upgrading from 2.1.2 or earlier
- Sieve has been updated to be compliant with RFC 3028 and
draft-martin-sieve-notify-01. All notify actions and any
fileinto and/or redirect actions using stringlists
will have to be updated/changed.
Upgrading from 2.0.16 or earlier
Upgrading from 2.0.6, 2.0.7, 2.0.8, or 2.0.9 or earlier
- If you use timsieved to manage Sieve scripts, run the
script "tools/upgradesieve". timsieved now uses
symlinks instead of hard links.
Upgrading from a previous 2.0 version to 2.0.6
Warning: You do not need to follow these instructions if you're
upgrading from version 1.6.
- You can now pick whether to use Berkeley db to store seen state,
the subscription files, and the mailboxes file or a flat text file, at
compile time only. (Look in imap/seen_db.c and
- The format of the mailboxes file and seen state has changed. It is
not possible to preserve seen state, but upgrade the mailboxes file as
- Run ctl_mboxlist -d > mboxlist.temp to dump existing
- Remove old database files: rm mailboxes.db db/*
- With the new version of ctl_mboxlist, run ctl_mboxlist -u <
Upgrading from 1.6.22 or 1.6.24
Warning: Cyrus imapd 2.0 will automatically convert on-disk
file formats as the server is used. It is not possible to run 1.6
after 2.0 has been used on a mail spool without reconstructing every
Upgrading from 1.6.13
- Upgrading from the Cyrus IMAP server version 1.6.13 or earlier:
if you use Sieve, you should run the "tools/upgradesieve"
script, as the format of the "/usr/sieve" directory has
timsieved, included in this release, will handle maintenance of Sieve
- Upgrading from the Cyrus IMAP server version 1.6.10 or earlier:
if you export news via the IMAP server, you'll have to change your
"newsfeeds" file to contain
collectnews!:*:Tf,WR:collectnews The format of the
input to collectnews has changed.
Duplicate delivery suppression is now required for Sieve.
- Upgrading from the Cyrus IMAP server version 1.6.1 or earlier
(including 1.5.x!): the quota and user directories are now hashed by
the first character of the username. This is to reduce the number of
entries in any given directory. It doesn't do a great job (and in some
cases it will do a really poor job) but as a quick hack it shouldn't
make things worse. Optionally, the data partitions can also be hashed
by enabling the "hashimapspool" option.
You must hash your directories using the "dohash" script
in the tools subdirectory. (If you want to hash your mail spool, be
sure to set "hashimapspool" before running "dohash".) This
must be run as the Cyrus user. Be sure to stop mail service while
converting. Doing this in single user mode is probably the safest.
Upgrading from 1.5
- Upgrading from the Cyrus IMAP server version 1.5 or earlier:
libsasl is now required. Configuring SASL to work may be a chore,
especially if you use shadow passwords.
- An ANSI C compiler is now required. gcc should work fine and can
be acquired from
- Make sure to read the upgrading instructions under 1.6 above.
- Upgrading from 1.5.14 or earlier requires deleting the delivered
database. Remove the file delivered.db in the configdirectory and make a
directory called "deliverdb" in the configdirectory. This may cause some
duplicates to get through.
- Upgrading from 1.5.14 or earlier requires removing the PTS cache
database (if the AFS PTS group support is used, which is not the
default). The PTS cache is in /var/ptclient/ptscache.db, and you
should remove it. This is because the format for the PTS cache for
IMSP has changed. If you use AFS ACLs, IMSPd, and IMAPd on the same
machine, make sure you have version 1.5a5 of the IMSP server for this
version of the IMAP server. (If you don't have IMSP, or AFS, don't
worry about it.)
last modified: $Date: 2010/01/06 17:01:29 $