diff --git a/source/conf.py b/source/conf.py --- a/source/conf.py +++ b/source/conf.py @@ -419,8 +419,8 @@ .. |K16| replace:: :orange:`Kolab 16` .. |KE14| replace:: :orange:`Kolab Enterprise 14` .. |KE13| replace:: :orange:`Kolab Enterprise 13` -.. |ReleaseProduction| replace:: :orange:`Kolab Enterprise 14` -.. |ReleaseCurrent| replace:: :orange:`Kolab 16.0` +.. |ReleaseProduction| replace:: :orange:`Kolab 16` +.. |ReleaseCurrent| replace:: :orange:`Kolab 16` """ # diff --git a/source/installation-guide/centos-7.rst b/source/installation-guide/centos-7.rst --- a/source/installation-guide/centos-7.rst +++ b/source/installation-guide/centos-7.rst @@ -4,9 +4,14 @@ Installation of Kolab 16 on CentOS 7 ==================================== -The installation of Kolab Groupware on CentOS installs -a number of additional packages, from the :term:`EPEL` software -repository. +.. WARNING:: + + This document sets you up with the version of Kolab that is maintained by + the community. Customers of `Kolab Systems AG`_ join us + :ref:`here `. + +The installation of Kolab Groupware on CentOS installs a number of additional +packages, from the :term:`EPEL` software repository. Installation Procedure ====================== diff --git a/source/installation-guide/debian-8.rst b/source/installation-guide/debian-8.rst new file mode 100644 --- /dev/null +++ b/source/installation-guide/debian-8.rst @@ -0,0 +1,50 @@ +.. _installation-guide-debian-8: + +==================================== +Installation of Kolab 16 on Debian 8 +==================================== + +.. WARNING:: + + This document sets you up with the version of Kolab that is maintained by + the community. Customers of `Kolab Systems AG`_ join us + :ref:`here `. + +1. Add the following two lines to ``/etc/apt/sources.list.d/kolab.list``: + + .. parsed-literal:: + + deb http://obs.kolabsys.com/repositories/Kolab:/16/Debian_8.0/ ./ + deb-src http://obs.kolabsys.com/repositories/Kolab:/16/Debian_8.0/ ./ + +2. Import the GPG key used to sign the packages: + + .. parsed-literal:: + + # :command:`wget -q -O- https://ssl.kolabsys.com/community.asc | apt-key add -` + +3. 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 pin the obs.kolabsys.com origin as a preferred source. + + Put the following in ``/etc/apt/preferences.d/kolab``: + + .. parsed-literal:: + + Package: * + Pin: origin obs.kolabsys.com + Pin-Priority: 501 + +4. Update the repository metadata: + + .. parsed-literal:: + + # :command:`apt-get update` + +5. Start the installation of the base package as follows: + + .. parsed-literal:: + + # :command:`aptitude -y install kolab` + +Continue to :ref:`installation-guide-setup-kolab`. diff --git a/source/installation-guide/index.rst b/source/installation-guide/index.rst --- a/source/installation-guide/index.rst +++ b/source/installation-guide/index.rst @@ -16,35 +16,38 @@ Current Release =============== -The most recent version of Kolab is |ReleaseCurrent|. +The most recent version of Kolab is |ReleaseCurrent|. The community is working +supercede this release by :orange:`Kolab 17` by the end of Q1 2017. -This is a preview release appropriate for pilot projects, testing, and development. -It is not recommended for production deployments at this time. You can help |K16| reach -production readiness by using |ReleaseCurrent|, keeping it up to date, and -`reporting issues <../contributor-guide/bug-reporting-casual.html>`_ you may encounter. +The current recommended version for supported production deployments is +|ReleaseProduction|. -The current recommended version for production deployment is |ReleaseProduction|. +The release of :orange:`Kolab 17` will occur in Q1 of 2017, at which point +|ReleaseProduction| will no longer be supported by the community, and +`Kolab Systems AG`_ takes over long-term support for its customers. -The release of Kolab 16.1 will occur in Q2 of 2016, at which point Kolab 16 will be -upgraded to "gold" status and become the recommended release for production installations. -Subscription-based support from `Kolab Systems AG`_ will also be available for Kolab 16.1. +We expect that :orange:`Kolab 17` will be upgraded to "gold" status in Q2 2017, +and become the release for production installations. Subscription-based +support from `Kolab Systems AG`_ will also be available for :orange:`Kolab 17`. For subscription-based support of Kolab installations, please visit `Kolab Enterprise `_, -which offers services for all sizes of business, government, NGO, and educational -organizations. You can read about the advantages of Kolab subscription here: :ref:`advantages-of-subscription` +which offers services for all sizes of business, government, NGO, and +educational organizations. You can read about the +:ref:`advantages of a Kolab subscription `. Installing the Kolab Groupware Solution ======================================= -Install the latest version of the Kolab Groupware solution for one -of the following platforms: +Install the latest version of the Kolab Groupware solution for one of the +following platforms: .. toctree:: :maxdepth: 1 centos-7 rhel-7 + debian-8 If your personal favorite is not listed, please read the "`Support Your Distribution, or else ... `_" @@ -62,13 +65,14 @@ .. toctree:: :maxdepth: 1 - kolab-14/index + kolab-16/index .. rubric:: Older versions of Kolab Enterprise .. toctree:: :maxdepth: 1 + kolab-14/index kolab-13/index Installing the Kolab Desktop Client diff --git a/source/installation-guide/kolab-16/centos-7.rst b/source/installation-guide/kolab-16/centos-7.rst new file mode 100644 --- /dev/null +++ b/source/installation-guide/kolab-16/centos-7.rst @@ -0,0 +1,77 @@ +.. _installation-guide-centos-7-enterprise-16: + +==================================== +Installation of Kolab 16 on CentOS 7 +==================================== + +The installation of Kolab Groupware on Red Hat Enterprise Linux installs +a number of additional packages, from the :term:`EPEL` software +repository, and the repositories for the Kolab Enterprise edition, +provided by `Kolab Systems AG`_. + +Installation Procedure +====================== + +1. Copy the client SSL certificate and key you have obtained from + `Kolab Systems AG`_ as per the instructions listed on [#]_, + summarized here for your convenience: + + #. Remove the passphrase from the SSL certificate key: + + .. parsed-literal:: + + # :command:`openssl rsa -in /path/to/private.key \\ + -out /path/to/private.key.nopass` + + #. Concatenate the certificate file and the new key file without + passphrase: + + .. parsed-literal:: + + # :command:`cat /path/to/public.crt /path/to/private.key.nopass \\ + > /path/to/mirror.kolabsys.com.client.pem` + + #. Place the file :file:`mirror.kolabsys.com.ca.cert` in + :file:`/etc/pki/tls/certs/`. + + #. Place the file :file:`mirror.kolabsys.client.pem` in + :file:`/etc/pki/tls/private/`, and correct the permissions: + + .. parsed-literal:: + + # :command:`chown root:root /etc/pki/tls/private/mirror.kolabsys.com.client.pem` + # :command:`chmod 640 /etc/pki/tls/private/mirror.kolabsys.com.client.pem` + +2. Install the :term:`EPEL` repository" + + .. parsed-literal:: + + # :command:`rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm` + +3. Import this signature in to the RPM database: + + .. parsed-literal:: + + # :command:`rpm --import https://ssl.kolabsys.com/maipo.asc` + +4. Install the Kolab Enterprise repository configuration package: + + .. parsed-literal:: + + # :command:`yum install https://ssl.kolabsys.com/kolab-16-for-el7.rpm` + +5. Install Kolab Enterprise: + + .. parsed-literal:: + + # :command:`yum install kolab` + +6. Do not forget to also execute :command:`yum update`. + +Continue to :ref:`installation-guide-setup-kolab`. + +.. rubric:: Footnotes + +.. [#] + + https://support.kolabsys.com/Obtaining,_Renewing_and_Using_a_Client_SSL_Certificate#Using_a_Customer_or_Partner_Client_SSL_Certificate. diff --git a/source/installation-guide/kolab-16/debian-8.rst b/source/installation-guide/kolab-16/debian-8.rst new file mode 100644 --- /dev/null +++ b/source/installation-guide/kolab-16/debian-8.rst @@ -0,0 +1,99 @@ +.. _installation-guide-debian-8-enterprise-16: + +============================================= +Installation of Kolab 16 on Debian 8 (Jessie) +============================================= + +1. Install the **apt-transport-https** package: + + .. parsed-literal:: + + # :command:`aptitude -y install apt-transport-https` + +2. Add the following two lines to ``/etc/apt/sources.list.d/kolab.list``: + + .. parsed-literal:: + + deb https://mirror.kolabenterprise.com/debian/kolab-16/ jessie release updates + deb-src https://mirror.kolabenterprise.com/debian/kolab-16/ jessie release updates + +3. 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 pin the mirror.kolabsys.com origin as a preferred source. + + Put the following in ``/etc/apt/preferences.d/kolab``: + + .. parsed-literal:: + + Package: * + Pin: origin mirror.kolabenterprise.com + Pin-Priority: 501 + +4. Install the client certificate and certificate authority files: + + A. Remove the passphrase from the SSL certificate key: + + .. parsed-literal:: + + # :command:`openssl rsa -in /path/to/private.key \\ + -out /path/to/private.key.nopass` + + B. Concatenate the certificate file and the new key file without + passphrase: + + .. parsed-literal:: + + # :command:`cat /path/to/public.crt /path/to/private.key.nopass \\ + > /path/to/mirror.kolabsys.com.client.pem` + + C. Place the file :file:`mirror.kolabsys.client.pem` in + :file:`/etc/apt/certs/`. + + D. Download the kolabenterprice mirror certificate: + + .. parsed-literal:: + + # :command:`cd /etc/apt/certs/` + # :command:`wget https://ssl.kolabsys.com/mirror.kolabenterprise.com.ca.cert` + + E. Correct the permissions on the private key: + + .. parsed-literal:: + + # :command:`chown root:root /etc/apt/certs/mirror.kolabsys.com.client.pem` + # :command:`chmod 640 /etc/apt/certs/mirror.kolabsys.com.client.pem` + +5. Configure **APT** to use the certificates installed in step 4 by + creating a file ``/etc/apt/apt.conf.d/81kolab`` with the following + contents: + + .. parsed-literal:: + + Acquire { + https { + mirror.kolabenterprise.com { + Verify-Peer "true"; + Verify-Host "true"; + CaInfo "/etc/apt/certs/mirror.kolabenterprise.com.ca.cert"; + + SslCert "/etc/apt/certs/mirror.kolabsys.com.client.pem"; + SslKey "/etc/apt/certs/mirror.kolabsys.com.client.pem"; + }; + }; + }; + +6. Update the repository metadata: + + .. parsed-literal:: + + # :command:`apt-get update` + +7. Start the installation of the base package as follows: + + .. parsed-literal:: + + # :command:`aptitude install kolab` + +8. When asked to confirm you want to install the package and its dependencies, press Enter. + +Continue to :ref:`installation-guide-setup-kolab`. diff --git a/source/installation-guide/kolab-16/index.rst b/source/installation-guide/kolab-16/index.rst new file mode 100644 --- /dev/null +++ b/source/installation-guide/kolab-16/index.rst @@ -0,0 +1,11 @@ +.. _installation-guide-kolab-16: + +====================================== +Installation Instructions for Kolab 16 +====================================== + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/source/installation-guide/kolab-16/rhel-7.rst b/source/installation-guide/kolab-16/rhel-7.rst new file mode 100644 --- /dev/null +++ b/source/installation-guide/kolab-16/rhel-7.rst @@ -0,0 +1,77 @@ +.. _installation-guide-rhel-7-enterprise-16: + +====================================================== +Installation of Kolab 16 on Red Hat Enterprise Linux 7 +====================================================== + +The installation of Kolab Groupware on Red Hat Enterprise Linux installs +a number of additional packages, from the :term:`EPEL` software +repository, and the repositories for the Kolab Enterprise edition, +provided by `Kolab Systems AG`_. + +Installation Procedure +====================== + +1. Copy the client SSL certificate and key you have obtained from + `Kolab Systems AG`_ as per the instructions listed on [#]_, + summarized here for your convenience: + + #. Remove the passphrase from the SSL certificate key: + + .. parsed-literal:: + + # :command:`openssl rsa -in /path/to/private.key \\ + -out /path/to/private.key.nopass` + + #. Concatenate the certificate file and the new key file without + passphrase: + + .. parsed-literal:: + + # :command:`cat /path/to/public.crt /path/to/private.key.nopass \\ + > /path/to/mirror.kolabsys.com.client.pem` + + #. Place the file :file:`mirror.kolabsys.com.ca.cert` in + :file:`/etc/pki/tls/certs/`. + + #. Place the file :file:`mirror.kolabsys.client.pem` in + :file:`/etc/pki/tls/private/`, and correct the permissions: + + .. parsed-literal:: + + # :command:`chown root:root /etc/pki/tls/private/mirror.kolabsys.com.client.pem` + # :command:`chmod 640 /etc/pki/tls/private/mirror.kolabsys.com.client.pem` + +2. Install the :term:`EPEL` repository" + + .. parsed-literal:: + + # :command:`rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm` + +3. Import this signature in to the RPM database: + + .. parsed-literal:: + + # :command:`rpm --import https://ssl.kolabsys.com/maipo.asc` + +4. Install the Kolab Enterprise repository configuration package: + + .. parsed-literal:: + + # :command:`yum install https://ssl.kolabsys.com/kolab-16-for-el7.rpm` + +5. Install Kolab Enterprise: + + .. parsed-literal:: + + # :command:`yum --enablerepo=rhel-7-server-optional-rpms install kolab` + +6. Do not forget to also execute :command:`yum update`. + +Continue to :ref:`installation-guide-setup-kolab`. + +.. rubric:: Footnotes + +.. [#] + + https://support.kolabsys.com/Obtaining,_Renewing_and_Using_a_Client_SSL_Certificate#Using_a_Customer_or_Partner_Client_SSL_Certificate. diff --git a/source/installation-guide/rhel-7.rst b/source/installation-guide/rhel-7.rst --- a/source/installation-guide/rhel-7.rst +++ b/source/installation-guide/rhel-7.rst @@ -4,9 +4,14 @@ Installation of Kolab 16 on Red Hat Enterprise Linux 7 ====================================================== -The installation of Kolab Groupware on Red Hat Enterprise Linux installs -a number of additional packages, from the :term:`EPEL` software -repository. +.. WARNING:: + + This document sets you up with the version of Kolab that is maintained by + the community. Customers of `Kolab Systems AG`_ join us + :ref:`here `. + +The installation of Kolab Groupware on Red Hat Enterprise Linux installs a +number of additional packages, from the :term:`EPEL` software repository. Installation Procedure ======================