Debian Codegraph @

doc/html/_sources/imap/concepts/deployment/supported-platforms.rst.txt

raw
1 Supported Platforms and System Requirements
2 ===========================================
3
4 Cyrus IMAP supports the following platforms;
5
6 * FreeBSD
7
8 * All reasonably recent versions of Linux, including but not limited to the
9 following distributions, in no particular order other than alphabetic;
10
11 * `CentOS <https://www.centos.org>`__
12 * `Debian <https://www.debian.org>`__
13 * `Fedora <https://www.fedoraproject.org>`__
14 * `Gentoo <https://www.gentoo.org>`__
15 * `openSUSE <https://www.opensuse.org>`__
16 * `Red Hat Enterprise Linux <https://www.redhat.com/en>`__
17 * `SUSE Linux <https://www.suse.com>`__
18
19 Should your Linux distribution not be listed here, please refer to
20 :ref:`support` for ways of contacting the Cyrus IMAP team.
21
22 * Solaris
23
24 By reasonably recent versions of Linux, we intend to indicate the Cyrus project
25 can keep up with the latest distribution release earmarked stable.
26
27 Building Cyrus IMAP
28 -------------------
29
30 In this section, we only list the aspects of building Cyrus IMAP of particular
31 interest to most common deployment scenarios. For more information on all
32 ``configure`` options with full details, we refer you to ``./configure --help``.
33
34 Required Software Components
35 ----------------------------
36
37 The following software components are required for Cyrus IMAP to build at all,
38 with minimal functionality;
39
40 * ``autoconf``
41 * ``automake``
42 * ``zlib`` (Development Headers)
43
44 Obviously, the list is not complete
45
46 Recommended Software Components
47 -------------------------------
48
49 We recommend you consider building Cyrus IMAP with the following software
50 components included;
51
52 Idled Support
53 """""""""""""
54
55 To enable near real-time client updates through IMAP IDLE (as described in
56 :rfc:`2177`), configure Cyrus IMAP with the ``--enable-idled`` option.
57
58 Murder Support
59 """"""""""""""
60
61 To enable horizontal scalability, Cyrus IMAP supports the distribution of
62 mailboxes across Cyrus IMAP servers in a Murder setup. To enable murder support
63 in Cyrus IMAP, configure Cyrus IMAP with the ``--enable-murder`` option.
64
65 Replication Support
66 """""""""""""""""""
67
68 To enable replication support in Cyrus IMAP, configure Cyrus IMAP with the
69 ``--enable-replication`` option.
70
71 Obviously, the list is not complete
72
73 Recommended Software Components Enabled by Default
74 --------------------------------------------------
75
76 Sieve Support
77 """""""""""""
78
79 Without any additional effort, Sieve support is already enabled by default. To
80 disable Sieve, use the ``--disable-sieve`` option to ``configure``.
81
82 Optional Software Components
83 """"""""""""""""""""""""""""
84
85 When including the following software components during the build process,
86 and providing the options listed here, additional optional functionality can
87 be implemented;
88
89 **MySQL** (Development headers)
90
91 To enable using MySQL as a database server backend, include the MySQL
92 development headers and make sure to configure Cyrus IMAP with
93 ``--with-mysql``.
94
95 Should MySQL - the client libraries or the development headers - be installed
96 in a non-standard location, please consider using any of the following options;
97
98 ::
99
100 --with-mysql=DIR use MySQL (in DIR) [no]
101 --with-mysql-libdir=DIR MySQL lib files are in DIR
102 --with-mysql-incdir=DIR MySQL include files are in DIR
103
104 **PostgreSQL** (Development headers)
105
106 To enable using PostgreSQL as a database server backend, include the
107 PostgreSQL development headers and make sure to configure Cyrus IMAP with
108 ``--with-pgsql``.
109
110 Should PostgreSQL - the client libraries or the development headers - be
111 installed in a non-standard location, please consider using any of the
112 following options;
113
114 ::
115
116 --with-pgsql=DIR use PostgreSQL (in DIR) [no]
117 --with-pgsql-libdir=DIR Pgsql lib files are in DIR
118 --with-pgsql-incdir=DIR Pgsql include files are in DIR
119
120 Obviously, the list is not complete