From 4d849a6e64d30d8d1f29b8d82f87f692d617069b Mon Sep 17 00:00:00 2001 From: "Jeroen van Meeuwen (Ergo Project)" Date: Wed, 5 Jan 2011 23:42:56 +0000 Subject: Updates to the documentation --- .gitignore | 7 + Administrator_Guide/Makefile | 17 + Administrator_Guide/en-US/Administrator_Guide.ent | 4 + Administrator_Guide/en-US/Administrator_Guide.xml | 13 + Administrator_Guide/en-US/Author_Group.xml | 19 ++ Administrator_Guide/en-US/Book_Info.xml | 31 ++ Administrator_Guide/en-US/Chapter.xml | 39 +++ Administrator_Guide/en-US/Preface.xml | 12 + Administrator_Guide/en-US/Revision_History.xml | 33 ++ .../en-US/chap-About_Kolab_Groupware.xml | 30 ++ Administrator_Guide/en-US/images/icon.svg | 19 ++ Administrator_Guide/publican.cfg | 7 + Common_Content/en-US/Author_Group.xml | 18 + Deployment_Guide/Makefile | 17 + Deployment_Guide/en-US/Author_Group.xml | 6 +- Deployment_Guide/en-US/Book_Info.xml | 43 +-- Deployment_Guide/en-US/Deployment_Guide.xml | 2 - Deployment_Guide/en-US/Infrastructure.xml | 12 +- Deployment_Guide/en-US/Kolab_Preparations.xml | 12 +- Deployment_Guide/en-US/LDAP_Installation.xml | 16 +- Deployment_Guide/en-US/Preface.xml | 16 +- Deployment_Guide/en-US/Revision_History.xml | 44 +-- Development_Manual/Makefile | 17 + Development_Manual/en-US/Author_Group.xml | 7 +- Development_Manual/en-US/Book_Info.xml | 43 +-- Development_Manual/en-US/Chapter.xml | 54 +-- Development_Manual/en-US/Development_Manual.xml | 9 +- Development_Manual/en-US/Development_Processes.xml | 39 +++ Development_Manual/en-US/Documentation.xml | 16 + ...ral_Kolab_Server_Components_Packaging_Notes.xml | 5 +- .../Localization_and_Internationalization.xml | 23 ++ .../en-US/Packaging_Kolab_Components.xml | 13 - .../Packaging_Kolab_Server_Components_with_RPM.xml | 73 ----- Development_Manual/en-US/Packaging_with_APT.xml | 361 ++++++++++++++++++++ Development_Manual/en-US/Packaging_with_RPM.xml | 93 ++++++ .../en-US/Part-General_Kolab_Packaging_Notes.xml | 6 +- .../en-US/Part-Kolab_Packaging_with_RPM.xml | 11 - Development_Manual/en-US/Preface.xml | 9 +- Development_Manual/en-US/Revision_History.xml | 44 +-- Development_Manual/en-US/TODO.xml | 20 +- Installation_Guide/Makefile | 17 + Installation_Guide/en-US/About_Kolab_Groupware.xml | 12 +- Installation_Guide/en-US/Author_Group.xml | 5 +- Installation_Guide/en-US/Book_Info.xml | 9 +- Installation_Guide/en-US/Cyrus_IMAP.xml | 155 +++++---- Installation_Guide/en-US/Installation_Guide.xml | 13 +- .../en-US/Installation_Introduction.xml | 2 +- .../en-US/Kolab_Initial_Configuration.xml | 21 +- .../en-US/Kolab_Server_on_Enterprise_Linux.xml | 57 +++- .../en-US/Kolab_Systems_Software_Repositories.xml | 59 +++- .../en-US/Kolab_Webclient_Installation.xml | 5 +- .../en-US/Obtaining_Kolab_Software.xml | 362 +++++++++++++++++++++ .../en-US/Part-Kolab_Server_Installation.xml | 9 +- Installation_Guide/en-US/Preface.xml | 11 +- Installation_Guide/en-US/Preparing_the_System.xml | 26 +- Installation_Guide/en-US/Revision_History.xml | 46 +-- Installation_Guide/publican.cfg | 1 + Makefile | 50 +-- 58 files changed, 1671 insertions(+), 449 deletions(-) create mode 100644 Administrator_Guide/Makefile create mode 100644 Administrator_Guide/en-US/Administrator_Guide.ent create mode 100644 Administrator_Guide/en-US/Administrator_Guide.xml create mode 100644 Administrator_Guide/en-US/Author_Group.xml create mode 100644 Administrator_Guide/en-US/Book_Info.xml create mode 100644 Administrator_Guide/en-US/Chapter.xml create mode 100644 Administrator_Guide/en-US/Preface.xml create mode 100644 Administrator_Guide/en-US/Revision_History.xml create mode 100644 Administrator_Guide/en-US/chap-About_Kolab_Groupware.xml create mode 100644 Administrator_Guide/en-US/images/icon.svg create mode 100644 Administrator_Guide/publican.cfg create mode 100644 Common_Content/en-US/Author_Group.xml create mode 100644 Deployment_Guide/Makefile create mode 100644 Development_Manual/Makefile create mode 100644 Development_Manual/en-US/Development_Processes.xml create mode 100644 Development_Manual/en-US/Documentation.xml create mode 100644 Development_Manual/en-US/Localization_and_Internationalization.xml delete mode 100644 Development_Manual/en-US/Packaging_Kolab_Components.xml delete mode 100644 Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml create mode 100644 Development_Manual/en-US/Packaging_with_APT.xml create mode 100644 Development_Manual/en-US/Packaging_with_RPM.xml delete mode 100644 Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml create mode 100644 Installation_Guide/Makefile create mode 100644 Installation_Guide/en-US/Obtaining_Kolab_Software.xml 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 @@ + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + + + + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + + Jeroen + van Meeuwen + RHCE + Kolab Systems + Engineering + + + vanmeeuwen@kolabsys.com + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Administrator Guide + short description + Kolab + 2.3 + 0 + 0 + + + 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. + + + + + + + + + + + + + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Test Chapter + + This is a test paragraph + +
+ Test Section 1 + + This is a test paragraph in a section + + +
+ +
+ Test Section 2 + + This is a test paragraph in Section 2 + + + + listitem text + + + + + + + + +
+ + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Revision History + + + + 0-0 + Mon Dec 13 2010 + + Dude + McPants + Dude.McPants@example.com + + + + + Initial creation of book by publican + + + + + + + + + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + About Kolab Groupware + + 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. + +
+ Free Software Components + + TODO: Come on, be a little more verbose... + +
+ This documentation + + Describe how this documentation can be modified to custom, internal documentation + + +
+ + +
+ + + + + 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 @@ + + + + + + + + + + + + + + + + + + + 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 @@ + + + + + Jeroen + van Meeuwen + RHCE + Kolab Systems + Engineering + + + vanmeeuwen@kolabsys.com + + + + 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 @@ Jeroen van Meeuwen - + RHCE Kolab Systems - Senior Engineer + Engineering + vanmeeuwen@kolabsys.com + 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; ]> - Deployment Guide - short description - Kolab - 2.3.0 - 0 - 0 - - - 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. - - - - - - - - - - - + Deployment Guide + short description + Kolab + 2.3.0 + 0 + 0 + + + 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. + + + + + + + + + + + + + + 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 @@ - - 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 @@ - +%BOOK_ENTITIES; ]> - Infrastructure 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. -
Authentication and Authorization 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. +
@@ -20,6 +21,7 @@ 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. +
@@ -27,6 +29,7 @@ para +
@@ -34,6 +37,9 @@ para +
+ + 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 @@ - +%BOOK_ENTITIES; ]> - Kolab Preparations para - -
+
Loading the LDAP Schema para +
@@ -20,6 +21,9 @@ para +
+ + 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 @@ - +%BOOK_ENTITIES; ]> - LDAP Installation para - @@ -16,14 +16,18 @@ # yum install 389-ds + Copy the schema file /usr/share/kolab/ldap/kolab.389ds.schema to the appropriate schema directory; - # cp -a /usr/share/kolab/ldap/kolab.389ds-schema.ldif /etc/dirsrv/schema/66kolab.ldif + +# cp -a /usr/share/kolab/ldap/kolab.389ds-schema.ldif /etc/dirsrv/schema/66kolab.ldif + + @@ -32,7 +36,11 @@ # setup-ds-admin.pl + + + + 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 - -
+
Introduction para +
- - - + + 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; ]> - Revision History - - - - 0 - Sat Aug 7 2010 - - Dude - McPants - Dude.McPants@example.com - - - - Initial creation of book by publican - - - - - + Revision History + + + + 0 + Sat Aug 7 2010 + + Dude + McPants + Dude.McPants@example.com + + + + + Initial creation of book by publican + + + + + + + + + + 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 @@ Jeroen van Meeuwen - RHCE - + RHCE Kolab Systems - Senior Engineer + Engineering + vanmeeuwen@kolabsys.com + 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; ]> - Development Manual - short description - Kolab - 2.3.0 - 1 - 0 - - - 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. - - - - - - - - - - - + Development Manual + short description + Kolab + 2.3.0 + 1 + 0 + + + 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. + + + + + + + + + + + + + + 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; ]> - Test Chapter - - This is a test paragraph - -
- Test Section 1 - - This is a test paragraph in a section - -
- -
- Test Section 2 - - This is a test paragraph in Section 2 - - - - listitem text - - - - -
+ Test Chapter + + This is a test paragraph + +
+ Test Section 1 + + This is a test paragraph in a section + + +
+ +
+ Test Section 2 + + This is a test paragraph in Section 2 + + + + listitem text + + + + + + + + +
+ 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 @@ - - - - + + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Development Processes + + Development and Release Cycles + + para + + + + + Release and Support Cycles + + para + +
+ Product Series and Platform Support + + 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. + + +
+ + + + + Kolab Enhancement Proposals + + para + + + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Documentation + + Kolab Server + + para + + + + + 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 @@ + %BOOK_ENTITIES; ]> @@ -11,8 +11,11 @@ requires being started after ldap server (standalone) + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Localization and Internationalization + + Desktop Components + + para + + + + + Web Interfaces + + para + + + + + 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 @@ - - -%BOOK_ENTITIES; -]> - - Packaging Kolab Components - - About - - - - 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 @@ - - -%BOOK_ENTITIES; -]> - - Packaging Kolab Server Components with RPM - - Kolab Groupware exists of several components. On the server side, we have: - - - - - - kolab - - - - - FIXME: List the rest of the packages - - - - - -
- kolab-cyrus-imapd - - Requirements: - - - - - - perl-TermReadKey for perl(Term::ReadKey) capabilities - - - The package is required for %{_bindir}/cyradm - - - - -
- -
- Checklist Notes - - - - - Creation of user - - - - - chkconfig --add services - - - - - Set debug to 9 (/etc/kolab/kolab.globals) - - - - - Set loglevel to 15 (/etc/kolab/kolab.globals) - - - - -
- - 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 @@ + + +%BOOK_ENTITIES; +]> + + Packaging with APT + + Prerequisites + + + + + A 64-bit system with Debian Squeeze or later, + + + + + + The following packages: + + + + + + cowbuilder + + + + + + dupload + + + + + + git-buildpackage + + + + + + git-core + + + + + + git-svn + + + + + + pbuilder + + + + + + quilt + + + + + + + + + + + + + + + Not Including Build Requirements + + Note that the list of required packages does not include any build requirements for any of the packages. + + + + + You may install these packages in one go using the following command: + + + +# apt-get -y install cowbuilder dupload fakeroot git-buildpackage \ + git-core git-svn pbuilder quilt + + + + + + Getting Started + + 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. + + + 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. + + + To clone an APT packaging repository, use: + + + +$ git clone git://git.kolabsys.com/git/apt/$package + + + + where $package is one of the packages in . + +
+ APT Packaging GIT Repositories + + The APT packaging GIT repositories live at: . Each source package has its own GIT repository. The following repositories are relevant: + + + + APT Packages + + + <application>cyrus-imapd</application> + + 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: + + + + + + + + Kolab annotation configuration support. + + + + + + Login with uid and/or mail attribute. + + + + + + + + + Additionally, the Kolab version for hosted providers requires Cyrus IMAP 2.4. + + + + + + <application>horde3</application> + + para + + + + + + + + <application>horde4</application> + + para + + + + + + + + <application>kolab-webadmin</application> + + para + + + + + + + + <application>kolab-webclient</application> + + para + + + + + + + + <application>kolabd</application> + + para + + + + + + + + <application>libkolab-perl</application> + + para + + + + + + + + <application>libnet-ldap-perl</application> + + Kolab's perl libraries require a more recent version of libnet-ldap-perl then is available in Debian Lenny. + + + + + + + + <application>php</application> + + Kolab ships IMAP annotation and myrights patches against PHP. + + + + + + + + <application>php-kolab-config</application> + + para + + + + + + + + <application>php-kolab-filter</application> + + para + + + + + + + + <application>php-kolab-format</application> + + para + + + + + + + + <application>php-kolab-freebusy</application> + + para + + + + + + + + <application>php-kolab-resource</application> + + para + + + + + + + + <application>php-kolab-server</application> + + para + + + + + + + + <application>php-kolab-storage</application> + + para + + + + + + + + <application>php-kolab-zpush</application> + + para + + + + + + + + <application>php-net-ldap2</application> + + para + + + + + + + + <application>uw-imap</application> + + para + + + + + + + + + +
+ SCM Branch Policy + + 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). + + + The following naming convention is used for more stabilized distribution version product series: + + + +$distribution / [$codename /] $product_name - $product_version_series + + + + This means that, for example, packaging semantics for Kolab 2.2 specific to Lenny are put in debian/lenny/kolab-2.2, such as, for example, is the case with PHP: where Kolab 2.2 shipped a modified version of php5, built against a modified version of uw-imap, to enable IMAP annotation support. + + +
+ + +
+ + + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Packaging with RPM + + Packaging with RPM + + Kolab Groupware exists of several components. On the server side, we have: + + + + + + kolab + + + + + + FIXME: List the rest of the packages + + + + + + + +
+ kolab-cyrus-imapd + + Requirements: + + + + + + perl-TermReadKey for perl(Term::ReadKey) capabilities + + + The package is required for %{_bindir}/cyradm + + + + + + + + +
+ +
+ Checklist Notes + + + + + Creation of user + + + + + + chkconfig --add services + + + + + + Set debug to 9 (/etc/kolab/kolab.globals) + + + + + + Set loglevel to 15 (/etc/kolab/kolab.globals) + + + + + + + + +
+ + + + + + 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 @@ - + %BOOK_ENTITIES; ]> General Kolab Packaging Notes - + 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 @@ - - -%BOOK_ENTITIES; -]> - - Kolab Packaging with RPM - - - - \ 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 - - - - + 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; ]> - Revision History - - - - 0 - Sun May 16 2010 - - Dude - McPants - Dude.McPants@example.com - - - - Initial creation of book by publican - - - - - + Revision History + + + + 0 + Sun May 16 2010 + + Dude + McPants + Dude.McPants@example.com + + + + + Initial creation of book by publican + + + + + + + + + + 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 @@ + %BOOK_ENTITIES; ]> - + List of things to do @@ -11,41 +11,47 @@ provide a means for kolabd to poll and continue operations as normal, rather then fail on error and stop + the setup program is actually supposed to be called setup-kolab + keep account of steps completed in the setup program, so that we can continue + password prompt on setup should not echo + could not write to /usr/lib64/sasl2/smtpd.conf at /usr/sbin/kolab_bootstrap line 465, <STDIN> line 6. + - 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, <STDIN> 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, <STDIN> line 7. + - 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 + + + 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 @@ %BOOK_ENTITIES; ]> - + About Kolab Groupware 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. - -
+
Free Software Components TODO: Come on, be a little more verbose... - -
+
This documentation Describe how this documentation can be modified to custom, internal documentation +
+
+ + 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 @@ Jeroen van Meeuwen - RHCE - + RHCE Kolab Systems Engineering + vanmeeuwen@kolabsys.com + 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 @@ %BOOK_ENTITIES; ]> - - Installation Manual + + Installation Guide The Kolab Groupware Solution Kolab - 2.3.0 + 2.3 1 0 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. + + + 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 @@ - %BOOK_ENTITIES; ]> - + Cyrus IMAP Instructions on Using Cyrus IMAP as the Kolab IMAP Server 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. - - + + Installation of Cyrus IMAP - + Kolab Systems Repository 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 . + 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 . - -
+ +
Installation The package name for Cyrus IMAP is kolab-cyrus-imapd. - - + Installation Instructions for APT-based Systems To install Cyrus IMAP on APT-based systems such as Debian and Ubuntu Long-Term Support, execute the following command; + - # apt-get -y install kolab-cyrus-imapd - - +# apt-get -y install kolab-cyrus-imapd + + + Installation Instructions for RPM-based Systems To install Cyrus IMAP on RPM-based systems such as Fedora, Red Hat, CentOS and Scientific Linux, execute the following command; + - # yum -y install kolab-cyrus-imapd - +# yum -y install kolab-cyrus-imapd + + kolab-cyrus-imapd will be installed on the system, including any software Cyrus IMAP depends on. @@ -58,9 +61,10 @@
- - + + + Configuration of Cyrus IMAP The following configuration files are installed on the system: @@ -68,123 +72,133 @@ - + &CYRUS_CONFIG; - 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 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 for more details if you seek to secure communications. + + - + &CYRUS_IMAPD_CONFIG; - The behaviour of Cyrus IMAP is controlled using &CYRUS_IMAPD_CONFIG;. Please refer to for standard configurations, and for a list of options. + The behaviour of Cyrus IMAP is controlled using &CYRUS_IMAPD_CONFIG;. Please refer to for standard configurations, and for a list of options. + + - + &CYRUS_ANNOTATIONS_CONFIG; &CYRUS_ANNOTATIONS_CONFIG; contains the Kolab annotations for use with the Kolab Groupware Solution. + + - + System Configuration Defaults - 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 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 for more information on available options. - - + + APT-based Systems On APT-based Systems, please use &APT_CYRUS_SYS_DEFAULTS; as the system configuration defaults file. - - + + RPM-based Systems On RPM-based Systems, please use &RPM_CYRUS_SYS_DEFAULTS; as the system configuration defaults file. - + System Configuration Defaults The system configuration defaults normally suffice, and should not have to be altered unless you have very specific requirements. + + - + In addition to these configuration files, the following directories are used for Cyrus IMAP by default: - - + &CYRUS_CONFIGDIR; Cyrus IMAP stores it's databases and transactional data here, such as Sieve scripts. + + - + &CYRUS_SPOOLDIR; - The primary (default) IMAP partition. Please refer to for + The primary (default) IMAP partition. Please refer to for + + + - + TODO: Quick To Go: Small deployments - - + Configuring IMAP TODO: While the defaults shipped in the Kolab Systems software packages are good to go for most common Cyrus IMAP deployments, ... - - + + Securing Cyrus IMAP Communications TODO: Describe - - + + IMAP Partitions TODO - - + + IMAP Option Reference TODO: list/table of options - - + System Configuration Defaults 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 @@ - + <literal>CYRUS_CONFIG</literal> The location of the Cyrus master configuration file, &CYRUS_CONFIG; by default. Valid options are existing Cyrus configuration files. + + - + <literal>IMAPD_CONFIG</literal> 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. + + - + <literal>LISTENQUEUE</literal> The size of the listen queue. 32 by default. Only integers are valid. + TODO: Figure out the maximum length/size of LISTENQUEUE + - + <literal>CYRUS_VERBOSE</literal> What cyrus-master process. Not set by default. + TODO: Figure out useful values for CYRUS_VERBOSE + - + <literal>CYRUS_OPTIONS</literal> Additional options to pass on to the cyrus-master process. Not set by default. To get a list of valid options, please refer to the cyrus-master(8) man page. + + + + - - + + Creating a Cyrus Murder Setup TODO - -
+
Setting up the master update server TODO - -
+
Choosing the mupdate mode TODO: on unified, replica, etc. +
+
- - + + Creating an IMAP Backend Server TODO - -
+
Hooking in a new backend server into a murder setup TODO +
- - + + Creating an IMAP Frontend Server TODO - -
+
Hooking in a new frontend server into a murder setup TODO +
+ 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 @@ - - - - - +// --> + 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 @@ %BOOK_ENTITIES; ]> - + Installation Introduction 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 @@ %BOOK_ENTITIES; ]> - + Kolab Initial Configuration para @@ -14,24 +14,30 @@ Run, as root: - # setup-kolab.pl + +# setup-kolab.pl + This will start a configuration dialog. + Yet Another Step... + + -
+
Manual Configuration this section goes to manual configuration of Kolab (this is what setup-kolab.pl should actually be doing) + 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 +
-
+
Configuration through Puppet Assuming that you have an existing Puppet environment, you can clone the kolab puppet module: - $ git clone git://git.puppetmanaged.org/puppet/kolab + +$ git clone git://git.puppetmanaged.org/puppet/kolab + +
+ 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 @@ %BOOK_ENTITIES; ]> - + Kolab Server on Enterprise Linux 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 @@ Red Hat Enterprise Linux 5 (recommended) + CentOS 5 + + - -
+ +
Prerequisites This section lists the prerequisites for a Kolab Groupware server system on Enterprise Linux. - -
+
Server System These are the system prerequisites for a supported Kolab server installation on Enterprise Linux. - + System Resources FIXME: 4GB of RAM + FIXME: Intel or AMD 64-bit 2.4Ghz+ + + + - + Operating System Resources @@ -62,16 +68,23 @@ cyrus-imapd + openldap + + + + + + You can verify whether any of those packages is installed using the following command: @@ -85,9 +98,10 @@ FIXME: Provide a URL for the migration manual +
-
+
YUM Repositories A Kolab Groupware server system requires the following YUM repositories to be installed in complete, available and enabled; @@ -99,42 +113,51 @@ The Extra Packages for Enterprise Linux (EPEL) repository. - For more details on the installation and configuration of the EPEL repository, please refer to . + For more details on the installation and configuration of the EPEL repository, please refer to . + The Kolab Groupware repository. - For more details on the installation and configuration of the Kolab repository, please refer to . + For more details on the installation and configuration of the Kolab repository, please refer to . + + + +
+
-
+
Repository Configuration - -
+
EPEL Repository Configuration FIXME: Something on EPEL repository configuration +
-
+
Kolab Repository Configuration FIXME: Something on Kolab repository configuration +
+ +
-
+
Standalone Server Installation When the prerequisite requirements are met, install the Kolab Groupware Server components: @@ -143,9 +166,11 @@ yum install kolab - This will install a completely standalone Kolab Groupware server. Continue to + This will install a completely standalone Kolab Groupware server. Continue to +
+ 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 @@ %BOOK_ENTITIES; ]> - + Kolab Systems Software Repositories Kolab Systems provides staged repositories for the community and its customers. - -
+
Platform Support TODO: Describe what is supported when using which edition +
-
+
Repository Configuration - -
+
Community Edition TODO: Insert notice about the community edition. - -
+
Debian Squeeze @@ -33,26 +31,36 @@ For the public, community version of Kolab &PRODUCT_VERSION; software packages for Debian Squeeze, add the following two lines to /etc/apt/sources.list: - deb http://mirror.kolabsys.com/pub/debian/kolab-&PRODUCT_VERSION;/ squeeze release updates + +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 + + To ensure the Kolab packages have priority over the Debian packages, such as must be the case for PHP as well as Cyrus IMAP, please make sure the APT preferences pin the mirror.kolabsys.com origin as a preferred source. Put the following in /etc/apt/preferences: - Package: * + +Package: * Pin: origin mirror.kolabsys.com Pin-Priority: 501 + + + + +
+
-
+
Enterprise Edition TODO: Insert benefit of purchasing subscriptions to enterprise editions. @@ -63,8 +71,7 @@ Pin-Priority: 501 TODO: Describe exporting and using as browser cert. - -
+
Enterprise Edition on APT-based Systems TODO: Describe the exact procedure to enable the secure communications. @@ -72,9 +79,10 @@ Pin-Priority: 501 TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other. +
-
+
Enterprise Edition on RPM-based Systems TODO: Describe the exact procedure to enable the secure communications. @@ -82,9 +90,10 @@ Pin-Priority: 501 TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other. +
-
+
Debian Squeeze @@ -92,42 +101,58 @@ Pin-Priority: 501 For the supported, certified enterprise version of Kolab &PRODUCT_VERSION; software packages for Debian Squeeze, add the following two lines to /etc/apt/sources.list: - deb http://mirror.kolabsys.com/debian/kolab-&PRODUCT_VERSION;/ squeeze release updates + +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 + + + + +
+
-
+
Red Hat Enterprise Linux 5 Obtain the -release + TODO: Security and Integrity verification instructions + TODO: Install instructions + Verification instructions + + + +
+
+ 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 @@ %BOOK_ENTITIES; ]> - + Kolab Webclient Installation para @@ -14,8 +14,11 @@ how to configure the webserver to show the web interface over SSL only + + + 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 @@ + + +%BOOK_ENTITIES; +]> + + Obtaining Kolab Software + + 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; + + + + + + (soon to be deprecated) + + + + + + or + + + + + + + +
+ Installation with OpenPKG + + 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 —including most Linux-based operatig systems. + + + While there certainly are advantages to OpenPKG, it also has a few major downsides: + + + OpenPKG has become proprietary. + Native packaging efforts have been undertaken by various community members. + Kolab Groupware through OpenPKG maintained its own copy of the complete dependency stack. + + + + OpenPKG Deprecation Warning + + 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. + + + +
+ Obtaining the OpenPKG RPMs + + Download the OpenPKG RPMs from one of the mirrors listed on to a local directory: + + + Downloading OpenPKG RPMs + + + +$ mkdir -p /tmp/kolab-install/ +$ cd /tmp/kolab-install/ +$ wget -r -l1 -nd --no-parent \ + http://files.kolab.org/server/release/kolab-server-&PRODUCT_VERSION;/ix86-debian5.0/ + + + + + + + Optionally verify the integrity of the files downloaded with Pretty Good Privacy (PGP): + + + +$ gpg --keyserver hkp://subkeys.pgp.net --recv-key C43E1A3E +$ gpg --verify SHA1SUMS.sig +$ sha1sum -c SHA1SUMS + + + + + + + + + To install using the OpenPKG RPM packages obtained, please; + + + Installation Using OpenPKG RPM Packages + + + Become the root superuser or otherwise obtain superuser privileges. + + + + + + Navigate into the directory containing the OpenPKG RPM packages: + + + +# cd /tmp/kolab-install/ + + + + + + + Execute the install-kolab.sh script: + + + +# sh install-kolab.sh 2>&1 | tee kolab-install.log + + + + + + + + +
+ + +
+ +
+ Installation with APT Packages + + APT pakages are provided for the following GNU/Linux distributions, and distribution versions: + + + + + + Debian + + + Lenny (Debian 4.0), until approximately Q1 2012 + Squeeze (Debian 5.0), until approximately Q1 2014 + + + + + + + + + + + Ubuntu + + Lucid, Maverick, Natty + + + + + + + + + + This should really be a table, and include version numbers as well as EOL dates +
+ Debian + + + + For the public, community version of Kolab &PRODUCT_VERSION; software packages for Debian Squeeze, add the following two lines to /etc/apt/sources.list: + + + +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 + + + + + + + To ensure the Kolab packages have priority over the Debian packages, such as must be the case for PHP as well as Cyrus IMAP, please make sure the APT preferences pin the mirror.kolabsys.com origin as a preferred source. Put the following in /etc/apt/preferences: + + + +Package: * +Pin: origin mirror.kolabsys.com +Pin-Priority: 501 + + + + + + + + + Debian Volatile Repositories + + It is critically important to consider also enabling the volatile repository for your Debian version, to enable updates for components such as clamav. + + + To enable the volatile repository for Debian Lenny, include the following line in /etc/apt/sources.list: + + + +deb http://volatile.debian.org/debian-volatile stable/volatile main + + + + + +
+ +
+ Ubuntu + + + + For the public, community version of Kolab &PRODUCT_VERSION; software packages for Ubuntu Natty, add the following two lines to /etc/apt/sources.list: + + + +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 + + + + + + + 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 pin the mirror.kolabsys.com origin as a preferred source. Put the following in /etc/apt/preferences: + + + +Package: * +Pin: origin mirror.kolabsys.com +Pin-Priority: 501 + + + + + + + + +
+ + +
+ +
+ Installation with RPM Packages + + para + + +
+ +
+ Repository Configuration +
+ Community Edition + + TODO: Insert notice about the community edition. + + +
+ +
+ Enterprise Edition + + TODO: Insert benefit of purchasing subscriptions to enterprise editions. + + + TODO: Insert procedure to obtain mirror client certificate per system, and under what conditions excemptions are being made for a wildcard or customer cert. + + + TODO: Describe exporting and using as browser cert. + +
+ Enterprise Edition on APT-based Systems + + TODO: Describe the exact procedure to enable the secure communications. + + + TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other. + + +
+ +
+ Enterprise Edition on RPM-based Systems + + TODO: Describe the exact procedure to enable the secure communications. + + + TODO: Describe the exact procedure to prioritize Kolab Systems packages over any other. + + +
+ +
+ Debian Squeeze + + + + For the supported, certified enterprise version of Kolab &PRODUCT_VERSION; software packages for Debian Squeeze, add the following two lines to /etc/apt/sources.list: + + + +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 + + + + + + + + +
+ + +
+ +
+ Red Hat Enterprise Linux 5 + + + + Obtain the -release + + + + + + TODO: Security and Integrity verification instructions + + + + + + TODO: Install instructions + + + + + + Verification instructions + + + + + + + +
+ + +
+ + + + 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 @@ - %BOOK_ENTITIES; ]> - + Kolab Groupware Server Installation Installation Manual for Kolab Groupware on server systems - - - \ No newline at end of file + + 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 @@ %BOOK_ENTITIES; ]> - - Preface - - - - + + 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 @@ %BOOK_ENTITIES; ]> - + Preparing the System The installation of Kolab requires you prepare the system for installation. - -
+
Prerequisites The installation of Kolab requires one of the following operating system versions: @@ -18,19 +17,24 @@ - Red Hat Enterprise Linux 5, see also . + Red Hat Enterprise Linux 5, see also . + FIXME: Other supported Operating System versions + + + +
-
+
Recommendations @@ -38,12 +42,16 @@ We recommend a x86_64 capable version of the Operating System + + + +
-
+
Enterprise Linux @@ -51,15 +59,21 @@ No user or group with ID 412 may exist on the system prior to the installation of Kolab. + No user or group with the name kolab may exist on the system prior to the installation of Kolab. + + + +
+ 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 @@ %BOOK_ENTITIES; ]> - - Revision History - - - - 0 - Sun May 16 2010 - - Dude - McPants - Dude.McPants@example.com - - - - Initial creation of book by publican - - - - - + + Revision History + + + + 0 + Sun May 16 2010 + + Dude + McPants + Dude.McPants@example.com + + + + + Initial creation of book by publican + + + + + + + + + + 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]+)$(VERSION)