path: root/Installation_Guide/en-US/Obtaining_Kolab_Software.xml

<?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 packages are provided for the following GNU/Linux distributions, and distribution versions:
        </para>
        <para>
            <table frame="all" id="tabl-Installation_Guide-Installation_with_APT_Packages-APT_Packages_Distribution_Support">
                <title>APT Packages Distribution Support</title>
                <tgroup align="left" cols="5" colsep="1" rowsep="1">
                    <colspec colname="c1"></colspec>
                    <colspec colname="c2"></colspec>
                    <colspec colname="c3"></colspec>
                    <colspec colname="c4"></colspec>
                    <colspec colname="c5" colnum="5"></colspec>
                    <thead>
                        <row>
                            <entry align="center" nameend="c4" namest="c1">
                                Distribution Information
                            </entry>
                            <entry morerows="1">
                                EOS / EOL Date
                            </entry>

                        </row>
                        <row>
                            <entry>
                                Name
                            </entry>
                            <entry>
                                CodeName
                            </entry>
                            <entry>
                                Version
                            </entry>
                            <entry>
                                Architectures
                            </entry>

                        </row>

                    </thead>
                    <!--
                    <tfoot> <row>
                        <entry>
                            f1
                        </entry>
                        <entry>
                            f2
                        </entry>
                        <entry>
                            f3
                        </entry>
                        <entry>
                            f4
                        </entry>
                        <entry>
                            f5
                        </entry>

                    </row>
                    </tfoot>
                    --> <tbody>
                        <row>
                            <entry>
                                Debian
                            </entry>
                            <entry>
                                Lenny
                            </entry>
                            <entry>
                                5.0
                            </entry>
                            <entry>
                                i386, amd64
                            </entry>
                            <entry>
                                T.B.D.
                            </entry>

                        </row>
                        <row>
                            <entry>
                                Debian
                            </entry>
                            <entry>
                                Squeeze
                            </entry>
                            <entry>
                                6.0
                            </entry>
                            <entry>
                                i386, amd64
                            </entry>
                            <entry>
                                T.B.D.
                            </entry>

                        </row>

                    </tbody>

                </tgroup>

            </table>

        </para>
        <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>
                    <note>
                        <title>Disable 'addon' and 'extras' repositories</title>
                        <para>
                            As per the title, centos ships its own version of some of the packages we build.
                        </para>

                    </note>

                </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>
            <procedure id="proc-Installation_Guide-Red_Hat_Enterprise_Linux-Installing_the_kolab_PRODUCT_VERSION_community_release_Package">
                <title>Installing the <application>kolab-&PRODUCT_VERSION;-community-release</application> Package</title>
                <step>
                    <para>
                        Depending on the version of Red Hat Enterprise Linux, install the package as it is listed on the following page:
                    </para>
                    <para>
                        <itemizedlist>
                            <listitem>
                                <para>
                                    <ulink url="http://mirror.kolabsys.com/pub/redhat/kolab-2.3/el5/release/i386/repoview/kolab-2.3-community-release.html">Enterprise Linux 5</ulink>
                                </para>

                            </listitem>

                        </itemizedlist>

                    </para>

                </step>
                <step>
                    <para>
                        Install this package using the following command:
                    </para>
                    <para>

<screen># <userinput>wget http://url/to/rpm</userinput>
<userinput># yum localinstall --nogpgcheck /path/to/rpm</userinput></screen>

                    </para>

                </step>
                <step>
                    <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>
                    <note>
                        <title>Output Abbreviated</title>
                        <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.
                        </para>

                    </note>
                    <para>
                        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>
                    <note>
                        <title>Output Abbreviated</title>
                        <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>

                    </note>

                </step>

            </procedure>

   <para>
       Please consider using <application>yum-priorities</application> as described in <xref linkend="sect-Installation_Guide-Installation_with_RPM_Packages-Using_yum_priorities_to_Avoid_Package_Conflicts" />.
   </para>
        </section>

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

        </section>

        <section id="sect-Installation_Guide-Installation_with_RPM_Packages-Using_yum_priorities_to_Avoid_Package_Conflicts">
            <title>Using <application>yum-priorities</application> to Avoid Package Conflicts</title>
            <para>
                Since any given package may at any time be shipped by the Kolab repositories as well as through the regular distribution repositories, and to avoid switching back and forth between the two different versions continuously, by mistake or by accident, we recommend you use the following procedure including employing YUM repository priorities to smooth out any future problems.
            </para>
            <procedure id="proc-Installation_Guide-Using_yum_priorities_to_Avoid_Package_Conflicts-Installing_and_Configuring_YUM_priorities">
                <title>Installing and Configuring YUM priorities</title>
                <step>
                    <para>
                        The <application>yum-priorities</application> is available from the <ulink url="http://fedoraproject.org/wiki/EPEL">package repository</ulink>. Please install it:
                    </para>
                    <para>

<screen># <userinput>yum install yum-priorities</userinput></screen>

                    </para>

                </step>

            </procedure>


        </section>


    </section>


</chapter>