From e38dad55bcb9eb40b56e12e4f41e3cc3bc6edfa0 Mon Sep 17 00:00:00 2001 From: "Jeroen van Meeuwen (Ergo Project)" Date: Wed, 8 Sep 2010 23:05:15 +0200 Subject: Initial commit --- .gitignore | 1 + Deployment_Guide/en-US/Author_Group.xml | 17 ++ Deployment_Guide/en-US/Book_Info.xml | 28 ++ Deployment_Guide/en-US/Deployment_Guide.ent | 4 + Deployment_Guide/en-US/Deployment_Guide.xml | 16 ++ Deployment_Guide/en-US/Infrastructure.xml | 39 +++ Deployment_Guide/en-US/Kolab_Preparations.xml | 25 ++ Deployment_Guide/en-US/LDAP_Installation.xml | 38 +++ Deployment_Guide/en-US/Preface.xml | 29 ++ Deployment_Guide/en-US/Revision_History.xml | 27 ++ .../en-US/images/Cyrus_Murder_Servers.dia | Bin 0 -> 960 bytes Deployment_Guide/publican.cfg | 7 + Development_Manual/en-US/Author_Group.xml | 18 ++ Development_Manual/en-US/Book_Info.xml | 28 ++ Development_Manual/en-US/Chapter.xml | 33 +++ Development_Manual/en-US/Development_Manual.ent | 4 + Development_Manual/en-US/Development_Manual.xml | 16 ++ ...ral_Kolab_Server_Components_Packaging_Notes.xml | 19 ++ .../en-US/Packaging_Kolab_Components.xml | 13 + .../Packaging_Kolab_Server_Components_with_RPM.xml | 73 +++++ .../en-US/Part-General_Kolab_Packaging_Notes.xml | 11 + .../en-US/Part-Kolab_Packaging_with_RPM.xml | 11 + Development_Manual/en-US/Preface.xml | 13 + Development_Manual/en-US/Revision_History.xml | 27 ++ Development_Manual/en-US/TODO.xml | 52 ++++ Development_Manual/publican.cfg | 7 + .../en-US/About_Kolab_Groupware.xml | 28 ++ Installation_Manual/en-US/Author_Group.xml | 18 ++ Installation_Manual/en-US/Book_Info.xml | 28 ++ Installation_Manual/en-US/Cyrus_IMAP.xml | 298 +++++++++++++++++++++ .../en-US/Installation_Introduction.xml | 12 + Installation_Manual/en-US/Installation_Manual.ent | 34 +++ Installation_Manual/en-US/Installation_Manual.xml | 21 ++ .../en-US/Kolab_Initial_Configuration.xml | 55 ++++ .../en-US/Kolab_Server_on_Enterprise_Linux.xml | 151 +++++++++++ .../en-US/Kolab_Systems_Software_Repositories.xml | 123 +++++++++ .../en-US/Kolab_Webclient_Installation.xml | 21 ++ .../en-US/Part-Kolab_Server_Installation.xml | 16 ++ Installation_Manual/en-US/Preface.xml | 13 + Installation_Manual/en-US/Preparing_the_System.xml | 65 +++++ Installation_Manual/en-US/Revision_History.xml | 27 ++ Installation_Manual/publican.cfg | 7 + Makefile | 41 +++ 43 files changed, 1514 insertions(+) create mode 100644 .gitignore create mode 100644 Deployment_Guide/en-US/Author_Group.xml create mode 100644 Deployment_Guide/en-US/Book_Info.xml create mode 100644 Deployment_Guide/en-US/Deployment_Guide.ent create mode 100644 Deployment_Guide/en-US/Deployment_Guide.xml create mode 100644 Deployment_Guide/en-US/Infrastructure.xml create mode 100644 Deployment_Guide/en-US/Kolab_Preparations.xml create mode 100644 Deployment_Guide/en-US/LDAP_Installation.xml create mode 100644 Deployment_Guide/en-US/Preface.xml create mode 100644 Deployment_Guide/en-US/Revision_History.xml create mode 100644 Deployment_Guide/en-US/images/Cyrus_Murder_Servers.dia create mode 100644 Deployment_Guide/publican.cfg create mode 100644 Development_Manual/en-US/Author_Group.xml create mode 100644 Development_Manual/en-US/Book_Info.xml create mode 100644 Development_Manual/en-US/Chapter.xml create mode 100644 Development_Manual/en-US/Development_Manual.ent create mode 100644 Development_Manual/en-US/Development_Manual.xml create mode 100644 Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml create mode 100644 Development_Manual/en-US/Packaging_Kolab_Components.xml create mode 100644 Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml create mode 100644 Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml create mode 100644 Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml create mode 100644 Development_Manual/en-US/Preface.xml create mode 100644 Development_Manual/en-US/Revision_History.xml create mode 100644 Development_Manual/en-US/TODO.xml create mode 100644 Development_Manual/publican.cfg create mode 100644 Installation_Manual/en-US/About_Kolab_Groupware.xml create mode 100644 Installation_Manual/en-US/Author_Group.xml create mode 100644 Installation_Manual/en-US/Book_Info.xml create mode 100644 Installation_Manual/en-US/Cyrus_IMAP.xml create mode 100644 Installation_Manual/en-US/Installation_Introduction.xml create mode 100644 Installation_Manual/en-US/Installation_Manual.ent create mode 100644 Installation_Manual/en-US/Installation_Manual.xml create mode 100644 Installation_Manual/en-US/Kolab_Initial_Configuration.xml create mode 100644 Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml create mode 100644 Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml create mode 100644 Installation_Manual/en-US/Kolab_Webclient_Installation.xml create mode 100644 Installation_Manual/en-US/Part-Kolab_Server_Installation.xml create mode 100644 Installation_Manual/en-US/Preface.xml create mode 100644 Installation_Manual/en-US/Preparing_the_System.xml create mode 100644 Installation_Manual/en-US/Revision_History.xml create mode 100644 Installation_Manual/publican.cfg create mode 100644 Makefile diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..454f39e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*/tmp/ diff --git a/Deployment_Guide/en-US/Author_Group.xml b/Deployment_Guide/en-US/Author_Group.xml new file mode 100644 index 0000000..104661b --- /dev/null +++ b/Deployment_Guide/en-US/Author_Group.xml @@ -0,0 +1,17 @@ + + +%BOOK_ENTITIES; +]> + + + Jeroen + van Meeuwen + + Kolab Systems + Senior Engineer + + vanmeeuwen@kolabsys.com + + + diff --git a/Deployment_Guide/en-US/Book_Info.xml b/Deployment_Guide/en-US/Book_Info.xml new file mode 100644 index 0000000..aee380c --- /dev/null +++ b/Deployment_Guide/en-US/Book_Info.xml @@ -0,0 +1,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. + + + + + + + + + + + + + diff --git a/Deployment_Guide/en-US/Deployment_Guide.ent b/Deployment_Guide/en-US/Deployment_Guide.ent new file mode 100644 index 0000000..1b45b53 --- /dev/null +++ b/Deployment_Guide/en-US/Deployment_Guide.ent @@ -0,0 +1,4 @@ + + + + diff --git a/Deployment_Guide/en-US/Deployment_Guide.xml b/Deployment_Guide/en-US/Deployment_Guide.xml new file mode 100644 index 0000000..f0fedc7 --- /dev/null +++ b/Deployment_Guide/en-US/Deployment_Guide.xml @@ -0,0 +1,16 @@ + + +%BOOK_ENTITIES; +]> + + + + + + + + + + + diff --git a/Deployment_Guide/en-US/Infrastructure.xml b/Deployment_Guide/en-US/Infrastructure.xml new file mode 100644 index 0000000..55fb43f --- /dev/null +++ b/Deployment_Guide/en-US/Infrastructure.xml @@ -0,0 +1,39 @@ + + + + + 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. + +
+ +
+ Domain Name System + + 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. + +
+ +
+ Scalability + + para + +
+ +
+ Storage + + para + +
+ + diff --git a/Deployment_Guide/en-US/Kolab_Preparations.xml b/Deployment_Guide/en-US/Kolab_Preparations.xml new file mode 100644 index 0000000..6a4ba7b --- /dev/null +++ b/Deployment_Guide/en-US/Kolab_Preparations.xml @@ -0,0 +1,25 @@ + + + + + Kolab Preparations + + para + + +
+ Loading the LDAP Schema + + para + +
+ +
+ System Users + + para + +
+ + diff --git a/Deployment_Guide/en-US/LDAP_Installation.xml b/Deployment_Guide/en-US/LDAP_Installation.xml new file mode 100644 index 0000000..cf1e040 --- /dev/null +++ b/Deployment_Guide/en-US/LDAP_Installation.xml @@ -0,0 +1,38 @@ + + + + + LDAP Installation + + para + + + + + + Install the 389-ds package from EPEL or through Red Hat Enterprise DS software channel; + + + # 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 + + + + + Run the Directory Server setup; + + + # setup-ds-admin.pl + + + + + diff --git a/Deployment_Guide/en-US/Preface.xml b/Deployment_Guide/en-US/Preface.xml new file mode 100644 index 0000000..a69ff18 --- /dev/null +++ b/Deployment_Guide/en-US/Preface.xml @@ -0,0 +1,29 @@ + + +%BOOK_ENTITIES; +]> + + Preface + +
+ Introduction + + para + +
+ + + + + + + diff --git a/Deployment_Guide/en-US/Revision_History.xml b/Deployment_Guide/en-US/Revision_History.xml new file mode 100644 index 0000000..5fba8cc --- /dev/null +++ b/Deployment_Guide/en-US/Revision_History.xml @@ -0,0 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + Revision History + + + + 0 + Sat Aug 7 2010 + + Dude + McPants + Dude.McPants@example.com + + + + Initial creation of book by publican + + + + + + + diff --git a/Deployment_Guide/en-US/images/Cyrus_Murder_Servers.dia b/Deployment_Guide/en-US/images/Cyrus_Murder_Servers.dia new file mode 100644 index 0000000..10e10eb Binary files /dev/null and b/Deployment_Guide/en-US/images/Cyrus_Murder_Servers.dia differ diff --git a/Deployment_Guide/publican.cfg b/Deployment_Guide/publican.cfg new file mode 100644 index 0000000..2a07d64 --- /dev/null +++ b/Deployment_Guide/publican.cfg @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Sun Aug 8 01:00:45 2010 + +xml_lang: en-US +type: Book +brand: common + diff --git a/Development_Manual/en-US/Author_Group.xml b/Development_Manual/en-US/Author_Group.xml new file mode 100644 index 0000000..98ecc97 --- /dev/null +++ b/Development_Manual/en-US/Author_Group.xml @@ -0,0 +1,18 @@ + + +%BOOK_ENTITIES; +]> + + + Jeroen + van Meeuwen + RHCE + + Kolab Systems + Senior Engineer + + vanmeeuwen@kolabsys.com + + + diff --git a/Development_Manual/en-US/Book_Info.xml b/Development_Manual/en-US/Book_Info.xml new file mode 100644 index 0000000..e129ee3 --- /dev/null +++ b/Development_Manual/en-US/Book_Info.xml @@ -0,0 +1,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. + + + + + + + + + + + + + diff --git a/Development_Manual/en-US/Chapter.xml b/Development_Manual/en-US/Chapter.xml new file mode 100644 index 0000000..056487f --- /dev/null +++ b/Development_Manual/en-US/Chapter.xml @@ -0,0 +1,33 @@ + + +%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/Development_Manual/en-US/Development_Manual.ent b/Development_Manual/en-US/Development_Manual.ent new file mode 100644 index 0000000..1181807 --- /dev/null +++ b/Development_Manual/en-US/Development_Manual.ent @@ -0,0 +1,4 @@ + + + + diff --git a/Development_Manual/en-US/Development_Manual.xml b/Development_Manual/en-US/Development_Manual.xml new file mode 100644 index 0000000..dede735 --- /dev/null +++ b/Development_Manual/en-US/Development_Manual.xml @@ -0,0 +1,16 @@ + + +%BOOK_ENTITIES; +]> + + + + + + + + + + + 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 new file mode 100644 index 0000000..2bc0392 --- /dev/null +++ b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml @@ -0,0 +1,19 @@ + + +%BOOK_ENTITIES; +]> + + General Kolab Server Components Packaging Notes + + + + + requires being started after ldap server (standalone) + + + + + + + diff --git a/Development_Manual/en-US/Packaging_Kolab_Components.xml b/Development_Manual/en-US/Packaging_Kolab_Components.xml new file mode 100644 index 0000000..2dae317 --- /dev/null +++ b/Development_Manual/en-US/Packaging_Kolab_Components.xml @@ -0,0 +1,13 @@ + + +%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 new file mode 100644 index 0000000..5353477 --- /dev/null +++ b/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml @@ -0,0 +1,73 @@ + + +%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/Part-General_Kolab_Packaging_Notes.xml b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml new file mode 100644 index 0000000..19e6af4 --- /dev/null +++ b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml @@ -0,0 +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 new file mode 100644 index 0000000..72a9502 --- /dev/null +++ b/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml @@ -0,0 +1,11 @@ + + +%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 new file mode 100644 index 0000000..e68be4c --- /dev/null +++ b/Development_Manual/en-US/Preface.xml @@ -0,0 +1,13 @@ + + +%BOOK_ENTITIES; +]> + + Preface + + + + + + diff --git a/Development_Manual/en-US/Revision_History.xml b/Development_Manual/en-US/Revision_History.xml new file mode 100644 index 0000000..99e8c7d --- /dev/null +++ b/Development_Manual/en-US/Revision_History.xml @@ -0,0 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + 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 new file mode 100644 index 0000000..fd74174 --- /dev/null +++ b/Development_Manual/en-US/TODO.xml @@ -0,0 +1,52 @@ + + +%BOOK_ENTITIES; +]> + + List of things to do + + + + + 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. + + + + + 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/Development_Manual/publican.cfg b/Development_Manual/publican.cfg new file mode 100644 index 0000000..9b50407 --- /dev/null +++ b/Development_Manual/publican.cfg @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Sun May 16 19:25:55 2010 + +xml_lang: en-US +type: Book +brand: common + diff --git a/Installation_Manual/en-US/About_Kolab_Groupware.xml b/Installation_Manual/en-US/About_Kolab_Groupware.xml new file mode 100644 index 0000000..de5f82c --- /dev/null +++ b/Installation_Manual/en-US/About_Kolab_Groupware.xml @@ -0,0 +1,28 @@ + + +%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_Manual/en-US/Author_Group.xml b/Installation_Manual/en-US/Author_Group.xml new file mode 100644 index 0000000..24ea95e --- /dev/null +++ b/Installation_Manual/en-US/Author_Group.xml @@ -0,0 +1,18 @@ + + +%BOOK_ENTITIES; +]> + + + Jeroen + van Meeuwen + RHCE + + Kolab Systems + Engineering + + vanmeeuwen@kolabsys.com + + + diff --git a/Installation_Manual/en-US/Book_Info.xml b/Installation_Manual/en-US/Book_Info.xml new file mode 100644 index 0000000..ddad213 --- /dev/null +++ b/Installation_Manual/en-US/Book_Info.xml @@ -0,0 +1,28 @@ + + +%BOOK_ENTITIES; +]> + + Installation Manual + The Kolab Groupware Solution + 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/Installation_Manual/en-US/Cyrus_IMAP.xml b/Installation_Manual/en-US/Cyrus_IMAP.xml new file mode 100644 index 0000000..5546f43 --- /dev/null +++ b/Installation_Manual/en-US/Cyrus_IMAP.xml @@ -0,0 +1,298 @@ + + +%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 . + + + +
+ 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 + + + + 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 + + + + kolab-cyrus-imapd will be installed on the system, including any software Cyrus IMAP depends on. + + + The service cyrus-imapd will not yet be started, as you require configuration first. + + + TODO: We can't automatically configure the software; we don't know where the configuration should come from and any hit is a lucky hit. We also don't know what the system is intended for. Nor can we figure such out. Maybe develop and contruct in the Kolab Systems packaging a means for Cyrus IMAP to in fact be automatically configured using a slipstream command, so that the next step is to verify, not configure. + + +
+ + + + Configuration of Cyrus IMAP + + The following configuration files are installed on the system: + + + + + + &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. + + + + + + &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. + + + + + + &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. + + + + + 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 + + + + + + + + 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); + + + + + + <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_Manual/en-US/Installation_Introduction.xml b/Installation_Manual/en-US/Installation_Introduction.xml new file mode 100644 index 0000000..cd361c8 --- /dev/null +++ b/Installation_Manual/en-US/Installation_Introduction.xml @@ -0,0 +1,12 @@ + + +%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_Manual/en-US/Installation_Manual.ent b/Installation_Manual/en-US/Installation_Manual.ent new file mode 100644 index 0000000..f6400a2 --- /dev/null +++ b/Installation_Manual/en-US/Installation_Manual.ent @@ -0,0 +1,34 @@ + + + + + + + + +/etc/default/cyrus-imapd"> + + + +/etc/sysconfig/cyrus-imapd"> + + + +/etc/cyrus.conf"> +/etc/imapd.conf"> +/etc/imapd.annotations.conf"> +/var/lib/imap"> +/var/spool/imap"> + diff --git a/Installation_Manual/en-US/Installation_Manual.xml b/Installation_Manual/en-US/Installation_Manual.xml new file mode 100644 index 0000000..dfcb359 --- /dev/null +++ b/Installation_Manual/en-US/Installation_Manual.xml @@ -0,0 +1,21 @@ + + +%BOOK_ENTITIES; +]> + + + + + + + + + + + + + diff --git a/Installation_Manual/en-US/Kolab_Initial_Configuration.xml b/Installation_Manual/en-US/Kolab_Initial_Configuration.xml new file mode 100644 index 0000000..fb08f1c --- /dev/null +++ b/Installation_Manual/en-US/Kolab_Initial_Configuration.xml @@ -0,0 +1,55 @@ + + +%BOOK_ENTITIES; +]> + + Kolab Initial Configuration + + para + + + + + Run, as root: + + + # 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 +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 + +
+ + + diff --git a/Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml b/Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml new file mode 100644 index 0000000..66f9e3b --- /dev/null +++ b/Installation_Manual/en-US/Kolab_Server_on_Enterprise_Linux.xml @@ -0,0 +1,151 @@ + + +%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: + + + + + + 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 + + + The following software packages may not be installed on the Kolab Groupware server system: + + + + + + cyrus-imapd + + + + + openldap + + + + + + + + + You can verify whether any of those packages is installed using the following command: + + + rpm -qv <package-name> + + + Should any of the aforementioned packages be installed on the Kolab Groupware server system already, please verify whether they have been used before removing them. Should the packages have been used, consider moving to Kolab Groupware on this server system a migration and continue with the migration manual available at: + + + 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; + + + + + + The Extra Packages for Enterprise Linux (EPEL) repository. + + + 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 . + + + + +
+ +
+ +
+ 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: + + + yum install kolab + + + This will install a completely standalone Kolab Groupware server. Continue to + +
+ + + diff --git a/Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml b/Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml new file mode 100644 index 0000000..847b27a --- /dev/null +++ b/Installation_Manual/en-US/Kolab_Systems_Software_Repositories.xml @@ -0,0 +1,123 @@ + + +%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 + + + + 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 + + + +
+ +
+ +
+ 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_Manual/en-US/Kolab_Webclient_Installation.xml b/Installation_Manual/en-US/Kolab_Webclient_Installation.xml new file mode 100644 index 0000000..0b8b0db --- /dev/null +++ b/Installation_Manual/en-US/Kolab_Webclient_Installation.xml @@ -0,0 +1,21 @@ + + +%BOOK_ENTITIES; +]> + + Kolab Webclient Installation + + para + + + + + + how to configure the webserver to show the web interface over SSL only + + + + + + diff --git a/Installation_Manual/en-US/Part-Kolab_Server_Installation.xml b/Installation_Manual/en-US/Part-Kolab_Server_Installation.xml new file mode 100644 index 0000000..4c621cb --- /dev/null +++ b/Installation_Manual/en-US/Part-Kolab_Server_Installation.xml @@ -0,0 +1,16 @@ + + +%BOOK_ENTITIES; +]> + + Kolab Groupware Server Installation + Installation Manual for Kolab Groupware on server systems + + + + + + + + \ No newline at end of file diff --git a/Installation_Manual/en-US/Preface.xml b/Installation_Manual/en-US/Preface.xml new file mode 100644 index 0000000..3737a00 --- /dev/null +++ b/Installation_Manual/en-US/Preface.xml @@ -0,0 +1,13 @@ + + +%BOOK_ENTITIES; +]> + + Preface + + + + + + diff --git a/Installation_Manual/en-US/Preparing_the_System.xml b/Installation_Manual/en-US/Preparing_the_System.xml new file mode 100644 index 0000000..0cac0f8 --- /dev/null +++ b/Installation_Manual/en-US/Preparing_the_System.xml @@ -0,0 +1,65 @@ + + +%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: + + + + + + Red Hat Enterprise Linux 5, see also . + + + + + FIXME: Other supported Operating System versions + + + + +
+ +
+ Recommendations + + + + + We recommend a x86_64 capable version of the Operating System + + + + +
+ +
+ Enterprise Linux + + + + + 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_Manual/en-US/Revision_History.xml b/Installation_Manual/en-US/Revision_History.xml new file mode 100644 index 0000000..f0435f0 --- /dev/null +++ b/Installation_Manual/en-US/Revision_History.xml @@ -0,0 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + Revision History + + + + 0 + Sun May 16 2010 + + Dude + McPants + Dude.McPants@example.com + + + + Initial creation of book by publican + + + + + + + diff --git a/Installation_Manual/publican.cfg b/Installation_Manual/publican.cfg new file mode 100644 index 0000000..e2e32bf --- /dev/null +++ b/Installation_Manual/publican.cfg @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Sun May 16 16:49:38 2010 + +xml_lang: en-US +type: Book +brand: common + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..df218c3 --- /dev/null +++ b/Makefile @@ -0,0 +1,41 @@ +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)