summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Installation_Manual/en-US/About_Kolab_Groupware.xml28
-rw-r--r--Installation_Manual/en-US/Author_Group.xml18
-rw-r--r--Installation_Manual/en-US/Book_Info.xml28
-rw-r--r--Installation_Manual/en-US/Cyrus_IMAP.xml298
-rw-r--r--Installation_Manual/en-US/Installation_Introduction.xml12
-rw-r--r--Installation_Manual/en-US/Installation_Manual.ent42
-rw-r--r--Installation_Manual/en-US/Installation_Manual.xml21
-rw-r--r--Installation_Manual/en-US/Kolab_Initial_Configuration.xml55
-rw-r--r--Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml151
-rw-r--r--Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml123
-rw-r--r--Installation_Manual/en-US/Kolab_Webclient_Installation.xml21
-rw-r--r--Installation_Manual/en-US/Part-Kolab_Server_Installation.xml16
-rw-r--r--Installation_Manual/en-US/Preface.xml13
-rw-r--r--Installation_Manual/en-US/Preparing_the_System.xml65
-rw-r--r--Installation_Manual/en-US/Revision_History.xml27
-rw-r--r--Installation_Manual/publican.cfg7
-rw-r--r--Makefile8
17 files changed, 931 insertions, 2 deletions
diff --git a/Installation_Manual/en-US/About_Kolab_Groupware.xml b/Installation_Manual/en-US/About_Kolab_Groupware.xml
new file mode 100644
index 0000000..de5f82c
--- /dev/null
+++ b/Installation_Manual/en-US/About_Kolab_Groupware.xml
@@ -0,0 +1,28 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-About_Kolab_Groupware">
+ <title>About Kolab Groupware</title>
+ <para>
+ Kolab is a Groupware Solution for Emails, Appointments, Contacts and more. It supports mixed client environments (Outlook/KDE) because of an open storage format. Any email client speaking standard protocols can be served.
+ </para>
+
+ <section>
+ <title>Free Software Components</title>
+ <para>
+ TODO: Come on, be a little more verbose...
+ </para>
+
+ <section>
+ <title>This documentation</title>
+ <para>
+ Describe how this documentation can be modified to custom, internal documentation
+ </para>
+ </section>
+
+ </section>
+
+</chapter>
+
diff --git a/Installation_Manual/en-US/Author_Group.xml b/Installation_Manual/en-US/Author_Group.xml
new file mode 100644
index 0000000..24ea95e
--- /dev/null
+++ b/Installation_Manual/en-US/Author_Group.xml
@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE authorgroup 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;
+]>
+<authorgroup>
+ <author>
+ <firstname>Jeroen</firstname>
+ <surname>van Meeuwen</surname>
+ <lineage>RHCE</lineage>
+ <affiliation>
+ <orgname>Kolab Systems</orgname>
+ <orgdiv>Engineering</orgdiv>
+ </affiliation>
+ <email>vanmeeuwen@kolabsys.com</email>
+ </author>
+</authorgroup>
+
diff --git a/Installation_Manual/en-US/Book_Info.xml b/Installation_Manual/en-US/Book_Info.xml
new file mode 100644
index 0000000..dcae62d
--- /dev/null
+++ b/Installation_Manual/en-US/Book_Info.xml
@@ -0,0 +1,28 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo 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;
+]>
+<bookinfo id="book-Installation_Manual-Installation_Manual">
+ <title>Installation Manual</title>
+ <subtitle>The Kolab Groupware Solution</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.2.4</productnumber>
+ <edition>1</edition>
+ <pubsnumber>0</pubsnumber>
+ <abstract>
+ <para>
+ A short overview and summary of the book's subject and purpose, traditionally no more than one paragraph long. Note: the abstract will appear in the front matter of your book and will also be placed in the description field of the book's RPM spec file.
+ </para>
+ </abstract>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
+
diff --git a/Installation_Manual/en-US/Cyrus_IMAP.xml b/Installation_Manual/en-US/Cyrus_IMAP.xml
new file mode 100644
index 0000000..6c2e436
--- /dev/null
+++ b/Installation_Manual/en-US/Cyrus_IMAP.xml
@@ -0,0 +1,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>
+
diff --git a/Installation_Manual/en-US/Installation_Introduction.xml b/Installation_Manual/en-US/Installation_Introduction.xml
new file mode 100644
index 0000000..cd361c8
--- /dev/null
+++ b/Installation_Manual/en-US/Installation_Introduction.xml
@@ -0,0 +1,12 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-Installation_Introduction">
+ <title>Installation Introduction</title>
+ <para>
+ Kolab Groupware is not just one big server component. It consists various, well-known, mature Open Source software components.
+ </para>
+</chapter>
+
diff --git a/Installation_Manual/en-US/Installation_Manual.ent b/Installation_Manual/en-US/Installation_Manual.ent
new file mode 100644
index 0000000..4d212d5
--- /dev/null
+++ b/Installation_Manual/en-US/Installation_Manual.ent
@@ -0,0 +1,42 @@
+<!ENTITY PRODUCT "Hosted Kolab">
+<!ENTITY PRODUCT_VERSION "2.2.4">
+<!ENTITY BOOKID "Installation_Manual">
+<!ENTITY YEAR "2010">
+<!ENTITY HOLDER "Kolab Systems AG">
+
+<!--
+ ##
+ ## APT Packaging
+ ##
+//-->
+
+<!ENTITY APT_CYRUS_SYS_DEFAULTS "<filename>/etc/default/cyrus-imapd</filename>">
+
+<!--
+ ##
+ ## OPENPKG Packaging
+ ##
+//-->
+
+<!ENTITY OPENPKG_CYRUS_SYS_DEFAULTS "<filename>/etc/default/cyrus-imapd</filename>">
+
+<!--
+ ##
+ ## RPM Packaging
+ ##
+//-->
+
+<!ENTITY RPM_CYRUS_SYS_DEFAULTS "<filename>/etc/sysconfig/cyrus-imapd</filename>">
+
+<!--
+ ##
+ ## Packaging System Neutral
+ ##
+//-->
+
+<!ENTITY CYRUS_CONFIG "<filename>/etc/cyrus.conf</filename>">
+<!ENTITY CYRUS_IMAPD_CONFIG "<filename>/etc/imapd.conf</filename>">
+<!ENTITY CYRUS_ANNOTATIONS_CONFIG "<filename>/etc/imapd.annotations.conf</filename>">
+<!ENTITY CYRUS_CONFIGDIR "<filename>/var/lib/imap</filename>">
+<!ENTITY CYRUS_SPOOLDIR "<filename>/var/spool/imap</filename>">
+
diff --git a/Installation_Manual/en-US/Installation_Manual.xml b/Installation_Manual/en-US/Installation_Manual.xml
new file mode 100644
index 0000000..dfcb359
--- /dev/null
+++ b/Installation_Manual/en-US/Installation_Manual.xml
@@ -0,0 +1,21 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book 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;
+]>
+<book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+<!--
+ <xi:include href="About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Part-Kolab_Server_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+//-->
+
+ <xi:include href="Kolab_Systems_Software_Repositories.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Cyrus_IMAP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <index />
+</book>
+
diff --git a/Installation_Manual/en-US/Kolab_Initial_Configuration.xml b/Installation_Manual/en-US/Kolab_Initial_Configuration.xml
new file mode 100644
index 0000000..fb08f1c
--- /dev/null
+++ b/Installation_Manual/en-US/Kolab_Initial_Configuration.xml
@@ -0,0 +1,55 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-Kolab_Initial_Configuration">
+ <title>Kolab Initial Configuration</title>
+ <para>
+ para
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Run, as root:
+ </para>
+ <para>
+ <screen># <userinput>setup-kolab.pl</userinput></screen>
+ </para>
+ <para>
+ This will start a configuration dialog.
+ </para>
+ </step>
+ <step>
+ <para>
+ Yet Another Step...
+ </para>
+ </step>
+ </procedure>
+
+ <section>
+ <title>Manual Configuration</title>
+ <para>
+ this section goes to manual configuration of Kolab (this is what setup-kolab.pl should actually be doing)
+ </para>
+<screen>
+after yum install kolab
+copy /etc/kolab/templates/kolab.conf.template to /etc/kolab/kolab.conf
+check out /etc/kolab/kolab.conf
+ - set the fqdn
+ - check
+</screen>
+ </section>
+
+ <section>
+ <title>Configuration through Puppet</title>
+ <para>
+ Assuming that you have an existing Puppet environment, you can clone the <literal>kolab</literal> puppet module:
+ </para>
+ <para>
+ <screen>$ <userinput>git clone git://git.puppetmanaged.org/puppet/kolab</userinput></screen>
+ </para>
+ </section>
+
+</chapter>
+
diff --git a/Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml b/Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml
new file mode 100644
index 0000000..66f9e3b
--- /dev/null
+++ b/Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml
@@ -0,0 +1,151 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-Kolab_Server_on_Enterprise_Linux">
+ <title>Kolab Server on Enterprise Linux</title>
+ <para>
+ The installation of the Kolab Groupware server requires you prepare the system for installation. This part of the installation manual addresses the installation procedure on Enterprise Linux systems, which include:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Red Hat Enterprise Linux 5 (recommended)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ CentOS 5
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <section id="sect-Installation_Manual-Kolab_Server_on_Enterprise_Linux-Prerequisites">
+ <title>Prerequisites</title>
+ <para>
+ This section lists the prerequisites for a Kolab Groupware server system on Enterprise Linux.
+ </para>
+
+ <section>
+ <title>Server System</title>
+ <para>
+ These are the system prerequisites for a supported Kolab server installation on Enterprise Linux.
+ </para>
+ <para>
+ <orderedlist>
+ <title>System Resources</title>
+ <listitem>
+ <para>
+ FIXME: 4GB of RAM
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ FIXME: Intel or AMD 64-bit 2.4Ghz+
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ <orderedlist>
+ <title>Operating System Resources</title>
+ <listitem>
+ <para>
+ The following software packages may not be installed on the Kolab Groupware server system:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>cyrus-imapd</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>openldap</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ You can verify whether any of those packages is installed using the following command:
+ </para>
+ <para>
+ <command>rpm -qv &lt;package-name&gt;</command>
+ </para>
+ <para>
+ Should any of the aforementioned packages be installed on the Kolab Groupware server system already, please verify whether they have been used before removing them. Should the packages have been used, consider moving to Kolab Groupware on this server system a migration and continue with the migration manual available at:
+ </para>
+ <para>
+ FIXME: Provide a URL for the migration manual
+ </para>
+ </section>
+
+ <section>
+ <title>YUM Repositories</title>
+ <para>
+ A Kolab Groupware server system requires the following YUM repositories to be installed in complete, available and enabled;
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ The <ulink url="http://fedoraproject.org/wiki/EPEL">Extra Packages for Enterprise Linux</ulink> (EPEL) repository.
+ </para>
+ <para>
+ For more details on the installation and configuration of the EPEL repository, please refer to <xref linkend="sect-Installation_Manual-Kolab_Server_on_Enterprise_Linux-Repository_Configuration-EPEL" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The Kolab Groupware repository.
+ </para>
+ <para>
+ For more details on the installation and configuration of the Kolab repository, please refer to <xref linkend="sect-Installation_Manual-Kolab_Server_on_Enterprise_Linux-Repository_Configuration-Kolab" />.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Repository Configuration</title>
+
+ <section id="sect-Installation_Manual-Kolab_Server_on_Enterprise_Linux-Repository_Configuration-EPEL">
+ <title>EPEL Repository Configuration</title>
+ <para>
+ FIXME: Something on EPEL repository configuration
+ </para>
+ </section>
+
+ <section id="sect-Installation_Manual-Kolab_Server_on_Enterprise_Linux-Repository_Configuration-Kolab">
+ <title>Kolab Repository Configuration</title>
+ <para>
+ FIXME: Something on Kolab repository configuration
+ </para>
+ </section>
+ </section>
+
+ <section>
+ <title>Standalone Server Installation</title>
+ <para>
+ When the prerequisite requirements are met, install the Kolab Groupware Server components:
+ </para>
+ <para>
+ <command>yum install kolab</command>
+ </para>
+ <para>
+ This will install a completely standalone Kolab Groupware server. Continue to <xref linkend="chap-Installation_Manual-Kolab_Initial_Configuration" />
+ </para>
+ </section>
+
+</chapter>
+
diff --git a/Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml b/Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml
new file mode 100644
index 0000000..847b27a
--- /dev/null
+++ b/Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml
@@ -0,0 +1,123 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-Kolab_Systems_Software_Repositories">
+ <title>Kolab Systems Software Repositories</title>
+ <para>
+ Kolab Systems provides staged repositories for the community and its customers.
+ </para>
+
+ <section id="sect-Installation_Manual-Kolab_Systems_Software_Repositories-Platform_Support">
+ <title>Platform Support</title>
+ <para>
+ TODO: Describe what is supported when using which edition
+ </para>
+ </section>
+
+ <section id="sect-Installation_Manual-Kolab_Systems_Software_Repositories-Configuration">
+ <title>Repository Configuration</title>
+
+ <section>
+ <title>Community Edition</title>
+ <para>
+ TODO: Insert notice about the community edition.
+ </para>
+
+ <section>
+ <title>Debian Squeeze</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>
+ </step>
+ </procedure>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Enterprise Edition</title>
+ <para>
+ TODO: Insert benefit of purchasing subscriptions to enterprise editions.
+ </para>
+ <para>
+ TODO: Insert procedure to <emphasis>obtain</emphasis> mirror client certificate per system, and under what conditions excemptions are being made for a wildcard or customer cert.
+ </para>
+ <para>
+ TODO: Describe exporting and using as browser cert.
+ </para>
+
+ <section>
+ <title>Enterprise Edition on APT-based Systems</title>
+ <para>
+ TODO: Describe the exact procedure to enable the secure communications.
+ </para>
+ <para>
+ TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other.
+ </para>
+ </section>
+
+ <section>
+ <title>Enterprise Edition on RPM-based Systems</title>
+ <para>
+ TODO: Describe the exact procedure to enable the secure communications.
+ </para>
+ <para>
+ TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other.
+ </para>
+ </section>
+
+ <section>
+ <title>Debian Squeeze</title>
+ <procedure>
+ <step>
+ <para>
+ For the supported, certified enterprise 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/debian/kolab-&PRODUCT_VERSION;/ squeeze release updates
+deb-src http://mirror.kolabsys.com/debian/kolab-&PRODUCT_VERSION;/ squeeze release updates</screen>
+ </para>
+ </step>
+ </procedure>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Red Hat Enterprise Linux 5</title>
+ <procedure>
+ <step>
+ <para>
+ Obtain the <application>-release</application>
+ </para>
+ </step>
+ <step>
+ <para>
+ TODO: Security and Integrity verification instructions
+ </para>
+ </step>
+ <step>
+ <para>
+ TODO: Install instructions
+ </para>
+ </step>
+ <step>
+ <para>
+ Verification instructions
+ </para>
+ </step>
+ </procedure>
+ </section>
+
+ </section>
+
+</chapter>
+
diff --git a/Installation_Manual/en-US/Kolab_Webclient_Installation.xml b/Installation_Manual/en-US/Kolab_Webclient_Installation.xml
new file mode 100644
index 0000000..0b8b0db
--- /dev/null
+++ b/Installation_Manual/en-US/Kolab_Webclient_Installation.xml
@@ -0,0 +1,21 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-Kolab_Webclient_Installation">
+ <title>Kolab Webclient Installation</title>
+ <para>
+ para
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ how to configure the webserver to show the web interface over SSL only
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+</chapter>
+
diff --git a/Installation_Manual/en-US/Part-Kolab_Server_Installation.xml b/Installation_Manual/en-US/Part-Kolab_Server_Installation.xml
new file mode 100644
index 0000000..4c621cb
--- /dev/null
+++ b/Installation_Manual/en-US/Part-Kolab_Server_Installation.xml
@@ -0,0 +1,16 @@
+<?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-Kolab_Server_Installation">
+ <title>Kolab Groupware Server Installation</title>
+ <subtitle>Installation Manual for Kolab Groupware on server systems</subtitle>
+
+ <xi:include href="Installation_Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Kolab_Server_on_Enterprise_Linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Kolab_Initial_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Kolab_Webclient_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</part> \ No newline at end of file
diff --git a/Installation_Manual/en-US/Preface.xml b/Installation_Manual/en-US/Preface.xml
new file mode 100644
index 0000000..3737a00
--- /dev/null
+++ b/Installation_Manual/en-US/Preface.xml
@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE preface 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;
+]>
+<preface id="pref-Installation_Manual-Preface">
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </xi:fallback>
+ </xi:include>
+</preface>
+
diff --git a/Installation_Manual/en-US/Preparing_the_System.xml b/Installation_Manual/en-US/Preparing_the_System.xml
new file mode 100644
index 0000000..0cac0f8
--- /dev/null
+++ b/Installation_Manual/en-US/Preparing_the_System.xml
@@ -0,0 +1,65 @@
+<?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;
+]>
+<chapter id="chap-Installation_Manual-Preparing_the_System">
+ <title>Preparing the System</title>
+ <para>
+ The installation of Kolab requires you prepare the system for installation.
+ </para>
+
+ <section id="sect-Installation_Manual-Preparing_the_System-Prerequisites">
+ <title>Prerequisites</title>
+ <para>
+ The installation of Kolab requires one of the following operating system versions:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Red Hat Enterprise Linux 5, see also <xref linkend="sect-Installation_Manual-Preparing_the_System-Enterprise_Linux" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ FIXME: Other supported Operating System versions
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="sect-Installation_Manual-Recommendations">
+ <title>Recommendations</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ We recommend a x86_64 capable version of the Operating System
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="sect-Installation_Manual-Preparing_the_System-Enterprise_Linux">
+ <title>Enterprise Linux</title>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ No user or group with ID 412 may exist on the system prior to the installation of Kolab.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ No user or group with the name <literal>kolab</literal> may exist on the system prior to the installation of Kolab.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </section>
+
+</chapter>
+
diff --git a/Installation_Manual/en-US/Revision_History.xml b/Installation_Manual/en-US/Revision_History.xml
new file mode 100644
index 0000000..f0435f0
--- /dev/null
+++ b/Installation_Manual/en-US/Revision_History.xml
@@ -0,0 +1,27 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix 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;
+]>
+<appendix id="appe-Installation_Manual-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Sun May 16 2010</date>
+ <author>
+ <firstname>Dude</firstname>
+ <surname>McPants</surname>
+ <email>Dude.McPants@example.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
+
diff --git a/Installation_Manual/publican.cfg b/Installation_Manual/publican.cfg
new file mode 100644
index 0000000..e2e32bf
--- /dev/null
+++ b/Installation_Manual/publican.cfg
@@ -0,0 +1,7 @@
+# Config::Simple 4.59
+# Sun May 16 16:49:38 2010
+
+xml_lang: en-US
+type: Book
+brand: common
+
diff --git a/Makefile b/Makefile
index d7fe945..2f15b3d 100644
--- a/Makefile
+++ b/Makefile
@@ -6,13 +6,17 @@ BUILD_LANGS="en-US"
SRCDIR :=$(shell pwd)
+PRODUCT_NORMALIZED := $(shell echo $(PRODUCT) | sed -e 's/ /_/g')
+
all: clean
@mkdir builds
@sed -i -r \
-e 's|ENTITY PRODUCT_VERSION "([\.0-9]+)"|ENTITY PRODUCT_VERSION "$(VERSION)"|g' \
-e 's|productnumber>([\.0-9]+)</productnumber|productnumber>$(VERSION)</productnumber|g' \
+ -e 's|ENTITY PRODUCT "([a-zA-Z\.0-9]+)"|ENTITY PRODUCT "$(PRODUCT)"|g' \
+ -e 's|productname>([\.0-9]+)</productname|productame>$(PRODUCT)</productname|g' \
`find -type f -name "Book_Info.xml" -or -name "*.ent"`
- for dir in `find -mindepth 1 -maxdepth 1 -type d -exec basename {} \; | sort`; do \
+ @for dir in `find -mindepth 1 -maxdepth 1 -type d -exec basename {} \; | sort`; do \
if [ -f "$$dir/publican.cfg" ]; then \
cd $$dir; \
publican build \
@@ -24,7 +28,7 @@ all: clean
[ "`basename $$build`" == "xml_tmp" ] && continue; \
lang=`echo $$build | awk -F'/' '{print $$2}'`; \
format=`echo $$build | awk -F'/' '{print $$3}'`; \
- cp -a $$build $(SRCDIR)/builds/$(PRODUCT)-$(VERSION)-$$dir-$$lang.$$format; \
+ cp -a $$build $(SRCDIR)/builds/$(PRODUCT_NORMALIZED)-$(VERSION)-$$dir-$$lang.$$format; \
done; \
cd ../; \
fi; \