summaryrefslogtreecommitdiff
path: root/Installation_Guide/en-US/Obtaining_Kolab_Software.xml
blob: 452dc6d0a93cfdd2e523246daa715d09714b00fd (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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<?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_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Installation_Guide-Obtaining_Kolab_Software">
    <title>Obtaining Kolab Software</title>
    <para>
        Kolab is built out of the best available Free and Open Source software components, most if not all of which are available through the Linux distribution of your preference. However, such Linux distribution may not be as up-to-date as one might wish for the Kolab Groupware to provide the latest and greatest functionality, or may simply have a different update policy from what is typically acceptable for a Groupware environment. Kolab therefor provides two alternative deployment methods;
    </para>
    <para>
        <itemizedlist>
            <listitem>
                <para>
                    <xref linkend="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_OpenPKG" /> (soon to be deprecated)
                </para>

            </listitem>
            <listitem>
                <para>
                    <xref linkend="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_APT_Packages" /> or <xref linkend="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_RPM_Packages" />
                </para>

            </listitem>

        </itemizedlist>

    </para>
    <section id="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_OpenPKG">
        <title>Installation with OpenPKG</title>
        <para>
            OpenPKG is a package management system based on RPM, allowing the Kolab product components to be provided as one set of packages with all functionality included, in one single go, for all platforms supported by OpenPKG &mdash;including most Linux-based operatig systems.
        </para>
        <para>
            While there certainly are advantages to OpenPKG, it also has a few major downsides:
        </para>
        <simplelist>
            <member> OpenPKG has become proprietary. </member>
            <member> Native packaging efforts have been undertaken by various community members. </member>
            <member> Kolab Groupware through OpenPKG maintained its own copy of the complete dependency stack. </member>

        </simplelist>
        <warning>
            <title>OpenPKG Deprecation Warning</title>
            <para>
                OpenPKG, as a delivery method for Kolab, will be deprecated with 3.0 series releases. Please refer to the native packaging sections in this guide for instructions on native packages provided by Kolab.
            </para>

        </warning>
        <section id="sect-Installation_Guide-Installation_with_OpenPKG-Obtaining_the_OpenPKG_RPMs">
            <title>Obtaining the OpenPKG RPMs</title>
            <para>
                Download the OpenPKG RPMs from one of the mirrors listed on <ulink url="http://www.kolab.org/mirrors.html" /> to a local directory:
            </para>
            <procedure id="proc-Installation_Guide-Obtaining_the_OpenPKG_RPMs-Downloading_OpenPKG_RPMs">
                <title>Downloading OpenPKG RPMs</title>
                <step>
                    <para>

<screen>$ <userinput>mkdir -p /tmp/kolab-install/</userinput>
$ <userinput>cd /tmp/kolab-install/</userinput>
$ <userinput>wget -r -l1 -nd --no-parent \</userinput>
    <userinput>http://files.kolab.org/server/release/kolab-server-&PRODUCT_VERSION;/ix86-debian5.0/</userinput></screen>

                    </para>

                </step>
                <step>
                    <para>
                        Optionally verify the integrity of the files downloaded with <emphasis>Pretty Good Privacy</emphasis> (PGP):
                    </para>
                    <para>

<screen>$ <userinput>gpg --keyserver hkp://subkeys.pgp.net --recv-key C43E1A3E</userinput>
$ <userinput>gpg --verify SHA1SUMS.sig</userinput>
$ <userinput>sha1sum -c SHA1SUMS</userinput></screen>

                    </para>

                </step>

            </procedure>

            <para>
                To install using the OpenPKG RPM packages obtained, please;
            </para>
            <procedure id="proc-Installation_Guide-Obtaining_the_OpenPKG_RPMs-Installation_Using_OpenPKG_RPM_Packages">
                <title>Installation Using OpenPKG RPM Packages</title>
                <step>
                    <para>
                        Become the root superuser or otherwise obtain superuser privileges.
                    </para>

                </step>
                <step>
                    <para>
                        Navigate into the directory containing the OpenPKG RPM packages:
                    </para>
                    <para>

<screen># <userinput>cd /tmp/kolab-install/</userinput></screen>

                    </para>

                </step>
                <step>
                    <para>
                        Execute the <filename>install-kolab.sh</filename> script:
                    </para>
                    <para>

<screen># <userinput>sh install-kolab.sh 2&gt;&amp;1 | tee kolab-install.log</userinput></screen>

                    </para>

                </step>

            </procedure>


        </section>


    </section>

    <section id="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_APT_Packages">
        <title>Installation with APT Packages</title>
        <para>
            APT pakages are provided for the following GNU/Linux distributions, and distribution versions:
        </para>
        <para>
            <itemizedlist>
                <listitem>
                    <formalpara id="form-Installation_Guide-Installation_with_APT_Packages-Debian">
                        <title>Debian</title>
                        <para>
                            <simplelist>
                                <member>Lenny (Debian 4.0), until approximately Q1 2012</member>
                                <member>Squeeze (Debian 5.0), until approximately Q1 2014</member>

                            </simplelist>

                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Installation_Guide-Installation_with_APT_Packages-Ubuntu">
                        <title>Ubuntu</title>
                        <para>
                            Lucid, Maverick, Natty
                        </para>

                    </formalpara>

                </listitem>

            </itemizedlist>

        </para>
        <remark>This should really be a table, and include version numbers as well as EOL dates</remark>
        <section id="sect-Installation_Guide-Installation_with_APT_Packages-Debian">
            <title>Debian</title>
            <procedure>
                <step>
                    <para>
                        For the public, community version of Kolab &PRODUCT_VERSION; software packages for Debian Squeeze, add the following two lines to <filename>/etc/apt/sources.list</filename>:
                    </para>
                    <para>

<screen>deb http://mirror.kolabsys.com/pub/debian/kolab-&PRODUCT_VERSION;/ squeeze release updates
deb-src http://mirror.kolabsys.com/pub/debian/kolab-&PRODUCT_VERSION;/ squeeze release updates</screen>

                    </para>
                    <important>
                        <title>Debian Volatile (Updates) Repositories</title>
                        <para>
                            It is critically important to consider also enabling the so-called volatile repository for your Debian version, to enable updates for components such as <application>clamav</application>.
                        </para>
                        <para>
                            To enable the volatile repository for Debian Lenny, include the following line in <filename>/etc/apt/sources.list</filename>:
                        </para>
                        <para>

<screen>deb http://volatile.debian.org/debian-volatile stable/volatile main</screen>

                        </para>

                    </important>

                </step>
                <step>
                    <para>
                        To ensure the Kolab packages have priority over the Debian packages, such as must be the case for PHP as well as Cyrus IMAP, please make sure the APT preferences <emphasis>pin</emphasis> the mirror.kolabsys.com origin as a preferred source. Put the following in <filename>/etc/apt/preferences</filename>:
                    </para>
                    <para>

<screen>Package: *
Pin: origin mirror.kolabsys.com
Pin-Priority: 501</screen>

                    </para>

                </step>
                <step>
                    <para>
                        Start the installation of the base package as follows:
                    </para>
                    <para>

<screen># <userinput>apt-get install kolabd</userinput></screen>

                    </para>

                </step>
                <step>
                    <para>
                        When asked to confirm you want to install the package and its dependencies, press Enter.
                    </para>

                </step>
                <step>
                    <para>
                        When asked to confirm you want to continue installing the packages of which the integrity nor source can be securely verified, press y then Enter.
                    </para>

                </step>

            </procedure>


        </section>

        <section id="sect-Installation_Guide-Installation_with_APT_Packages-Ubuntu">
            <title>Ubuntu</title>
            <procedure>
                <step>
                    <para>
                        For the public, community version of Kolab &PRODUCT_VERSION; software packages for Ubuntu Natty, add the following two lines to <filename>/etc/apt/sources.list</filename>:
                    </para>
                    <para>

<screen>deb http://mirror.kolabsys.com/pub/ubuntu/kolab-&PRODUCT_VERSION;/ natty release updates
deb-src http://mirror.kolabsys.com/pub/ubuntu/kolab-&PRODUCT_VERSION;/ natty release updates</screen>

                    </para>

                </step>
                <step>
                    <para>
                        To ensure the Kolab packages have priority over the Ubuntu packages, such as must be the case for PHP as well as Cyrus IMAP, please make sure the APT preferences <emphasis>pin</emphasis> the mirror.kolabsys.com origin as a preferred source. Put the following in <filename>/etc/apt/preferences</filename>:
                    </para>
                    <para>

<screen>Package: *
Pin: origin mirror.kolabsys.com
Pin-Priority: 501</screen>

                    </para>

                </step>

            </procedure>


        </section>

        <section id="sect-Installation_Guide-Installation_with_APT_Packages-Troubleshooting_the_APT_Package_Manager">
            <title>Troubleshooting the APT Package Manager</title>
            <section id="sect-Installation_Guide-Troubleshooting_the_APT_Package_Manager-Broken_Packages">
                <title>Broken Packages</title>
                <para>
                    If you get an error similar to, for example:
                </para>
                <para>

<screen>test90-1:~# apt-get install kolabd
Reading package lists... Done
Building dependency tree
Reading state information... Done
Some packages could not be installed. This may mean that you have
requested an impossible situation or if you are using the unstable
distribution that some required packages have not yet been created
or been moved out of Incoming.
The following information may help to resolve the situation:

The following packages have unmet dependencies:
 kolabd:    Depends: postfix (&gt;= 2.4) but it is not going to be installed
            Depends: postfix-ldap (&gt;= 2.4) but it is not going to be installed
E: Broken packages</screen>

                </para>
                <para>
                    The error is not caused by broken packages, but a broken package manager that cannot install <application>exim</application> and <application>postfix</application> in parallel.
                </para>
                <formalpara id="form-Installation_Guide-Broken_Packages-Solution">
                    <title>Solution</title>
                    <para>
                        First remove any non-postfix MTA you may have installed, which in a default Debian installation is probably <application>exim</application>.
                    </para>

                </formalpara>
                <para>
                    To remove <application>exim</application>, execute the following with superuser privileges:
                </para>
                <para>

<screen># <userinput>apt-get remove exim4 exim4-base exim4-config exim4-daemon-light</userinput></screen>

                </para>
                <para>
                    Then continue installing Kolab:
                </para>
                <para>

<screen># <userinput>apt-get install kolabd</userinput></screen>

                </para>

            </section>


        </section>


    </section>

    <section id="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_RPM_Packages">
        <title>Installation with RPM Packages</title>
        <para>
            RPM packages are being provided for the following Linux distributions and versions:
        </para>
        <para>
            <itemizedlist>
                <listitem>
                    <formalpara id="form-Installation_Guide-Installation_with_RPM_Packages-CentOS">
                        <title>CentOS</title>
                        <para>
                            <simplelist>
                                <member>CentOS 5, until approximately Q1 2014</member>
                                <member>CentOS 6, until approximately Q4 2017</member>

                            </simplelist>

                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Installation_Guide-Installation_with_RPM_Packages-Fedora">
                        <title>Fedora</title>
                        <para>
                            As Fedora is a development platform, and not a server platform, it suffices to say all current versions of Fedora are supported for as long as the lifecycle of the Fedora distribution lasts (e.g. approximately 13 months).
                        </para>

                    </formalpara>

                </listitem>
                <listitem>
                    <formalpara id="form-Installation_Guide-Installation_with_RPM_Packages-Red_Hat_Enterprise_Linux">
                        <title>Red Hat Enterprise Linux</title>
                        <para>
                            <simplelist>
                                <member>Red Hat Enterprise Linux 5 (Tikanga), until approximately Q1 2014</member>
                                <member>Red Hat Enterprise Linux 6 (Santiago), until approximately Q4 2017</member>

                            </simplelist>

                        </para>

                    </formalpara>

                </listitem>

            </itemizedlist>

        </para>
        <section id="sect-Installation_Guide-Installation_with_RPM_Packages-CentOS">
            <title>CentOS</title>
            <para>
                For the instructions on installing Kolab on CentOS, please refer to the instructions in <xref linkend="sect-Installation_Guide-Installation_with_RPM_Packages-Red_Hat_Enterprise_Linux" />.
            </para>

        </section>

        <section id="sect-Installation_Guide-Installation_with_RPM_Packages-Red_Hat_Enterprise_Linux">
            <title>Red Hat Enterprise Linux</title>
            <para>
                The Kolab software repositories for Red Hat Enterprise Linux ship two so-called <literal>-release</literal> packages. The <literal>kolab-&PRODUCT_VERSION;-community-release</literal> package contains the configuration for the stable software channels, e.g. <emphasis>release</emphasis> and <emphasis>updates</emphasis>.
            </para>
            <para>
                Depending on the version of Red Hat Enterprise Linux, install the following package:
            </para>
            <para>
                <itemizedlist>
                    <listitem>
                        <para>
                            <ulink url="http://mirror.kolabsys.com/pub/redhat/kolab-/el5/development/x86_64/kolab--community-release-5-6.el5.kolab.noarch.rpm">Enterprise Linux 5</ulink>
                        </para>

                    </listitem>

                </itemizedlist>

            </para>
            <para>
                To test the installation of the repository configuration, please execute:
            </para>
            <para>

<screen># <userinput>yum repolist</userinput>
(...snip...)
kolab-&PRODUCT_VERSION;
kolab-&PRODUCT_VERSION;-updates
(...snip...)</screen>

            </para>
            <para>
                Note that the output is abbreviated for clarity. The output may actually include the description of the repository, and the number of packages available. Optionally, to see which repositories have been configured though not enabled, also execute:
            </para>
            <para>

<screen># <userinput>yum repolist all</userinput>
(...snip...)
kolab-&PRODUCT_VERSION;
kolab-&PRODUCT_VERSION;-debuginfo
kolab-&PRODUCT_VERSION;-source
kolab-&PRODUCT_VERSION;-updates
kolab-&PRODUCT_VERSION;-updates-debuginfo
kolab-&PRODUCT_VERSION;-updates-source
kolab-&PRODUCT_VERSION;-updates-testing
kolab-&PRODUCT_VERSION;-updates-testing-debuginfo
kolab-&PRODUCT_VERSION;-updates-testing-source
(...snip...)</screen>

            </para>
            <para>
                Note that the output is abbreviated for clarity. The output may actually include the description of the repository, whether the repository is enabled by default or not, and the number of packages available.
            </para>

        </section>

        <section id="sect-Installation_Guide-Installation_with_RPM_Packages-Fedora">
            <title>Fedora</title>
            <para>
                para
            </para>

        </section>


    </section>


</chapter>