summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2011-01-05 23:42:56 (GMT)
committerJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2011-01-05 23:42:56 (GMT)
commit4d849a6e64d30d8d1f29b8d82f87f692d617069b (patch)
treea827a49c142cd188f3677586d7f10941b24f9874
parent090f09897fa635c5b844fc7046fb1eaa6e181adb (diff)
downloadkolab-docs-4d849a6e64d30d8d1f29b8d82f87f692d617069b.tar.gz
Updates to the documentation
-rw-r--r--.gitignore7
-rw-r--r--Administrator_Guide/Makefile17
-rw-r--r--Administrator_Guide/en-US/Administrator_Guide.ent4
-rw-r--r--Administrator_Guide/en-US/Administrator_Guide.xml13
-rw-r--r--Administrator_Guide/en-US/Author_Group.xml19
-rw-r--r--Administrator_Guide/en-US/Book_Info.xml31
-rw-r--r--Administrator_Guide/en-US/Chapter.xml39
-rw-r--r--Administrator_Guide/en-US/Preface.xml12
-rw-r--r--Administrator_Guide/en-US/Revision_History.xml33
-rw-r--r--Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml30
-rw-r--r--Administrator_Guide/en-US/images/icon.svg19
-rw-r--r--Administrator_Guide/publican.cfg7
-rw-r--r--Common_Content/en-US/Author_Group.xml18
-rw-r--r--Deployment_Guide/Makefile17
-rw-r--r--Deployment_Guide/en-US/Author_Group.xml6
-rw-r--r--Deployment_Guide/en-US/Book_Info.xml43
-rw-r--r--Deployment_Guide/en-US/Deployment_Guide.xml2
-rw-r--r--Deployment_Guide/en-US/Infrastructure.xml12
-rw-r--r--Deployment_Guide/en-US/Kolab_Preparations.xml12
-rw-r--r--Deployment_Guide/en-US/LDAP_Installation.xml16
-rw-r--r--Deployment_Guide/en-US/Preface.xml16
-rw-r--r--Deployment_Guide/en-US/Revision_History.xml44
-rw-r--r--Development_Manual/Makefile17
-rw-r--r--Development_Manual/en-US/Author_Group.xml7
-rw-r--r--Development_Manual/en-US/Book_Info.xml43
-rw-r--r--Development_Manual/en-US/Chapter.xml54
-rw-r--r--Development_Manual/en-US/Development_Manual.xml9
-rw-r--r--Development_Manual/en-US/Development_Processes.xml39
-rw-r--r--Development_Manual/en-US/Documentation.xml16
-rw-r--r--Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml5
-rw-r--r--Development_Manual/en-US/Localization_and_Internationalization.xml23
-rw-r--r--Development_Manual/en-US/Packaging_Kolab_Components.xml13
-rw-r--r--Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml73
-rw-r--r--Development_Manual/en-US/Packaging_with_APT.xml361
-rw-r--r--Development_Manual/en-US/Packaging_with_RPM.xml93
-rw-r--r--Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml6
-rw-r--r--Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml11
-rw-r--r--Development_Manual/en-US/Preface.xml9
-rw-r--r--Development_Manual/en-US/Revision_History.xml44
-rw-r--r--Development_Manual/en-US/TODO.xml20
-rw-r--r--Installation_Guide/Makefile17
-rw-r--r--Installation_Guide/en-US/About_Kolab_Groupware.xml12
-rw-r--r--Installation_Guide/en-US/Author_Group.xml5
-rw-r--r--Installation_Guide/en-US/Book_Info.xml9
-rw-r--r--Installation_Guide/en-US/Cyrus_IMAP.xml155
-rw-r--r--Installation_Guide/en-US/Installation_Guide.xml13
-rw-r--r--Installation_Guide/en-US/Installation_Introduction.xml2
-rw-r--r--Installation_Guide/en-US/Kolab_Initial_Configuration.xml21
-rw-r--r--Installation_Guide/en-US/Kolab_Server_on_Enterprise_Linux.xml57
-rw-r--r--Installation_Guide/en-US/Kolab_Systems_Software_Repositories.xml59
-rw-r--r--Installation_Guide/en-US/Kolab_Webclient_Installation.xml5
-rw-r--r--Installation_Guide/en-US/Obtaining_Kolab_Software.xml362
-rw-r--r--Installation_Guide/en-US/Part-Kolab_Server_Installation.xml9
-rw-r--r--Installation_Guide/en-US/Preface.xml11
-rw-r--r--Installation_Guide/en-US/Preparing_the_System.xml26
-rw-r--r--Installation_Guide/en-US/Revision_History.xml46
-rw-r--r--Installation_Guide/publican.cfg1
-rw-r--r--Makefile50
58 files changed, 1671 insertions, 449 deletions
diff --git a/.gitignore b/.gitignore
index 454f39e..a8c9410 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,8 @@
*/tmp/
+!Common_Content/*/sect-About_Kolab_Groupware.xml
+!Common_Content/*/sect-Feedback.xml
+!Common_Content/*/sect-Supported_Platforms_and_System_Requirements.xml
+*/*/sect-About_Kolab_Groupware.xml
+*/*/sect-Feedback.xml
+*/*/sect-Supported_Platforms_and_System_Requirements.xml
+
diff --git a/Administrator_Guide/Makefile b/Administrator_Guide/Makefile
new file mode 100644
index 0000000..eeffdbb
--- /dev/null
+++ b/Administrator_Guide/Makefile
@@ -0,0 +1,17 @@
+PACKAGE = "Administrator_Guide"
+
+all: clean clean_ids
+ @publican build --langs=en-US --formats=html,html-single,pdf
+ @rsync -aHvz tmp/en-US/{html,html-single,pdf} hosted.kolabsys.com:./public_html/kolab-2.3-docs/$(PACKAGE)/
+
+clean:
+ @publican clean
+
+clean_ids:
+ @cp -a ../Common_Content/en-US/*.xml en-US/.
+ @publican clean_ids
+ @sed -i -r \
+ -e 's/\t/ /g' \
+ -e 's/((\s{4})+)\s*/\1/g' \
+ -e 's/\s*$$//g' \
+ `find en-US/ -type f -name "*.xml"`
diff --git a/Administrator_Guide/en-US/Administrator_Guide.ent b/Administrator_Guide/en-US/Administrator_Guide.ent
new file mode 100644
index 0000000..13bc64e
--- /dev/null
+++ b/Administrator_Guide/en-US/Administrator_Guide.ent
@@ -0,0 +1,4 @@
+<!ENTITY PRODUCT "Kolab">
+<!ENTITY BOOKID "Administrator_Guide">
+<!ENTITY YEAR "2010">
+<!ENTITY HOLDER "| You need to change the HOLDER entity in the en-US/Administrator_Guide.ent file |">
diff --git a/Administrator_Guide/en-US/Administrator_Guide.xml b/Administrator_Guide/en-US/Administrator_Guide.xml
new file mode 100644
index 0000000..2056103
--- /dev/null
+++ b/Administrator_Guide/en-US/Administrator_Guide.xml
@@ -0,0 +1,13 @@
+<?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 "Administrator_Guide.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="Chapter.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/Administrator_Guide/en-US/Author_Group.xml b/Administrator_Guide/en-US/Author_Group.xml
new file mode 100644
index 0000000..41e245a
--- /dev/null
+++ b/Administrator_Guide/en-US/Author_Group.xml
@@ -0,0 +1,19 @@
+<?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 "Administrator_Guide.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/Administrator_Guide/en-US/Book_Info.xml b/Administrator_Guide/en-US/Book_Info.xml
new file mode 100644
index 0000000..8caca5b
--- /dev/null
+++ b/Administrator_Guide/en-US/Book_Info.xml
@@ -0,0 +1,31 @@
+<?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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<bookinfo id="book-Administrator_Guide-Administrator_Guide">
+ <title>Administrator Guide</title>
+ <subtitle>short description</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.3</productnumber>
+ <edition>0</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/Administrator_Guide/en-US/Chapter.xml b/Administrator_Guide/en-US/Chapter.xml
new file mode 100644
index 0000000..f9ce360
--- /dev/null
+++ b/Administrator_Guide/en-US/Chapter.xml
@@ -0,0 +1,39 @@
+<?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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Administrator_Guide-Test_Chapter">
+ <title>Test Chapter</title>
+ <para>
+ This is a test paragraph
+ </para>
+ <section id="sect-Administrator_Guide-Test_Chapter-Test_Section_1">
+ <title>Test Section 1</title>
+ <para>
+ This is a test paragraph in a section
+ </para>
+
+ </section>
+
+ <section id="sect-Administrator_Guide-Test_Chapter-Test_Section_2">
+ <title>Test Section 2</title>
+ <para>
+ This is a test paragraph in Section 2
+ <orderedlist>
+ <listitem>
+ <para>
+ listitem text
+ </para>
+
+ </listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </section>
+
+
+</chapter>
+
diff --git a/Administrator_Guide/en-US/Preface.xml b/Administrator_Guide/en-US/Preface.xml
new file mode 100644
index 0000000..c9e647e
--- /dev/null
+++ b/Administrator_Guide/en-US/Preface.xml
@@ -0,0 +1,12 @@
+<?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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<preface id="pref-Administrator_Guide-Preface">
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</preface>
+
diff --git a/Administrator_Guide/en-US/Revision_History.xml b/Administrator_Guide/en-US/Revision_History.xml
new file mode 100644
index 0000000..a75c98d
--- /dev/null
+++ b/Administrator_Guide/en-US/Revision_History.xml
@@ -0,0 +1,33 @@
+<?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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="appe-Administrator_Guide-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0-0</revnumber>
+ <date>Mon Dec 13 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/Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml b/Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml
new file mode 100644
index 0000000..39c850a
--- /dev/null
+++ b/Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml
@@ -0,0 +1,30 @@
+<?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 "Administrator_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Administrator_Guide-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 id="sect-Administrator_Guide-About_Kolab_Groupware-Free_Software_Components">
+ <title>Free Software Components</title>
+ <para>
+ TODO: Come on, be a little more verbose...
+ </para>
+ <section id="sect-Administrator_Guide-Free_Software_Components-This_documentation">
+ <title>This documentation</title>
+ <para>
+ Describe how this documentation can be modified to custom, internal documentation
+ </para>
+
+ </section>
+
+
+ </section>
+
+ <xi:include href="sect-Supported_Platforms_and_System_Requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</chapter>
+
diff --git a/Administrator_Guide/en-US/images/icon.svg b/Administrator_Guide/en-US/images/icon.svg
new file mode 100644
index 0000000..b2f16d0
--- /dev/null
+++ b/Administrator_Guide/en-US/images/icon.svg
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0" width="32" height="32" id="svg3017">
+ <defs id="defs3019">
+ <linearGradient id="linearGradient2381">
+ <stop id="stop2383" style="stop-color:#ffffff;stop-opacity:1" offset="0"/>
+ <stop id="stop2385" style="stop-color:#ffffff;stop-opacity:0" offset="1"/>
+ </linearGradient>
+ <linearGradient x1="296.4996" y1="188.81061" x2="317.32471" y2="209.69398" id="linearGradient2371" xlink:href="#linearGradient2381" gradientUnits="userSpaceOnUse" gradientTransform="matrix(0.90776,0,0,0.90776,24.35648,49.24131)"/>
+ </defs>
+ <g transform="matrix(0.437808,-0.437808,0.437808,0.437808,-220.8237,43.55311)" id="g5089">
+ <path d="m 8.4382985,-6.28125 c -0.6073916,0 -4.3132985,5.94886271 -4.3132985,8.25 l 0,26.71875 c 0,0.846384 0.5818159,1.125 1.15625,1.125 l 25.5625,0 c 0.632342,0 1.125001,-0.492658 1.125,-1.125 l 0,-5.21875 0.28125,0 c 0.49684,0 0.906249,-0.409411 0.90625,-0.90625 l 0,-27.9375 c 0,-0.4968398 -0.40941,-0.90625 -0.90625,-0.90625 l -23.8117015,0 z" transform="translate(282.8327,227.1903)" id="path5091" style="fill:#5c5c4f;stroke:#000000;stroke-width:3.23021388;stroke-miterlimit:4;stroke-dasharray:none"/>
+ <rect width="27.85074" height="29.369793" rx="1.1414107" ry="1.1414107" x="286.96509" y="227.63805" id="rect5093" style="fill:#032c87"/>
+ <path d="m 288.43262,225.43675 25.2418,0 0,29.3698 -26.37615,0.0241 1.13435,-29.39394 z" id="rect5095" style="fill:#ffffff"/>
+ <path d="m 302.44536,251.73726 c 1.38691,7.85917 -0.69311,11.28365 -0.69311,11.28365 2.24384,-1.60762 3.96426,-3.47694 4.90522,-5.736 0.96708,2.19264 1.83294,4.42866 4.27443,5.98941 0,0 -1.59504,-7.2004 -1.71143,-11.53706 l -6.77511,0 z" id="path5097" style="fill:#a70000;fill-opacity:1;stroke-width:2"/>
+ <rect width="25.241802" height="29.736675" rx="0.89682275" ry="0.89682275" x="290.73544" y="220.92249" id="rect5099" style="fill:#809cc9"/>
+ <path d="m 576.47347,725.93939 6.37084,0.41502 0.4069,29.51809 c -1.89202,-1.31785 -6.85427,-3.7608 -8.26232,-1.68101 l 0,-26.76752 c 0,-0.82246 0.66212,-1.48458 1.48458,-1.48458 z" transform="matrix(0.499065,-0.866565,0,1,0,0)" id="rect5101" style="fill:#4573b3;fill-opacity:1"/>
+ <path d="m 293.2599,221.89363 20.73918,0 c 0.45101,0 0.8141,0.3631 0.8141,0.81411 0.21547,6.32836 -19.36824,21.7635 -22.36739,17.59717 l 0,-17.59717 c 0,-0.45101 0.3631,-0.81411 0.81411,-0.81411 z" id="path5103" style="opacity:0.65536726;fill:url(#linearGradient2371);fill-opacity:1"/>
+ </g>
+</svg>
diff --git a/Administrator_Guide/publican.cfg b/Administrator_Guide/publican.cfg
new file mode 100644
index 0000000..f1ce5b6
--- /dev/null
+++ b/Administrator_Guide/publican.cfg
@@ -0,0 +1,7 @@
+# Config::Simple 4.59
+# Mon Dec 13 13:37:59 2010
+
+xml_lang: en-US
+type: Book
+brand: common
+
diff --git a/Common_Content/en-US/Author_Group.xml b/Common_Content/en-US/Author_Group.xml
new file mode 100644
index 0000000..cc5450e
--- /dev/null
+++ b/Common_Content/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" [
+%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/Deployment_Guide/Makefile b/Deployment_Guide/Makefile
new file mode 100644
index 0000000..1ec237d
--- /dev/null
+++ b/Deployment_Guide/Makefile
@@ -0,0 +1,17 @@
+PACKAGE = "Deployment_Guide"
+
+all: clean clean_ids
+ @publican build --langs=en-US --formats=html,html-single,pdf
+ @rsync -aHvz tmp/en-US/{html,html-single,pdf} hosted.kolabsys.com:./public_html/kolab-2.3-docs/$(PACKAGE)/
+
+clean:
+ @publican clean
+
+clean_ids:
+ @cp -a ../Common_Content/en-US/*.xml en-US/.
+ @publican clean_ids
+ @sed -i -r \
+ -e 's/\t/ /g' \
+ -e 's/((\s{4})+)\s*/\1/g' \
+ -e 's/\s*$$//g' \
+ `find en-US/ -type f -name "*.xml"`
diff --git a/Deployment_Guide/en-US/Author_Group.xml b/Deployment_Guide/en-US/Author_Group.xml
index 104661b..52b14bd 100644
--- a/Deployment_Guide/en-US/Author_Group.xml
+++ b/Deployment_Guide/en-US/Author_Group.xml
@@ -7,11 +7,13 @@
<author>
<firstname>Jeroen</firstname>
<surname>van Meeuwen</surname>
- <affiliation>
+ <lineage>RHCE</lineage> <affiliation>
<orgname>Kolab Systems</orgname>
- <orgdiv>Senior Engineer</orgdiv>
+ <orgdiv>Engineering</orgdiv>
+
</affiliation>
<email>vanmeeuwen@kolabsys.com</email>
+
</author>
</authorgroup>
diff --git a/Deployment_Guide/en-US/Book_Info.xml b/Deployment_Guide/en-US/Book_Info.xml
index aee380c..013b1f0 100644
--- a/Deployment_Guide/en-US/Book_Info.xml
+++ b/Deployment_Guide/en-US/Book_Info.xml
@@ -4,25 +4,28 @@
%BOOK_ENTITIES;
]>
<bookinfo id="book-Deployment_Guide-Deployment_Guide">
- <title>Deployment Guide</title>
- <subtitle>short description</subtitle>
- <productname>Kolab</productname>
- <productnumber>2.3.0</productnumber>
- <edition>0</edition>
- <pubsnumber>0</pubsnumber>
- <abstract>
- <para>
- A short overview and summary of the book&#39;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&#39;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" />
+ <title>Deployment Guide</title>
+ <subtitle>short description</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.3.0</productnumber>
+ <edition>0</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/Deployment_Guide/en-US/Deployment_Guide.xml b/Deployment_Guide/en-US/Deployment_Guide.xml
index f0fedc7..ca47641 100644
--- a/Deployment_Guide/en-US/Deployment_Guide.xml
+++ b/Deployment_Guide/en-US/Deployment_Guide.xml
@@ -6,10 +6,8 @@
<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="Infrastructure.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Kolab_Preparations.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/Deployment_Guide/en-US/Infrastructure.xml b/Deployment_Guide/en-US/Infrastructure.xml
index 55fb43f..2fdd93f 100644
--- a/Deployment_Guide/en-US/Infrastructure.xml
+++ b/Deployment_Guide/en-US/Infrastructure.xml
@@ -1,18 +1,19 @@
<?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" [
+<!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 "Deployment_Guide.ent">
+%BOOK_ENTITIES;
]>
-
<chapter id="chap-Deployment_Guide-Infrastructure">
<title>Infrastructure</title>
<para>
With the implementation of groupware, several aspects in the infrastructure are worth considering prior to executing the actual implementation. This deployment guide addresses some of these aspects for your consideration.
</para>
-
<section id="sect-Deployment_Guide-Infrastructure-Authentication_and_Authorization">
<title>Authentication and Authorization</title>
<para>
The Kolab Groupware solution integrates with LDAP particularly well, but of course has certain prerequisites to the LDAP technology used, the exact LDAP schemas loaded and if you already have LDAP implemented, the way LDAP is used and maintained today.
</para>
+
</section>
<section id="sect-Deployment_Guide-Infrastructure-Domain_Name_System">
@@ -20,6 +21,7 @@
<para>
The Domain Name System, or DNS, is one essential part of any groupware environment. In terms of receiving and sending email, anti-spam, as well as scaling up your LDAP, mail exchangers, front-end load-balancers and anti-spam/anti-virus, DNS is one of those components that requires attention in detail.
</para>
+
</section>
<section id="sect-Deployment_Guide-Infrastructure-Scalability">
@@ -27,6 +29,7 @@
<para>
para
</para>
+
</section>
<section id="sect-Deployment_Guide-Infrastructure-Storage">
@@ -34,6 +37,9 @@
<para>
para
</para>
+
</section>
+
</chapter>
+
diff --git a/Deployment_Guide/en-US/Kolab_Preparations.xml b/Deployment_Guide/en-US/Kolab_Preparations.xml
index 6a4ba7b..74a14c0 100644
--- a/Deployment_Guide/en-US/Kolab_Preparations.xml
+++ b/Deployment_Guide/en-US/Kolab_Preparations.xml
@@ -1,18 +1,19 @@
<?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" [
+<!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 "Deployment_Guide.ent">
+%BOOK_ENTITIES;
]>
-
<chapter id="chap-Deployment_Guide-Kolab_Preparations">
<title>Kolab Preparations</title>
<para>
para
</para>
-
- <section id="sect-Deployment_Guide-Kolab_Preparations-LDAP_Schema">
+ <section id="sect-Deployment_Guide-Kolab_Preparations-Loading_the_LDAP_Schema">
<title>Loading the LDAP Schema</title>
<para>
para
</para>
+
</section>
<section id="sect-Deployment_Guide-Kolab_Preparations-System_Users">
@@ -20,6 +21,9 @@
<para>
para
</para>
+
</section>
+
</chapter>
+
diff --git a/Deployment_Guide/en-US/LDAP_Installation.xml b/Deployment_Guide/en-US/LDAP_Installation.xml
index cf1e040..df1b4be 100644
--- a/Deployment_Guide/en-US/LDAP_Installation.xml
+++ b/Deployment_Guide/en-US/LDAP_Installation.xml
@@ -1,13 +1,13 @@
<?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" [
+<!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 "Deployment_Guide.ent">
+%BOOK_ENTITIES;
]>
-
<chapter id="chap-Deployment_Guide-LDAP_Installation">
<title>LDAP Installation</title>
<para>
para
</para>
-
<procedure>
<step>
<para>
@@ -16,14 +16,18 @@
<para>
<command># yum install 389-ds</command>
</para>
+
</step>
<step>
<para>
Copy the schema file <filename>/usr/share/kolab/ldap/kolab.389ds.schema</filename> to the appropriate schema directory;
</para>
<para>
- <screen># <userinput>cp -a /usr/share/kolab/ldap/kolab.389ds-schema.ldif /etc/dirsrv/schema/66kolab.ldif</userinput></screen>
+
+<screen># <userinput>cp -a /usr/share/kolab/ldap/kolab.389ds-schema.ldif /etc/dirsrv/schema/66kolab.ldif</userinput></screen>
+
</para>
+
</step>
<step>
<para>
@@ -32,7 +36,11 @@
<para>
<command># setup-ds-admin.pl</command>
</para>
+
</step>
+
</procedure>
+
</chapter>
+
diff --git a/Deployment_Guide/en-US/Preface.xml b/Deployment_Guide/en-US/Preface.xml
index a69ff18..5a93c3f 100644
--- a/Deployment_Guide/en-US/Preface.xml
+++ b/Deployment_Guide/en-US/Preface.xml
@@ -5,25 +5,17 @@
]>
<preface id="pref-Deployment_Guide-Preface">
<title>Preface</title>
-
- <section id="pref-Deployment_Guide-Preface-Introduction">
+ <section id="sect-Deployment_Guide-Preface-Introduction">
<title>Introduction</title>
<para>
para
</para>
+
</section>
-<!--
<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>
-//-->
+ <xi:include href="sect-Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</preface>
diff --git a/Deployment_Guide/en-US/Revision_History.xml b/Deployment_Guide/en-US/Revision_History.xml
index 5fba8cc..965faf6 100644
--- a/Deployment_Guide/en-US/Revision_History.xml
+++ b/Deployment_Guide/en-US/Revision_History.xml
@@ -4,24 +4,30 @@
%BOOK_ENTITIES;
]>
<appendix id="appe-Deployment_Guide-Revision_History">
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>0</revnumber>
- <date>Sat Aug 7 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>
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Sat Aug 7 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/Development_Manual/Makefile b/Development_Manual/Makefile
new file mode 100644
index 0000000..bef33ef
--- /dev/null
+++ b/Development_Manual/Makefile
@@ -0,0 +1,17 @@
+PACKAGE = "Development_Manual"
+
+all: clean clean_ids
+ @publican build --langs=en-US --formats=html,html-single,pdf
+ @rsync -aHvz tmp/en-US/{html,html-single,pdf} hosted.kolabsys.com:./public_html/kolab-2.3-docs/$(PACKAGE)/
+
+clean:
+ @publican clean
+
+clean_ids:
+ @cp -a ../Common_Content/en-US/*.xml en-US/.
+ @publican clean_ids
+ @sed -i -r \
+ -e 's/\t/ /g' \
+ -e 's/((\s{4})+)\s*/\1/g' \
+ -e 's/\s*$$//g' \
+ `find en-US/ -type f -name "*.xml"`
diff --git a/Development_Manual/en-US/Author_Group.xml b/Development_Manual/en-US/Author_Group.xml
index 98ecc97..d8fc01c 100644
--- a/Development_Manual/en-US/Author_Group.xml
+++ b/Development_Manual/en-US/Author_Group.xml
@@ -7,12 +7,13 @@
<author>
<firstname>Jeroen</firstname>
<surname>van Meeuwen</surname>
- <lineage>RHCE</lineage>
- <affiliation>
+ <lineage>RHCE</lineage> <affiliation>
<orgname>Kolab Systems</orgname>
- <orgdiv>Senior Engineer</orgdiv>
+ <orgdiv>Engineering</orgdiv>
+
</affiliation>
<email>vanmeeuwen@kolabsys.com</email>
+
</author>
</authorgroup>
diff --git a/Development_Manual/en-US/Book_Info.xml b/Development_Manual/en-US/Book_Info.xml
index e129ee3..0738933 100644
--- a/Development_Manual/en-US/Book_Info.xml
+++ b/Development_Manual/en-US/Book_Info.xml
@@ -4,25 +4,28 @@
%BOOK_ENTITIES;
]>
<bookinfo id="book-Development_Manual-Development_Manual">
- <title>Development Manual</title>
- <subtitle>short description</subtitle>
- <productname>Kolab</productname>
- <productnumber>2.3.0</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" />
+ <title>Development Manual</title>
+ <subtitle>short description</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.3.0</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/Development_Manual/en-US/Chapter.xml b/Development_Manual/en-US/Chapter.xml
index 056487f..13beca1 100644
--- a/Development_Manual/en-US/Chapter.xml
+++ b/Development_Manual/en-US/Chapter.xml
@@ -4,30 +4,36 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-Development_Manual-Test_Chapter">
- <title>Test Chapter</title>
- <para>
- This is a test paragraph
- </para>
- <section id="sect-Development_Manual-Test_Chapter-Test_Section_1">
- <title>Test Section 1</title>
- <para>
- This is a test paragraph in a section
- </para>
- </section>
-
- <section id="sect-Development_Manual-Test_Chapter-Test_Section_2">
- <title>Test Section 2</title>
- <para>
- This is a test paragraph in Section 2
- <orderedlist>
- <listitem>
- <para>
- listitem text
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
+ <title>Test Chapter</title>
+ <para>
+ This is a test paragraph
+ </para>
+ <section id="sect-Development_Manual-Test_Chapter-Test_Section_1">
+ <title>Test Section 1</title>
+ <para>
+ This is a test paragraph in a section
+ </para>
+
+ </section>
+
+ <section id="sect-Development_Manual-Test_Chapter-Test_Section_2">
+ <title>Test Section 2</title>
+ <para>
+ This is a test paragraph in Section 2
+ <orderedlist>
+ <listitem>
+ <para>
+ listitem text
+ </para>
+
+ </listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </section>
+
</chapter>
diff --git a/Development_Manual/en-US/Development_Manual.xml b/Development_Manual/en-US/Development_Manual.xml
index dede735..68d6bd5 100644
--- a/Development_Manual/en-US/Development_Manual.xml
+++ b/Development_Manual/en-US/Development_Manual.xml
@@ -6,10 +6,11 @@
<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="Part-General_Kolab_Packaging_Notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Part-Kolab_Packaging_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+ <xi:include href="Development_Processes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Localization_and_Internationalization.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Packaging_with_APT.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Packaging_with_RPM.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/Development_Manual/en-US/Development_Processes.xml b/Development_Manual/en-US/Development_Processes.xml
new file mode 100644
index 0000000..25c1559
--- /dev/null
+++ b/Development_Manual/en-US/Development_Processes.xml
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Development_Processes">
+ <title>Development Processes</title>
+ <chapter id="chap-Development_Manual-Development_Processes-Development_and_Release_Cycles">
+ <title>Development and Release Cycles</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Development_Processes-Release_and_Support_Cycles">
+ <title>Release and Support Cycles</title>
+ <para>
+ para
+ </para>
+ <section id="sect-Development_Manual-Release_and_Support_Cycles-Product_Series_and_Platform_Support">
+ <title>Product Series and Platform Support</title>
+ <para>
+ The support of a product series packaged for or deployed on any particular platform continues for as long as the upstream party for the platform continues to support the actual platform. In other words, in terms of Kolab 2.2 being supported on Debian Lenny at the time of this writing, the support for Kolab 2.2 on Debian Lenny will continue for as long as Debian Lenny is supported by Debian itself.
+ </para>
+
+ </section>
+
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Development_Processes-Kolab_Enhancement_Proposals">
+ <title>Kolab Enhancement Proposals</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+
+</part>
+
diff --git a/Development_Manual/en-US/Documentation.xml b/Development_Manual/en-US/Documentation.xml
new file mode 100644
index 0000000..f73fce4
--- /dev/null
+++ b/Development_Manual/en-US/Documentation.xml
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Documentation">
+ <title>Documentation</title>
+ <chapter id="chap-Development_Manual-Documentation-Kolab_Server">
+ <title>Kolab Server</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+</part>
+
diff --git a/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
index 2bc0392..bf2d99d 100644
--- a/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
+++ b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
@@ -1,6 +1,6 @@
<?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">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Development_Manual-General_Kolab_Server_Components_Packaging_Notes">
@@ -11,8 +11,11 @@
<para>
requires being started after ldap server (standalone)
</para>
+
</listitem>
+
</itemizedlist>
+
</para>
</chapter>
diff --git a/Development_Manual/en-US/Localization_and_Internationalization.xml b/Development_Manual/en-US/Localization_and_Internationalization.xml
new file mode 100644
index 0000000..220eeba
--- /dev/null
+++ b/Development_Manual/en-US/Localization_and_Internationalization.xml
@@ -0,0 +1,23 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Localization_and_Internationalization">
+ <title>Localization and Internationalization</title>
+ <chapter id="chap-Development_Manual-Localization_and_Internationalization-Desktop_Components">
+ <title>Desktop Components</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Localization_and_Internationalization-Web_Interfaces">
+ <title>Web Interfaces</title>
+ <para>
+ para
+ </para>
+
+ </chapter>
+</part>
+
diff --git a/Development_Manual/en-US/Packaging_Kolab_Components.xml b/Development_Manual/en-US/Packaging_Kolab_Components.xml
deleted file mode 100644
index 2dae317..0000000
--- a/Development_Manual/en-US/Packaging_Kolab_Components.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<?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-Development_Manual-Packaging_Kolab_Components">
- <title>Packaging Kolab Components</title>
- <para>
- About
- </para>
-
-</chapter>
-
diff --git a/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml b/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml
deleted file mode 100644
index 5353477..0000000
--- a/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml
+++ /dev/null
@@ -1,73 +0,0 @@
-<?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-Development_Manual-Packaging_Kolab_Server_Components_with_RPM">
- <title>Packaging Kolab Server Components with RPM</title>
- <para>
- Kolab Groupware exists of several components. On the server side, we have:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <literal>kolab</literal>
- </para>
- </listitem>
- <listitem>
- <para>
- FIXME: List the rest of the packages
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <section>
- <title>kolab-cyrus-imapd</title>
- <para>
- Requirements:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <literal>perl-TermReadKey</literal> for perl(Term::ReadKey) capabilities
- </para>
- <para>
- The package is required for %{_bindir}/cyradm
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section>
- <title>Checklist Notes</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- Creation of user
- </para>
- </listitem>
- <listitem>
- <para>
- chkconfig --add services
- </para>
- </listitem>
- <listitem>
- <para>
- Set debug to 9 (/etc/kolab/kolab.globals)
- </para>
- </listitem>
- <listitem>
- <para>
- Set loglevel to 15 (/etc/kolab/kolab.globals)
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-</chapter>
-
diff --git a/Development_Manual/en-US/Packaging_with_APT.xml b/Development_Manual/en-US/Packaging_with_APT.xml
new file mode 100644
index 0000000..cbffc75
--- /dev/null
+++ b/Development_Manual/en-US/Packaging_with_APT.xml
@@ -0,0 +1,361 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Packaging_with_APT">
+ <title>Packaging with APT</title>
+ <chapter id="chap-Development_Manual-Packaging_with_APT-Prerequisites">
+ <title>Prerequisites</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ A 64-bit system with Debian Squeeze or later,
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ The following packages:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ cowbuilder
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ dupload
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ git-buildpackage
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ git-core
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ git-svn
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ pbuilder
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ quilt
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <note>
+ <title>Not Including Build Requirements</title>
+ <para>
+ Note that the list of required packages does not include any build requirements for any of the packages.
+ </para>
+
+ </note>
+ <para>
+ You may install these packages in one go using the following command:
+ </para>
+ <para>
+
+<screen># <userinput>apt-get -y install cowbuilder dupload fakeroot git-buildpackage \</userinput>
+ <userinput> git-core git-svn pbuilder quilt</userinput></screen>
+
+ </para>
+
+ </chapter>
+ <chapter id="chap-Development_Manual-Packaging_with_APT-Getting_Started">
+ <title>Getting Started</title>
+ <para>
+ We perform packaging from GIT source code management repositories. Using these repositories, either as a separate remote for an upstream GIT repository, or as a pristine-tar import based exploded tree, patch management as well as Debian APT packaging semantics are maintained in such GIT repository.
+ </para>
+ <para>
+ The upstream source code management for programs for which Kolab itself is the upstream, holds no information relevant to packaging semantics for any given distribution.
+ </para>
+ <para>
+ To clone an APT packaging repository, use:
+ </para>
+ <para>
+
+<screen>$ <userinput>git clone git://git.kolabsys.com/git/apt/$package</userinput></screen>
+
+ </para>
+ <para>
+ where <emphasis>$package</emphasis> is one of the packages in <xref linkend="item-Development_Manual-APT_Packaging_GIT_Repositories-APT_Packages" />.
+ </para>
+ <section id="sect-Development_Manual-Getting_Started-APT_Packaging_GIT_Repositories">
+ <title>APT Packaging GIT Repositories</title>
+ <para>
+ The APT packaging GIT repositories live at: <ulink url="http://git.kolabsys.com/apt/" />. Each source package has its own GIT repository. The following repositories are relevant:
+ </para>
+ <para>
+ <itemizedlist id="item-Development_Manual-APT_Packaging_GIT_Repositories-APT_Packages">
+ <title>APT Packages</title>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-cyrus_imapd">
+ <title><application>cyrus-imapd</application></title>
+ <para>
+ Kolab currently maintains a set of requirements to Cyrus IMAP that is not provided through Debian nor Ubuntu native packages included in the distribution's package repositories, including, but not limited to:
+ </para>
+
+ </formalpara>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Kolab annotation configuration support.
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Login with uid and/or mail attribute.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <para>
+ Additionally, the Kolab version for hosted providers requires Cyrus IMAP 2.4.
+ </para>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-horde3">
+ <title><application>horde3</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-horde4">
+ <title><application>horde4</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-kolab_webadmin">
+ <title><application>kolab-webadmin</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-kolab_webclient">
+ <title><application>kolab-webclient</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-kolabd">
+ <title><application>kolabd</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-libkolab_perl">
+ <title><application>libkolab-perl</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-libnet_ldap_perl">
+ <title><application>libnet-ldap-perl</application></title>
+ <para>
+ Kolab's perl libraries require a more recent version of libnet-ldap-perl then is available in Debian Lenny.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php">
+ <title><application>php</application></title>
+ <para>
+ Kolab ships IMAP annotation and myrights patches against PHP.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_config">
+ <title><application>php-kolab-config</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_filter">
+ <title><application>php-kolab-filter</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_format">
+ <title><application>php-kolab-format</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_freebusy">
+ <title><application>php-kolab-freebusy</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_resource">
+ <title><application>php-kolab-resource</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_server">
+ <title><application>php-kolab-server</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_storage">
+ <title><application>php-kolab-storage</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_kolab_zpush">
+ <title><application>php-kolab-zpush</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-php_net_ldap2">
+ <title><application>php-net-ldap2</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Development_Manual-APT_Packages-uw_imap">
+ <title><application>uw-imap</application></title>
+ <para>
+ para
+ </para>
+
+ </formalpara>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <section id="sect-Development_Manual-APT_Packaging_GIT_Repositories-SCM_Branch_Policy">
+ <title>SCM Branch Policy</title>
+ <para>
+ A GIT repository has a master branch, which corresponds with the most bleeding edge version of Kolab, and the most bleeding edge version of the distribution (e.g. Debian Sid).
+ </para>
+ <para>
+ The following naming convention is used for more stabilized distribution version product series:
+ </para>
+ <para>
+
+<screen>$distribution / [$codename /] $product_name - $product_version_series</screen>
+
+ </para>
+ <para>
+ This means that, for example, packaging semantics for Kolab 2.2 specific to Lenny are put in <literal>debian/lenny/kolab-2.2</literal>, such as, for example, is the case with PHP: <ulink url="http://git.kolabsys.com/apt/php/log/?h=debian/lenny/kolab-2.2" /> where Kolab 2.2 shipped a modified version of <application>php5</application>, built against a modified version of <application>uw-imap</application>, to enable IMAP annotation support.
+ </para>
+
+ </section>
+
+
+ </section>
+
+
+ </chapter>
+</part>
+
diff --git a/Development_Manual/en-US/Packaging_with_RPM.xml b/Development_Manual/en-US/Packaging_with_RPM.xml
new file mode 100644
index 0000000..f8ab832
--- /dev/null
+++ b/Development_Manual/en-US/Packaging_with_RPM.xml
@@ -0,0 +1,93 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Packaging_with_RPM">
+ <title>Packaging with RPM</title>
+ <chapter id="chap-Development_Manual-Packaging_with_RPM-Packaging_with_RPM">
+ <title>Packaging with RPM</title>
+ <para>
+ Kolab Groupware exists of several components. On the server side, we have:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>kolab</literal>
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ FIXME: List the rest of the packages
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <section id="sect-Development_Manual-Packaging_with_RPM-kolab_cyrus_imapd">
+ <title>kolab-cyrus-imapd</title>
+ <para>
+ Requirements:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>perl-TermReadKey</literal> for perl(Term::ReadKey) capabilities
+ </para>
+ <para>
+ The package is required for %{_bindir}/cyradm
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </section>
+
+ <section id="sect-Development_Manual-Packaging_with_RPM-Checklist_Notes">
+ <title>Checklist Notes</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Creation of user
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ chkconfig --add services
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Set debug to 9 (/etc/kolab/kolab.globals)
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Set loglevel to 15 (/etc/kolab/kolab.globals)
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </section>
+
+
+ </chapter>
+
+</part>
+
diff --git a/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
index 19e6af4..5779cd0 100644
--- a/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
+++ b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
@@ -1,11 +1,11 @@
<?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">
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
%BOOK_ENTITIES;
]>
<part id="part-Development_Manual-General_Kolab_Packaging_Notes">
<title>General Kolab Packaging Notes</title>
-
<xi:include href="General_Kolab_Server_Components_Packaging_Notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
+
diff --git a/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml b/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml
deleted file mode 100644
index 72a9502..0000000
--- a/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml
+++ /dev/null
@@ -1,11 +0,0 @@
-<?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-Development_Manual-Kolab_Packaging_with_RPM">
- <title>Kolab Packaging with RPM</title>
-
- <xi:include href="Packaging_Kolab_Server_Components_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-</part> \ No newline at end of file
diff --git a/Development_Manual/en-US/Preface.xml b/Development_Manual/en-US/Preface.xml
index e68be4c..6cea477 100644
--- a/Development_Manual/en-US/Preface.xml
+++ b/Development_Manual/en-US/Preface.xml
@@ -4,10 +4,9 @@
%BOOK_ENTITIES;
]>
<preface id="pref-Development_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>
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</preface>
diff --git a/Development_Manual/en-US/Revision_History.xml b/Development_Manual/en-US/Revision_History.xml
index 99e8c7d..d691932 100644
--- a/Development_Manual/en-US/Revision_History.xml
+++ b/Development_Manual/en-US/Revision_History.xml
@@ -4,24 +4,30 @@
%BOOK_ENTITIES;
]>
<appendix id="appe-Development_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>
+ <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/Development_Manual/en-US/TODO.xml b/Development_Manual/en-US/TODO.xml
index fd74174..397b467 100644
--- a/Development_Manual/en-US/TODO.xml
+++ b/Development_Manual/en-US/TODO.xml
@@ -1,9 +1,9 @@
<?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">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Development_Manual-TODO">
+<chapter id="chap-Development_Manual-List_of_things_to_do">
<title>List of things to do</title>
<para>
<itemizedlist>
@@ -11,41 +11,47 @@
<para>
provide a means for kolabd to poll and continue operations as normal, rather then fail on error and stop
</para>
+
</listitem>
<listitem>
<para>
the setup program is actually supposed to be called setup-kolab
</para>
+
</listitem>
<listitem>
<para>
keep account of steps completed in the setup program, so that we can continue
</para>
+
</listitem>
<listitem>
<para>
password prompt on setup should not echo
</para>
+
</listitem>
<listitem>
<para>
could not write to /usr/lib64/sasl2/smtpd.conf at /usr/sbin/kolab_bootstrap line 465, &lt;STDIN&gt; line 6.
</para>
+
</listitem>
<listitem>
<para>
- chgrp /etc/kolab/key.pem /etc/kolab/cert.pem
-chgrp: invalid group `/etc/kolab/key.pem'
-system chgrp /etc/kolab/key.pem /etc/kolab/cert.pem failed: 256 at /usr/sbin/kolab_bootstrap line 193, &lt;STDIN&gt; line 7.
+ chgrp /etc/kolab/key.pem /etc/kolab/cert.pem chgrp: invalid group `/etc/kolab/key.pem' system chgrp /etc/kolab/key.pem /etc/kolab/cert.pem failed: 256 at /usr/sbin/kolab_bootstrap line 193, &lt;STDIN&gt; line 7.
</para>
+
</listitem>
<listitem>
<para>
- May 17 09:25:56 laurel perl: No worthy mechs found
-May 17 09:25:56 laurel imap[2587]: auxpropfunc error invalid parameter supplied
+ May 17 09:25:56 laurel perl: No worthy mechs found May 17 09:25:56 laurel imap[2587]: auxpropfunc error invalid parameter supplied
</para>
+
</listitem>
+
</itemizedlist>
+
</para>
</chapter>
diff --git a/Installation_Guide/Makefile b/Installation_Guide/Makefile
new file mode 100644
index 0000000..ca314c1
--- /dev/null
+++ b/Installation_Guide/Makefile
@@ -0,0 +1,17 @@
+PACKAGE = "Installation_Guide"
+
+all: clean clean_ids
+ @publican build --langs=en-US --formats=html,html-single,pdf
+ @rsync -aHvz tmp/en-US/{html,html-single,pdf} hosted.kolabsys.com:./public_html/kolab-2.3-docs/$(PACKAGE)/
+
+clean:
+ @publican clean
+
+clean_ids:
+ @cp -a ../Common_Content/en-US/*.xml en-US/.
+ @publican clean_ids
+ @sed -i -r \
+ -e 's/\t/ /g' \
+ -e 's/((\s{4})+)\s*/\1/g' \
+ -e 's/\s*$$//g' \
+ `find en-US/ -type f -name "*.xml"`
diff --git a/Installation_Guide/en-US/About_Kolab_Groupware.xml b/Installation_Guide/en-US/About_Kolab_Groupware.xml
index 4008184..65eae4d 100644
--- a/Installation_Guide/en-US/About_Kolab_Groupware.xml
+++ b/Installation_Guide/en-US/About_Kolab_Groupware.xml
@@ -3,26 +3,28 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-About_Kolab_Groupware">
+<chapter id="chap-Installation_Guide-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>
+ <section id="sect-Installation_Guide-About_Kolab_Groupware-Free_Software_Components">
<title>Free Software Components</title>
<para>
TODO: Come on, be a little more verbose...
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Free_Software_Components-This_documentation">
<title>This documentation</title>
<para>
Describe how this documentation can be modified to custom, internal documentation
</para>
+
</section>
+
</section>
+ <xi:include href="sect-Supported_Platforms_and_System_Requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
</chapter>
diff --git a/Installation_Guide/en-US/Author_Group.xml b/Installation_Guide/en-US/Author_Group.xml
index 5a3f9c8..29d4806 100644
--- a/Installation_Guide/en-US/Author_Group.xml
+++ b/Installation_Guide/en-US/Author_Group.xml
@@ -7,12 +7,13 @@
<author>
<firstname>Jeroen</firstname>
<surname>van Meeuwen</surname>
- <lineage>RHCE</lineage>
- <affiliation>
+ <lineage>RHCE</lineage> <affiliation>
<orgname>Kolab Systems</orgname>
<orgdiv>Engineering</orgdiv>
+
</affiliation>
<email>vanmeeuwen@kolabsys.com</email>
+
</author>
</authorgroup>
diff --git a/Installation_Guide/en-US/Book_Info.xml b/Installation_Guide/en-US/Book_Info.xml
index da729ad..b9036e7 100644
--- a/Installation_Guide/en-US/Book_Info.xml
+++ b/Installation_Guide/en-US/Book_Info.xml
@@ -3,24 +3,27 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<bookinfo id="book-Installation_Manual-Installation_Manual">
- <title>Installation Manual</title>
+<bookinfo id="book-Installation_Guide-Installation_Guide">
+ <title>Installation Guide</title>
<subtitle>The Kolab Groupware Solution</subtitle>
<productname>Kolab</productname>
- <productnumber>2.3.0</productnumber>
+ <productnumber>2.3</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" />
diff --git a/Installation_Guide/en-US/Cyrus_IMAP.xml b/Installation_Guide/en-US/Cyrus_IMAP.xml
index 7277792..5e27ce4 100644
--- a/Installation_Guide/en-US/Cyrus_IMAP.xml
+++ b/Installation_Guide/en-US/Cyrus_IMAP.xml
@@ -1,52 +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" [
+<!DOCTYPE part 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;
]>
-<part id="part-Installation_Manual-Cyrus_IMAP">
+<part id="part-Installation_Guide-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">
+ </partintro>
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-Installation_of_Cyrus_IMAP">
<title>Installation of Cyrus IMAP</title>
- <formalpara>
+ <formalpara id="form-Installation_Guide-Installation_of_Cyrus_IMAP-Kolab_Systems_Repository_Configuration">
<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" />.
+ 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_Guide-Obtaining_Kolab_Software-Repository_Configuration" />.
</para>
- </formalpara>
- <section>
+ </formalpara>
+ <section id="sect-Installation_Guide-Installation_of_Cyrus_IMAP-Installation">
<title>Installation</title>
<para>
The package name for Cyrus IMAP is <application>kolab-cyrus-imapd</application>.
</para>
-
- <formalpara>
+ <formalpara id="form-Installation_Guide-Installation-Installation_Instructions_for_APT_based_Systems">
<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>
+<screen># <userinput>apt-get -y install kolab-cyrus-imapd</userinput></screen>
+
+ </para>
+ <formalpara id="form-Installation_Guide-Installation-Installation_Instructions_for_RPM_based_Systems">
<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>
+<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>
@@ -58,9 +61,10 @@
</para>
</section>
- </chapter>
- <chapter id="chap-Installation_Manual-Cyrus_IMAP-Configuration_of_Cyrus_IMAP">
+
+ </chapter>
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-Configuration_of_Cyrus_IMAP">
<title>Configuration of Cyrus IMAP</title>
<para>
The following configuration files are installed on the system:
@@ -68,123 +72,133 @@
<para>
<itemizedlist>
<listitem>
- <formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-CYRUS_CONFIG">
<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.
+ 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_Guide-Cyrus_IMAP-Securing_Cyrus_IMAP_Communications" /> for more details if you seek to secure communications.
</para>
+
</formalpara>
+
</listitem>
<listitem>
- <formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-CYRUS_IMAPD_CONFIG">
<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.
+ The behaviour of Cyrus IMAP is controlled using &CYRUS_IMAPD_CONFIG;. Please refer to <xref linkend="chap-Installation_Guide-Cyrus_IMAP-Configuring_IMAP" /> for standard configurations, and <xref linkend="chap-Installation_Guide-Cyrus_IMAP-IMAP_Option_Reference" /> for a list of options.
</para>
+
</formalpara>
+
</listitem>
<listitem>
- <formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-CYRUS_ANNOTATIONS_CONFIG">
<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>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-System_Configuration_Defaults">
<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.
+ 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_Guide-Cyrus_IMAP-System_Configuration_Defaults" /> for more information on available options.
</para>
- </formalpara>
- <formalpara>
+ </formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-APT_based_Systems">
<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>
+ </formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-RPM_based_Systems">
<title>RPM-based Systems</title>
<para>
On RPM-based Systems, please use &RPM_CYRUS_SYS_DEFAULTS; as the system configuration defaults file.
</para>
- </formalpara>
+ </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>
<para>
In addition to these configuration files, the following directories are used for Cyrus IMAP by default:
</para>
-
<para>
<itemizedlist>
<listitem>
- <formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-CYRUS_CONFIGDIR">
<title>&CYRUS_CONFIGDIR;</title>
<para>
Cyrus IMAP stores it's databases and transactional data here, such as Sieve scripts.
</para>
+
</formalpara>
+
</listitem>
<listitem>
- <formalpara>
+ <formalpara id="form-Installation_Guide-Configuration_of_Cyrus_IMAP-CYRUS_SPOOLDIR">
<title>&CYRUS_SPOOLDIR;</title>
<para>
- The primary (default) IMAP partition. Please refer to <xref linkend="chap-Installation_Manual-Cyrus_IMAP-IMAP_Partitions" /> for
+ The primary (default) IMAP partition. Please refer to <xref linkend="chap-Installation_Guide-Cyrus_IMAP-IMAP_Partitions" /> for
</para>
+
</formalpara>
+
</listitem>
+
</itemizedlist>
- </para>
+ </para>
<para>
TODO: Quick To Go: Small deployments
</para>
</chapter>
-
- <chapter id="chap-Installation_Manual-Cyrus_IMAP-Configuring_IMAP">
+ <chapter id="chap-Installation_Guide-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">
+ </chapter>
+ <chapter id="chap-Installation_Guide-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">
+ </chapter>
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-IMAP_Partitions">
<title>IMAP Partitions</title>
<para>
TODO
</para>
- </chapter>
- <chapter id="chap-Installation_Manual-Cyrus_IMAP-IMAP_Option_Reference">
+ </chapter>
+ <chapter id="chap-Installation_Guide-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">
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-System_Configuration_Defaults">
<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);
@@ -192,106 +206,119 @@
<para>
<itemizedlist>
<listitem>
- <formalpara>
+ <formalpara id="form-Installation_Guide-System_Configuration_Defaults-CYRUS_CONFIG">
<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>
+ <formalpara id="form-Installation_Guide-System_Configuration_Defaults-IMAPD_CONFIG">
<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>
+ <formalpara id="form-Installation_Guide-System_Configuration_Defaults-LISTENQUEUE">
<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>
+ <formalpara id="form-Installation_Guide-System_Configuration_Defaults-CYRUS_VERBOSE">
<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>
+ <formalpara id="form-Installation_Guide-System_Configuration_Defaults-CYRUS_OPTIONS">
<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>
+ </chapter>
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-Creating_a_Cyrus_Murder_Setup">
<title>Creating a Cyrus Murder Setup</title>
<para>
TODO
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Creating_a_Cyrus_Murder_Setup-Setting_up_the_master_update_server">
<title>Setting up the master update server</title>
<para>
TODO
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Setting_up_the_master_update_server-Choosing_the_mupdate_mode">
<title>Choosing the mupdate mode</title>
<para>
TODO: on unified, replica, etc.
</para>
+
</section>
+
</section>
- </chapter>
- <chapter>
+ </chapter>
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-Creating_an_IMAP_Backend_Server">
<title>Creating an IMAP Backend Server</title>
<para>
TODO
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Creating_an_IMAP_Backend_Server-Hooking_in_a_new_backend_server_into_a_murder_setup">
<title>Hooking in a new backend server into a murder setup</title>
<para>
TODO
</para>
+
</section>
- </chapter>
- <chapter>
+ </chapter>
+ <chapter id="chap-Installation_Guide-Cyrus_IMAP-Creating_an_IMAP_Frontend_Server">
<title>Creating an IMAP Frontend Server</title>
<para>
TODO
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Creating_an_IMAP_Frontend_Server-Hooking_in_a_new_frontend_server_into_a_murder_setup">
<title>Hooking in a new frontend server into a murder setup</title>
<para>
TODO
</para>
+
</section>
+
</chapter>
</part>
diff --git a/Installation_Guide/en-US/Installation_Guide.xml b/Installation_Guide/en-US/Installation_Guide.xml
index f275997..1db27cc 100644
--- a/Installation_Guide/en-US/Installation_Guide.xml
+++ b/Installation_Guide/en-US/Installation_Guide.xml
@@ -6,17 +6,12 @@
<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="Obtaining_Kolab_Software.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" />
+ // --> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
diff --git a/Installation_Guide/en-US/Installation_Introduction.xml b/Installation_Guide/en-US/Installation_Introduction.xml
index 086e124..3a4c111 100644
--- a/Installation_Guide/en-US/Installation_Introduction.xml
+++ b/Installation_Guide/en-US/Installation_Introduction.xml
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-Installation_Introduction">
+<chapter id="chap-Installation_Guide-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.
diff --git a/Installation_Guide/en-US/Kolab_Initial_Configuration.xml b/Installation_Guide/en-US/Kolab_Initial_Configuration.xml
index cfd15fd..0730b55 100644
--- a/Installation_Guide/en-US/Kolab_Initial_Configuration.xml
+++ b/Installation_Guide/en-US/Kolab_Initial_Configuration.xml
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-Kolab_Initial_Configuration">
+<chapter id="chap-Installation_Guide-Kolab_Initial_Configuration">
<title>Kolab Initial Configuration</title>
<para>
para
@@ -14,24 +14,30 @@
Run, as root:
</para>
<para>
- <screen># <userinput>setup-kolab.pl</userinput></screen>
+
+<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>
+ <section id="sect-Installation_Guide-Kolab_Initial_Configuration-Manual_Configuration">
<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
@@ -39,17 +45,22 @@ check out /etc/kolab/kolab.conf
- set the fqdn
- check
</screen>
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Kolab_Initial_Configuration-Configuration_through_Puppet">
<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>
+
+<screen>$ <userinput>git clone git://git.puppetmanaged.org/puppet/kolab</userinput></screen>
+
</para>
+
</section>
+
</chapter>
diff --git a/Installation_Guide/en-US/Kolab_Server_on_Enterprise_Linux.xml b/Installation_Guide/en-US/Kolab_Server_on_Enterprise_Linux.xml
index 52be099..83a2031 100644
--- a/Installation_Guide/en-US/Kolab_Server_on_Enterprise_Linux.xml
+++ b/Installation_Guide/en-US/Kolab_Server_on_Enterprise_Linux.xml
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-Kolab_Server_on_Enterprise_Linux">
+<chapter id="chap-Installation_Guide-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:
@@ -14,43 +14,49 @@
<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">
+ </para>
+ <section id="sect-Installation_Guide-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>
+ <section id="sect-Installation_Guide-Prerequisites-Server_System">
<title>Server System</title>
<para>
These are the system prerequisites for a supported Kolab server installation on Enterprise Linux.
</para>
<para>
- <orderedlist>
+ <orderedlist id="orde-Installation_Guide-Server_System-System_Resources">
<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>
+ <orderedlist id="orde-Installation_Guide-Server_System-Operating_System_Resources">
<title>Operating System Resources</title>
<listitem>
<para>
@@ -62,16 +68,23 @@
<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:
@@ -85,9 +98,10 @@
<para>
FIXME: Provide a URL for the migration manual
</para>
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Prerequisites-YUM_Repositories">
<title>YUM Repositories</title>
<para>
A Kolab Groupware server system requires the following YUM repositories to be installed in complete, available and enabled;
@@ -99,42 +113,51 @@
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" />.
+ For more details on the installation and configuration of the EPEL repository, please refer to <xref linkend="sect-Installation_Guide-Repository_Configuration-EPEL_Repository_Configuration" />.
</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" />.
+ For more details on the installation and configuration of the Kolab repository, please refer to <xref linkend="sect-Installation_Guide-Repository_Configuration-Kolab_Repository_Configuration" />.
</para>
+
</listitem>
+
</orderedlist>
+
</para>
+
</section>
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Kolab_Server_on_Enterprise_Linux-Repository_Configuration">
<title>Repository Configuration</title>
-
- <section id="sect-Installation_Manual-Kolab_Server_on_Enterprise_Linux-Repository_Configuration-EPEL">
+ <section id="sect-Installation_Guide-Repository_Configuration-EPEL_Repository_Configuration">
<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">
+ <section id="sect-Installation_Guide-Repository_Configuration-Kolab_Repository_Configuration">
<title>Kolab Repository Configuration</title>
<para>
FIXME: Something on Kolab repository configuration
</para>
+
</section>
+
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Kolab_Server_on_Enterprise_Linux-Standalone_Server_Installation">
<title>Standalone Server Installation</title>
<para>
When the prerequisite requirements are met, install the Kolab Groupware Server components:
@@ -143,9 +166,11 @@
<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" />
+ This will install a completely standalone Kolab Groupware server. Continue to <xref linkend="chap-Installation_Guide-Kolab_Initial_Configuration" />
</para>
+
</section>
+
</chapter>
diff --git a/Installation_Guide/en-US/Kolab_Systems_Software_Repositories.xml b/Installation_Guide/en-US/Kolab_Systems_Software_Repositories.xml
index 68a7555..c420a1a 100644
--- a/Installation_Guide/en-US/Kolab_Systems_Software_Repositories.xml
+++ b/Installation_Guide/en-US/Kolab_Systems_Software_Repositories.xml
@@ -3,29 +3,27 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-Kolab_Systems_Software_Repositories">
+<chapter id="chap-Installation_Guide-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">
+ <section id="sect-Installation_Guide-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">
+ <section id="sect-Installation_Guide-Kolab_Systems_Software_Repositories-Repository_Configuration">
<title>Repository Configuration</title>
-
- <section>
+ <section id="sect-Installation_Guide-Repository_Configuration-Community_Edition">
<title>Community Edition</title>
<para>
TODO: Insert notice about the community edition.
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Community_Edition-Debian_Squeeze">
<title>Debian Squeeze</title>
<procedure>
<step>
@@ -33,26 +31,36 @@
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
+
+<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>
<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: *
+
+<screen>Package: *
Pin: origin mirror.kolabsys.com
Pin-Priority: 501</screen>
+
</para>
+
</step>
+
</procedure>
+
+
</section>
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Repository_Configuration-Enterprise_Edition">
<title>Enterprise Edition</title>
<para>
TODO: Insert benefit of purchasing subscriptions to enterprise editions.
@@ -63,8 +71,7 @@ Pin-Priority: 501</screen>
<para>
TODO: Describe exporting and using as browser cert.
</para>
-
- <section>
+ <section id="sect-Installation_Guide-Enterprise_Edition-Enterprise_Edition_on_APT_based_Systems">
<title>Enterprise Edition on APT-based Systems</title>
<para>
TODO: Describe the exact procedure to enable the secure communications.
@@ -72,9 +79,10 @@ Pin-Priority: 501</screen>
<para>
TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other.
</para>
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Enterprise_Edition-Enterprise_Edition_on_RPM_based_Systems">
<title>Enterprise Edition on RPM-based Systems</title>
<para>
TODO: Describe the exact procedure to enable the secure communications.
@@ -82,9 +90,10 @@ Pin-Priority: 501</screen>
<para>
TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other.
</para>
+
</section>
- <section>
+ <section id="sect-Installation_Guide-Enterprise_Edition-Debian_Squeeze">
<title>Debian Squeeze</title>
<procedure>
<step>
@@ -92,42 +101,58 @@ Pin-Priority: 501</screen>
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
+
+<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>
+ <section id="sect-Installation_Guide-Repository_Configuration-Red_Hat_Enterprise_Linux_5">
<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_Guide/en-US/Kolab_Webclient_Installation.xml b/Installation_Guide/en-US/Kolab_Webclient_Installation.xml
index d42c638..30a8c11 100644
--- a/Installation_Guide/en-US/Kolab_Webclient_Installation.xml
+++ b/Installation_Guide/en-US/Kolab_Webclient_Installation.xml
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-Kolab_Webclient_Installation">
+<chapter id="chap-Installation_Guide-Kolab_Webclient_Installation">
<title>Kolab Webclient Installation</title>
<para>
para
@@ -14,8 +14,11 @@
<para>
how to configure the webserver to show the web interface over SSL only
</para>
+
</listitem>
+
</itemizedlist>
+
</para>
</chapter>
diff --git a/Installation_Guide/en-US/Obtaining_Kolab_Software.xml b/Installation_Guide/en-US/Obtaining_Kolab_Software.xml
new file mode 100644
index 0000000..dff14cd
--- /dev/null
+++ b/Installation_Guide/en-US/Obtaining_Kolab_Software.xml
@@ -0,0 +1,362 @@
+<?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>
+
+ </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>
+
+ </procedure>
+
+ <important>
+ <title>Debian Volatile Repositories</title>
+ <para>
+ It is critically important to consider also enabling the 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>
+
+ </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>
+
+ <section id="sect-Installation_Guide-Obtaining_Kolab_Software-Installation_with_RPM_Packages">
+ <title>Installation with RPM Packages</title>
+ <para>
+ para
+ </para>
+
+ </section>
+
+ <section id="sect-Installation_Guide-Obtaining_Kolab_Software-Repository_Configuration">
+ <title>Repository Configuration</title>
+ <section id="sect-Installation_Guide-Repository_Configuration-Community_Edition">
+ <title>Community Edition</title>
+ <para>
+ TODO: Insert notice about the community edition.
+ </para>
+
+ </section>
+
+ <section id="sect-Installation_Guide-Repository_Configuration-Enterprise_Edition">
+ <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 id="sect-Installation_Guide-Enterprise_Edition-Enterprise_Edition_on_APT_based_Systems">
+ <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 id="sect-Installation_Guide-Enterprise_Edition-Enterprise_Edition_on_RPM_based_Systems">
+ <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 id="sect-Installation_Guide-Enterprise_Edition-Debian_Squeeze">
+ <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 id="sect-Installation_Guide-Repository_Configuration-Red_Hat_Enterprise_Linux_5">
+ <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_Guide/en-US/Part-Kolab_Server_Installation.xml b/Installation_Guide/en-US/Part-Kolab_Server_Installation.xml
index c0cbc14..4c8c2bb 100644
--- a/Installation_Guide/en-US/Part-Kolab_Server_Installation.xml
+++ b/Installation_Guide/en-US/Part-Kolab_Server_Installation.xml
@@ -1,16 +1,15 @@
<?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" [
+<!DOCTYPE part 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;
]>
-<part id="part-Installation_Manual-Kolab_Server_Installation">
+<part id="part-Installation_Guide-Kolab_Groupware_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
+</part>
+
diff --git a/Installation_Guide/en-US/Preface.xml b/Installation_Guide/en-US/Preface.xml
index c88a19a..e133080 100644
--- a/Installation_Guide/en-US/Preface.xml
+++ b/Installation_Guide/en-US/Preface.xml
@@ -3,11 +3,10 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.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 id="pref-Installation_Guide-Preface">
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sect-About_Kolab_Groupware.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</preface>
diff --git a/Installation_Guide/en-US/Preparing_the_System.xml b/Installation_Guide/en-US/Preparing_the_System.xml
index 3e7fa57..23359e5 100644
--- a/Installation_Guide/en-US/Preparing_the_System.xml
+++ b/Installation_Guide/en-US/Preparing_the_System.xml
@@ -3,13 +3,12 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Installation_Manual-Preparing_the_System">
+<chapter id="chap-Installation_Guide-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">
+ <section id="sect-Installation_Guide-Preparing_the_System-Prerequisites">
<title>Prerequisites</title>
<para>
The installation of Kolab requires one of the following operating system versions:
@@ -18,19 +17,24 @@
<itemizedlist>
<listitem>
<para>
- Red Hat Enterprise Linux 5, see also <xref linkend="sect-Installation_Manual-Preparing_the_System-Enterprise_Linux" />.
+ Red Hat Enterprise Linux 5, see also <xref linkend="sect-Installation_Guide-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">
+ <section id="sect-Installation_Guide-Preparing_the_System-Recommendations">
<title>Recommendations</title>
<para>
<itemizedlist>
@@ -38,12 +42,16 @@
<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">
+ <section id="sect-Installation_Guide-Preparing_the_System-Enterprise_Linux">
<title>Enterprise Linux</title>
<para>
<orderedlist>
@@ -51,15 +59,21 @@
<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_Guide/en-US/Revision_History.xml b/Installation_Guide/en-US/Revision_History.xml
index 9469715..d4b2d2a 100644
--- a/Installation_Guide/en-US/Revision_History.xml
+++ b/Installation_Guide/en-US/Revision_History.xml
@@ -3,25 +3,31 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.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 id="appe-Installation_Guide-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_Guide/publican.cfg b/Installation_Guide/publican.cfg
index e2e32bf..1f5ffbf 100644
--- a/Installation_Guide/publican.cfg
+++ b/Installation_Guide/publican.cfg
@@ -5,3 +5,4 @@ xml_lang: en-US
type: Book
brand: common
+show_remarks: 1
diff --git a/Makefile b/Makefile
index df218c3..63b7a2d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,41 +1,11 @@
-PRODUCT=Kolab
-VERSION=2.3.0
-
-BUILD_FORMATS="pdf html html-single"
-BUILD_LANGS="en-US"
-
-SRCDIR :=$(shell pwd)
-
-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' \
- `find -type f -name "Book_Info.xml" -or -name "*.ent"`
- for dir in `find -mindepth 1 -maxdepth 1 -type d -exec basename {} \; | sort`; do \
- if [ -f "$$dir/publican.cfg" ]; then \
- cd $$dir; \
- publican build \
- --formats=$(shell echo $(BUILD_FORMATS) | sed -e 's/ /,/g' -e 's/"//g') \
- --langs=$(shell echo $(BUILD_LANGS) | sed -e 's/ /,/g' -e 's/"//g') \
- || exit 1; \
- for build in `find tmp/ -mindepth 2 -maxdepth 2 -type d | sort`; do \
- [ "`basename $$build`" == "xml" ] && continue; \
- [ "`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; \
- done; \
- cd ../; \
- fi; \
- done
-
-clean:
- @rm -rf builds
- @for dir in `ls -d */`; do \
- if [ -f "$$dir/publican.cfg" ]; then \
- cd $$dir; \
- publican clean; \
- cd ../; \
- fi; \
+SUBDIRS = \
+ Administrator_Guide \
+ Deployment_Guide \
+ Development_Manual \
+ Installation_Guide
+
+all:
+ @for dir in $(SUBDIRS); do \
+ cp -a Common_Content/en-US/*.xml $$dir/en-US/.; \
+ make -C $$dir; \
done