summaryrefslogtreecommitdiff
path: root/Installation_Manual/en-US/Cyrus_IMAP.xml
blob: 6c2e436106bff2ec126dc69eaabfc21f8975c222 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Manual.ent">
%BOOK_ENTITIES;
]>
<part id="part-Installation_Manual-Cyrus_IMAP">
    <title>Cyrus IMAP</title>
    <subtitle>Instructions on Using Cyrus IMAP as the Kolab IMAP Server</subtitle>
    <partintro>
        <para>
            This part of the Kolab &PRODUCT_VERSION; Installation Manual applies to installing, configuring, managing, upgrading, migrating and tweaking the Cyrus IMAP component of the Kolab Groupware Solution.
        </para>
    </partintro>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-Installation_of_Cyrus_IMAP">
        <title>Installation of Cyrus IMAP</title>
        <formalpara>
            <title>Kolab Systems Repository Configuration</title>
            <para>
                Make sure you have the Kolab Systems software repositories configured properly on the system, before executing any of the following commands. For more information on configuring the Kolab Systems software repositories, please refer to <xref linkend="sect-Installation_Manual-Kolab_Systems_Software_Repositories-Configuration" />.
            </para>
        </formalpara>

        <section>
            <title>Installation</title>
            <para>
                The package name for Cyrus IMAP is <application>kolab-cyrus-imapd</application> on APT and RPM based systems. On OpenPKG deployments, the package name is <application>imapd</application>.
            </para>

            <formalpara>
                <title>Installation Instructions for APT-based Systems</title>
                <para>
                    To install Cyrus IMAP on APT-based systems such as Debian and Ubuntu Long-Term Support, execute the following command;
                </para>
            </formalpara>
            <para>
                <screen># <userinput>apt-get -y install kolab-cyrus-imapd</userinput></screen>
            </para>

            <formalpara>
                <title>Installation Instructions for RPM-based Systems</title>
                <para>
                    To install Cyrus IMAP on RPM-based systems such as Fedora, Red Hat, CentOS and Scientific Linux, execute the following command;
                </para>
            </formalpara>
            <para>
                <screen># <userinput>yum -y install kolab-cyrus-imapd</userinput></screen>
            </para>

            <para>
                <application>kolab-cyrus-imapd</application> will be installed on the system, including any software Cyrus IMAP depends on.
            </para>
            <para>
                The service <application>cyrus-imapd</application> will not yet be started, as you require configuration first.
            </para>
            <para>
                TODO: We can't automatically configure the software; we don't know where the configuration should come from and any hit is a lucky hit. We also don't know what the system is intended for. Nor can we figure such out. Maybe develop and contruct in the Kolab Systems packaging a means for Cyrus IMAP to in fact be automatically configured using a slipstream command, so that the next step is to verify, not configure.
            </para>

        </section>
    </chapter>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-Configuration_of_Cyrus_IMAP">
        <title>Configuration of Cyrus IMAP</title>
        <para>
            The following configuration files are installed on the system:
        </para>
        <para>
            <itemizedlist>
                <listitem>
                    <formalpara>
                        <title>&CYRUS_CONFIG;</title>
                        <para>
                            Configure which services Cyrus IMAP is to offer, using &CYRUS_CONFIG;. By default, POP and IMAP services have both been enabled for normal (plaintext) only, as you require a certificate for TLS and SSL configurations. Please refer to <xref linkend="chap-Installation_Manual-Cyrus_IMAP-Securing_Cyrus_IMAP_Communications" /> for more details if you seek to secure communications.
                        </para>
                    </formalpara>
                </listitem>
                <listitem>
                    <formalpara>
                        <title>&CYRUS_IMAPD_CONFIG;</title>
                        <para>
                            The behaviour of Cyrus IMAP is controlled using &CYRUS_IMAPD_CONFIG;. Please refer to <xref linkend="chap-Installation_Manual-Cyrus_IMAP-Configuring_IMAP" /> for standard configurations, and <xref linkend="chap-Installation_Manual-Cyrus_IMAP-IMAP_Option_Reference" /> for a list of options.
                        </para>
                    </formalpara>
                </listitem>
                <listitem>
                    <formalpara>
                        <title>&CYRUS_ANNOTATIONS_CONFIG;</title>
                        <para>
                            &CYRUS_ANNOTATIONS_CONFIG; contains the Kolab annotations for use with the Kolab Groupware Solution.
                        </para>
                    </formalpara>
                </listitem>
                <listitem>
                    <formalpara>
                        <title>System Configuration Defaults</title>
                        <para>
                            While the location depends on whether you use an APT-based or RPM-based system, the contents of the file describe system-wide configuration and service defaults, such as the location of &CYRUS_CONFIG; should you require such file to be in a different, non-default location. Please refer to <xref linkend="chap-Installation_Manual-Cyrus_IMAP-System_Configuration_Defaults_Options" /> for more information on available options.
                        </para>
                    </formalpara>

                    <formalpara>
                        <title>APT-based Systems</title>
                        <para>
                            On APT-based Systems, please use &APT_CYRUS_SYS_DEFAULTS; as the system configuration defaults file.
                        </para>
                    </formalpara>

                    <formalpara>
                        <title>RPM-based Systems</title>
                        <para>
                            On RPM-based Systems, please use &RPM_CYRUS_SYS_DEFAULTS; as the system configuration defaults file.
                        </para>
                    </formalpara>

                    <note>
                        <title>System Configuration Defaults</title>
                        <para>
                            The system configuration defaults normally suffice, and should not have to be altered unless you have very specific requirements.
                        </para>
                    </note>

                </listitem>
            </itemizedlist>
        </para>

        <para>
            In addition to these configuration files, the following directories are used for Cyrus IMAP by default:
        </para>

        <para>
            <itemizedlist>
                <listitem>
                    <formalpara>
                        <title>&CYRUS_CONFIGDIR;</title>
                        <para>
                            Cyrus IMAP stores it's databases and transactional data here, such as Sieve scripts.
                        </para>
                    </formalpara>
                </listitem>
                <listitem>
                    <formalpara>
                        <title>&CYRUS_SPOOLDIR;</title>
                        <para>
                            The primary (default) IMAP partition. Please refer to <xref linkend="chap-Installation_Manual-Cyrus_IMAP-IMAP_Partitions" /> for
                        </para>
                    </formalpara>
                </listitem>
            </itemizedlist>
        </para>

        <para>
            TODO: Quick To Go: Small deployments
        </para>

    </chapter>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-Configuring_IMAP">
        <title>Configuring IMAP</title>
        <para>
            TODO: While the defaults shipped in the Kolab Systems software packages are good to go for most common Cyrus IMAP deployments, ...
        </para>
    </chapter>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-Securing_Cyrus_IMAP_Communications">
        <title>Securing Cyrus IMAP Communications</title>
        <para>
            TODO: Describe
        </para>
    </chapter>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-IMAP_Partitions">
        <title>IMAP Partitions</title>
        <para>
            TODO
        </para>
    </chapter>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-IMAP_Option_Reference">
        <title>IMAP Option Reference</title>
        <para>
            TODO: list/table of options
        </para>

    </chapter>

    <chapter id="chap-Installation_Manual-Cyrus_IMAP-System_Configuration_Defaults_Options">
        <title>System Configuration Defaults</title>
        <para>
            The following options are available in the system configuration defaults file (&APT_CYRUS_SYS_DEFAULTS; for APT-based systems and &RPM_CYRUS_SYS_DEFAULTS; for RPM-based systems);
        </para>
        <para>
            <itemizedlist>
                <listitem>
                    <formalpara>
                        <title><literal>CYRUS_CONFIG</literal></title>
                        <para>
                            The location of the Cyrus master configuration file, &CYRUS_CONFIG; by default. Valid options are existing Cyrus configuration files.
                        </para>
                    </formalpara>
                </listitem>
                <listitem>
                    <formalpara>
                        <title><literal>IMAPD_CONFIG</literal></title>
                        <para>
                            The location of the Cyrus IMAP configuration file, controlling aspects such as authentication, storage locations, database types and other general Groupware infrastructure. &CYRUS_IMAPD_CONFIG; by default. Valid options are existing Cyrus IMAP coniguration files.
                        </para>
                    </formalpara>
                </listitem>
                <listitem>
                    <formalpara>
                        <title><literal>LISTENQUEUE</literal></title>
                        <para>
                            The size of the listen queue. <literal>32</literal> by default. Only integers are valid.
                        </para>
                    </formalpara>
                    <para>
                        TODO: Figure out the maximum length/size of LISTENQUEUE
                    </para>
                </listitem>
                <listitem>
                    <formalpara>
                        <title><literal>CYRUS_VERBOSE</literal></title>
                        <para>
                            What <application>cyrus-master</application> process. Not set by default.
                        </para>
                    </formalpara>
                    <para>
                        TODO: Figure out useful values for CYRUS_VERBOSE
                    </para>
                </listitem>
                <listitem>
                    <formalpara>
                        <title><literal>CYRUS_OPTIONS</literal></title>
                        <para>
                            Additional options to pass on to the <application>cyrus-master</application> process. Not set by default. To get a list of valid options, please refer to the <literal>cyrus-master(8)</literal> man page.
                        </para>
                    </formalpara>
                </listitem>
            </itemizedlist>
        </para>
    </chapter>

    <chapter>
        <title>Creating a Cyrus Murder Setup</title>
        <para>
            TODO
        </para>

        <section>
            <title>Setting up the master update server</title>
            <para>
                TODO
            </para>

            <section>
                <title>Choosing the mupdate mode</title>
                <para>
                    TODO: on unified, replica, etc.
                </para>
            </section>

        </section>

    </chapter>

    <chapter>
        <title>Creating an IMAP Backend Server</title>
        <para>
            TODO
        </para>

        <section>
            <title>Hooking in a new backend server into a murder setup</title>
            <para>
                TODO
            </para>
        </section>

    </chapter>

    <chapter>
        <title>Creating an IMAP Frontend Server</title>
        <para>
            TODO
        </para>

        <section>
            <title>Hooking in a new frontend server into a murder setup</title>
            <para>
                TODO
            </para>
        </section>

    </chapter>

</part>