| 1 |
Ubuntu |
| 2 |
====== |
| 3 |
|
| 4 |
Currently supported versions of Ubuntu include Cyrus IMAP packages in |
| 5 |
the repositories configured on a stock system: |
| 6 |
|
| 7 |
* Cyrus IMAP |imap_precise_stock_version| for Ubuntu 12.04.5 (Precise Pangolin) |
| 8 |
* Cyrus IMAP |imap_trusty_stock_version| for Ubuntu 14.04.2 (Trusty Tahr) (Stable) |
| 9 |
* Cyrus IMAP |imap_utopic_stock_version| for Ubuntu 14.10 (Utopic Unicorn) |
| 10 |
* Cyrus IMAP |imap_vivid_stock_version| for Ubuntu 15.04 (Vivid Vervet) (Current) |
| 11 |
* Cyrus IMAP |imap_wily_stock_version| for Ubuntu 15.10 (Wily Werewolf) (Development) |
| 12 |
|
| 13 |
.. NOTE:: |
| 14 |
|
| 15 |
The Cyrus project does not support running any versions of the Cyrus |
| 16 |
IMAP software older than the version of the software shipped |
| 17 |
with the operating system itself. |
| 18 |
|
| 19 |
To install the version of Cyrus IMAP that comes with the operating |
| 20 |
system, issue the following command: |
| 21 |
|
| 22 |
.. parsed-literal:: |
| 23 |
|
| 24 |
# :command:`sudo apt-get install cyrus-imapd cyrus-clients-2.4 cyrus-doc-2.4 cyrus-admin-2.4 sasl2-bin` |
| 25 |
|
| 26 |
.. Note:: |
| 27 |
The cyrus-imapd meta-package will trigger installation of the following Cyrus packages: |
| 28 |
|
| 29 |
* cyrus-common (another meta-package) |
| 30 |
* cyrus-common-2.4 |
| 31 |
* cyrus-imapd-2.4 |
| 32 |
|
| 33 |
.. Note:: |
| 34 |
The following non-Cyrus packages are required, and will be installed |
| 35 |
automatically as needed: |
| 36 |
|
| 37 |
* db-util |
| 38 |
* db-upgrade-util |
| 39 |
* libsasl2-2 |
| 40 |
* libsasl2-modules |
| 41 |
* libcomerr2 |
| 42 |
* [etc.] |
| 43 |
|
| 44 |
.. _Debian Cyrus Team: https://launchpad.net/~pkg-cyrus-imapd-debian-devel |
| 45 |
.. Note:: |
| 46 |
The `Debian Cyrus Team`_ packages are split based upon functional |
| 47 |
requirements of the installation. Depending upon your needs, you may also |
| 48 |
wish to install any or all of these packages: |
| 49 |
|
| 50 |
* cyrus-pop3d-2.4 |
| 51 |
* cyrus-murder-2.4 |
| 52 |
* cyrus-replication-2.4 |
| 53 |
* cyrus-nntpd-2.4 |
| 54 |
* cyrus-caldav-2.4 |
| 55 |
|
| 56 |
Once you've decided which services to support (IMAP, POP3, NNTP, CalDav), |
| 57 |
and whether those services shall be available in secured versions, |
| 58 |
you'll need to edit ``/etc/cyrus.conf`` and check the ``SERVICES`` |
| 59 |
section, commenting and uncommenting as needed to enable or disable the |
| 60 |
proper versions of those services. |
| 61 |
|
| 62 |
Here's the stock version of the ``SERVICES`` section of |
| 63 |
``/etc/cyrus.conf`` as shipped with these packages: |
| 64 |
|
| 65 |
.. parsed-literal:: |
| 66 |
SERVICES { |
| 67 |
# --- Normal cyrus spool, or Murder backends --- |
| 68 |
# add or remove based on preferences |
| 69 |
imap cmd="imapd -U 30" listen="imap" prefork=0 maxchild=100 |
| 70 |
#imaps cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100 |
| 71 |
pop3 cmd="pop3d -U 30" listen="pop3" prefork=0 maxchild=50 |
| 72 |
#pop3s cmd="pop3d -s -U 30" listen="pop3s" prefork=0 maxchild=50 |
| 73 |
nntp cmd="nntpd -U 30" listen="nntp" prefork=0 maxchild=100 |
| 74 |
#nntps cmd="nntpd -s -U 30" listen="nntps" prefork=0 maxchild=100 |
| 75 |
http cmd="httpd -U 30" listen="8008" prefork=0 maxchild=100 |
| 76 |
#https cmd="httpd -s -U 30" listen="8443" prefork=0 maxchild=100 |
| 77 |
|
| 78 |
|
| 79 |
# At least one form of LMTP is required for delivery |
| 80 |
# (you must keep the Unix socket name in sync with imap.conf) |
| 81 |
#lmtp cmd="lmtpd" listen="localhost:lmtp" prefork=0 maxchild=20 |
| 82 |
lmtpunix cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20 |
| 83 |
# ---------------------------------------------- |
| 84 |
|
| 85 |
# useful if you need to give users remote access to sieve |
| 86 |
# by default, we limit this to localhost in Debian |
| 87 |
sieve cmd="timsieved" listen="localhost:sieve" prefork=0 maxchild=100 |
| 88 |
|
| 89 |
# this one is needed for the notification services |
| 90 |
notify cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1 |
| 91 |
|
| 92 |
# --- Murder frontends ------------------------- |
| 93 |
# enable these and disable the matching services above, |
| 94 |
# except for sieve (which deals automatically with Murder) |
| 95 |
|
| 96 |
# mupdate database service - must prefork at least 1 |
| 97 |
# (mupdate slaves) |
| 98 |
#mupdate cmd="mupdate" listen=3905 prefork=1 |
| 99 |
# (mupdate master, only one in the entire cluster) |
| 100 |
#mupdate cmd="mupdate -m" listen=3905 prefork=1 |
| 101 |
|
| 102 |
# proxies that will connect to the backends |
| 103 |
#imap cmd="proxyd" listen="imap" prefork=0 maxchild=100 |
| 104 |
#imaps cmd="proxyd -s" listen="imaps" prefork=0 maxchild=100 |
| 105 |
#pop3 cmd="pop3proxyd" listen="pop3" prefork=0 maxchild=50 |
| 106 |
#pop3s cmd="pop3proxyd -s" listen="pop3s" prefork=0 maxchild=50 |
| 107 |
#lmtp cmd="lmtpproxyd" listen="lmtp" prefork=1 maxchild=20 |
| 108 |
# ---------------------------------------------- |
| 109 |
} |
| 110 |
|
| 111 |
.. Note:: |
| 112 |
The default settings, as shown above, are for non-secure protocol |
| 113 |
access. |
| 114 |
|
| 115 |
Edit ``/etc/imapd.conf`` and change the default settings as needed. |
| 116 |
Please consult |
| 117 |
:cyrusman:`imapd.conf(5)` for details. |
| 118 |
|
| 119 |
* You MUST, at the very least, uncomment the ``admins:`` line. |
| 120 |
* As documented in the man page, "the values ``yes``, ``on``, ``t``, ``true`` and ``1`` turn the option on, the values ``no``, ``off``, ``f``, ``false`` and ``0`` turn the option off." |
| 121 |
* If you are NOT using SSL and/or STARTTLS, you MUST enable plain text logins, and set ``sasl_minimum_layer: 0`` for authentication to work, or have some other protection layer in place. |
| 122 |
* Consider enabling the commonly used settings ``altnamespace`` and ``unixhierarchysep`` as these will default to ``on`` beginning in version 3.0. |
| 123 |
* Check your ``sasl_pwcheck_method`` setting, as this defaults to ``auxprop`` with these packages, which is likely not what you want. Change it to ``saslauthd`` or ``pwcheck`` as needed. |
| 124 |
|
| 125 |
Next, set a password for the default administrative user ``cyrus``. |
| 126 |
Your choice of authentication system will dictate the proper way to do |
| 127 |
this. Shown below are examples for \*nix password file and SASL methods: |
| 128 |
|
| 129 |
.. parsed-literal:: |
| 130 |
|
| 131 |
# :command:`passwd cyrus` |
| 132 |
Changing password for user cyrus. |
| 133 |
New password: |
| 134 |
Retype new password: |
| 135 |
passwd: all authentication tokens updated successfully. |
| 136 |
|
| 137 |
# :command:`saslpasswd2 -c cyrus` |
| 138 |
Password: |
| 139 |
Again (for verification): |
| 140 |
|
| 141 |
# :command:`sasldblistusers2` |
| 142 |
cyrus\@newhost.example.com: userPassword |
| 143 |
|
| 144 |
To enable |
| 145 |
:manpage:`saslauthd`, edit ``/etc/default/saslauthd`` and set |
| 146 |
``START=yes``. Make sure to change any other settings here as needed. |
| 147 |
|
| 148 |
.. Note:: |
| 149 |
If you're planning to integrate Cyrus with the Postfix MTA, it is |
| 150 |
necessary to either relocate the socket used by ``saslauthd``, or |
| 151 |
else to disable ``chroot`` as noted in ``/etc/default/saslauthd``, |
| 152 |
so the Postfix ``smtpd`` daemon can access it. |
| 153 |
|
| 154 |
Start :manpage:`saslauthd` if needed: |
| 155 |
|
| 156 |
.. parsed-literal:: |
| 157 |
|
| 158 |
# :command:`service saslauthd start` |
| 159 |
* Starting SASL Authentication Daemon saslauthd [ OK ] |
| 160 |
|
| 161 |
You should at this moment be able to authenticate against |
| 162 |
saslauthd: |
| 163 |
|
| 164 |
.. parsed-literal:: |
| 165 |
|
| 166 |
# :command:`testsaslauthd -u cyrus -p YOUR-PASSWORD` |
| 167 |
|
| 168 |
.. todo:: If this does not succeed, see ref `sasl-troubleshooting-saslauthd`. |
| 169 |
|
| 170 |
Start the service, and ensure the service starts up when the system |
| 171 |
boots: |
| 172 |
|
| 173 |
.. parsed-literal:: |
| 174 |
|
| 175 |
# :command:`service cyrus-imapd start` |
| 176 |
# :command:`update-rc.d cyrus-imapd enable` |
| 177 |
|
| 178 |
You should now be able to login as the ``cyrus`` user, which is |
| 179 |
configured by default as an administrator for Cyrus IMAP: |
| 180 |
|
| 181 |
.. parsed-literal:: |
| 182 |
|
| 183 |
# :command:`imtest -t "" -u cyrus -a cyrus localhost` |
| 184 |
S: * OK [CAPABILITY IMAP4rev1 LITERAL+ ID ENABLE STARTTLS LOGINDISABLED COMPRESS=DEFLATE] newhost.example.com Cyrus IMAP v2.4.17-caldav-beta9-Debian-2.4.17+caldav~beta9-3 server ready |
| 185 |
C: S01 STARTTLS |
| 186 |
S: S01 OK Begin TLS negotiation now |
| 187 |
verify error:num=19:self signed certificate in certificate chain |
| 188 |
TLS connection established: TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits) |
| 189 |
C: C01 CAPABILITY |
| 190 |
S: * CAPABILITY IMAP4rev1 LITERAL+ ID ENABLE ACL RIGHTS=kxte QUOTA MAILBOX-REFERRALS NAMESPACE UIDPLUS NO_ATOMIC_RENAME UNSELECT CHILDREN MULTIAPPEND BINARY CATENATE CONDSTORE ESEARCH SORT SORT=MODSEQ SORT=DISPLAY THREAD=ORDEREDSUBJECT THREAD=REFERENCES ANNOTATEMORE LIST-EXTENDED WITHIN QRESYNC SCAN XLIST URLAUTH URLAUTH=BINARY AUTH=PLAIN SASL-IR COMPRESS=DEFLATE IDLE |
| 191 |
S: C01 OK Completed |
| 192 |
Please enter your password: |
| 193 |
C: A01 AUTHENTICATE PLAIN \*\*\*\*\*\*\*\*\*\*\*\* |
| 194 |
S: A01 OK [CAPABILITY IMAP4rev1 LITERAL+ ID ENABLE ACL RIGHTS=kxte QUOTA MAILBOX-REFERRALS NAMESPACE UIDPLUS NO_ATOMIC_RENAME UNSELECT CHILDREN MULTIAPPEND BINARY CATENATE CONDSTORE ESEARCH SORT SORT=MODSEQ SORT=DISPLAY THREAD=ORDEREDSUBJECT THREAD=REFERENCES ANNOTATEMORE LIST-EXTENDED WITHIN QRESYNC SCAN XLIST URLAUTH URLAUTH=BINARY LOGINDISABLED COMPRESS=DEFLATE IDLE] Success (tls protection) |
| 195 |
Authenticated. |
| 196 |
Security strength factor: 256 |
| 197 |
. logout |
| 198 |
. LIST "" "*" |
| 199 |
. OK Completed (0.000 secs 1 calls) |
| 200 |
* BYE LOGOUT received |
| 201 |
. OK Completed |
| 202 |
Connection closed. |
| 203 |
|
| 204 |
Next, continue with :ref:`imap-configuring-the-mta`. |
| 205 |
|
| 206 |
.. |
| 207 |
Other Versions of Cyrus IMAP |
| 208 |
---------------------------- |
| 209 |
|
| 210 |
The following guides walk you through providing you with a version of |
| 211 |
the Cyrus IMAP software that is no longer mainstream, and as such the |
| 212 |
level of technical detail is advanced. |
| 213 |
|
| 214 |
* :ref:`imap-installation-centos-last-stable` |
| 215 |
* :ref:`imap-installation-centos-last-stable-next` |
| 216 |
* :ref:`imap-installation-centos-current-stable` |
| 217 |
* :ref:`imap-installation-centos-current-stable-next` |
| 218 |
* :ref:`imap-installation-centos-latest-development` |
| 219 |
|
| 220 |
.. toctree:: |
| 221 |
:glob: |
| 222 |
:hidden: |
| 223 |
|
| 224 |
ubuntu/* |