summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-05-07 13:58:27 (GMT)
committerJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-05-07 13:58:27 (GMT)
commit950badd0d522a417e0d874eb91b98008870b045b (patch)
treef394d58ffc5f447d4573829ca23c9ab45d48fe45
parent893841a7cb580f951ceb6d49dbeeaa39be70c829 (diff)
downloadkolab-docs-950badd0d522a417e0d874eb91b98008870b045b.tar.gz
Update Installation Guide
-rwxr-xr-xInstallation_Guide/en-US/Kolab_Server_Configuration.xml477
-rwxr-xr-xInstallation_Guide/en-US/Kolab_Server_Installation.xml15
-rwxr-xr-xInstallation_Guide/en-US/Kolab_Server_Overview.xml248
-rw-r--r--Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_APT_Packages.xml34
-rw-r--r--Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_RPM_Packages.xml291
5 files changed, 250 insertions, 815 deletions
diff --git a/Installation_Guide/en-US/Kolab_Server_Configuration.xml b/Installation_Guide/en-US/Kolab_Server_Configuration.xml
index 44f6f99..7542004 100755
--- a/Installation_Guide/en-US/Kolab_Server_Configuration.xml
+++ b/Installation_Guide/en-US/Kolab_Server_Configuration.xml
@@ -5,463 +5,60 @@
]>
<chapter id="chap-Community_Installation_Guide-Configuration">
<title>Configuration</title>
- <section id="sect-Community_Installation_Guide-Configuration-Pykolab_setup_utility">
- <title>Pykolab setup utility</title>
+ <para>
+ To bootstrap a default Kolab installation, with all components installed on a single system, the <command>setup-kolab</command> utility can be used. Run <command>setup-kolab</command> without any arguments to set up all Kolab components.
+ </para>
+ <important>
<para>
- To setup each component the pykolab utilty can be used.
+ The setup utility by default asks for a bare minimum of input, and uses data available from the system, such as the system's fully qualified domain name (hostname and domain name parts) to setup the system with. To customize the installation, please refer to <xref linkend="sect-Community_Installation_Guide-Configuration-Customizing_the_Setup_Process" />.
</para>
- <para>
- Once the installation is complete, you can configure all components using:
-<screen># <userinput>/opt/kolab/bin/kolab-setup</userinput></screen>
- </para>
+ </important>
+ <para>
+ For non-default or distributed installations, trigger the setup of one or more components using <command>setup-kolab &lt;component&gt;</command>. See <command>setup-kolab help</command> for a list of components for which configuration is available.
+ </para>
+ <section id="sect-Community_Installation_Guide-Configuration-Customizing_the_Setup_Process">
+ <title>Customizing the Setup Process</title>
<para>
- If you ran the script successfully the installation and configuration of the server is complete and you can move on to the next chapter.
+ Specify a configuration file in any other location than the default location of <filename>/etc/kolab.kolab.conf</filename> to customize the setup process. <command>setup-kolab</command> accepts the <literal>--config=<replaceable>/path/to/file</replaceable></literal> command-line option for this purpose.
</para>
- <note>
- <title> Mixing automated and manual configuration </title>
+ <example id="exam-Community_Installation_Guide-Customizing_the_Setup_Process-Setting_up_Kolab_with_a_customized_configuration_file">
+ <title>Setting up Kolab with a customized configuration file</title>
+ <para>
+ The following is an example of setting up a Kolab Groupware server with the help of a customized configuration file.
+ </para>
+
+<screen># cp /etc/kolab/kolab.conf /root/mykolab.conf
+# (...edit settings in /root/mykolab.conf...)
+# setup-kolab -c /root/mykolab.conf</screen>
+
+ </example>
+ <important>
<para>
- It is also possible to configure only certain components using the pykolab utility, and configurating others manually.
+ Make sure the configuration file supplied to the setup process is complete, or the setup process will fail.
</para>
- </note>
+ </important>
</section>
- <section id="sect-Community_Installation_Guide-Configuration-Configuration_through_Puppet">
- <title>Configuration through Puppet</title>
+ <section id="sect-Community_Installation_Guide-Configuration-LDAP_Component">
+ <title>LDAP Component</title>
<para>
- TODO move to another guide? Assuming that you have an existing Puppet environment, you can clone the <literal>kolab</literal> puppet module:
+ The LDAP component of the setup utility configures a 389 Directory Server installation that has not yet been set up to work for a Kolab Groupware deployment, by feeding answers to <command>setup-ds-admin.pl</command> through an answer file, loading the Kolab LDAP Schema extenions, and adding the default set of user accounts Kolab Groupware requires.
</para>
<para>
-
-<screen>$ <userinput>git clone git://git.puppetmanaged.org/puppet/kolab</userinput></screen>
-
+ This component also writes out the Kolab configuration file <filename>/etc/kolab/kolab.conf</filename>, which is used by the other components' setup procedures. In case the LDAP component is set up on a separate system, use the resulting <filename>/etc/kolab/kolab.conf</filename> as the setup configuration file for the other components.
</para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Configuration-Manual_Configuration">
- <title>Manual Configuration</title>
<para>
- If you cannot use the pykolab utility for some reason, all configurations can also be made manually. In the following the minimum amount of configuration needed to get a fully working single server installation is described. This will give you the same result as using the pykolab utility.
+ The defaults for the LDAP setup include taking the system's Fully Qualified Domain Name, and making the domain name the primary domain, set up 389 DS with a default root DN, in an instance named with the system's hostname.
+ </para>
+ <para>
+ A server with a FQDN of <literal>kolab01.example.org</literal> will therefore be configured to run <literal>dc=example,dc=org</literal> for primary domain name space <literal>example.org</literal> in a 389 Directory Server instance named <literal>kolab01</literal>. To use a different FQDN, use command-line option <literal>--fqdn <replaceable>&lt;your_fqdn&gt;</replaceable></literal>. The setup will still use the hostname and domain name components, however.
+ </para>
+ <para>
+ When run against an existing configuration file that is not <filename>/etc/kolab/kolab.conf</filename> (but, for example, <filename>/etc/kolab/kolab-setup.conf</filename>), the setup process will take the existing configuration and set up a 389 Directory Server accordingly. This allows for greater flexibility in, among others, which root DN is used. You may discard the configuration file used for the setup afterwards, it contains no information of value other then for troubleshooting purposes, and it is not written to by the setup process.
</para>
- <section id="sect-Community_Installation_Guide-Manual_Configuration-LDAP_Configuration">
- <title>LDAP Configuration</title>
- <para>
- <filename>/etc/openldap/slapd.conf</filename>
- </para>
- <para>
- Update all example.org <emphasis>distinguished names</emphasis>.
- </para>
- <blockquote id="bloc-Community_Installation_Guide-LDAP_Configuration-certificates">
- <title>certificates</title>
-
-<screen>TLSCertificateFile <replaceable>/etc/pki/tls/certs/host.example.org.crt</replaceable></screen>
-
-<screen>TLSCertificateKeyFile <replaceable>/etc/pki/tls/certs/host.example.org.key</replaceable></screen>
- <para>
-
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-LDAP_Configuration-rootDSE">
- <title>rootDSE</title>
-
-<screen>rootDSE <replaceable>/path/to/rootDSE.ldif</replaceable></screen>
- <para>
- Specify the name of an LDIF(5) file containing user defined attributes for the root DSE. These attributes are returned in addition to the attributes normally produced by slapd. TODO: this is normally shipped as a default config file
- </para>
-
- </blockquote>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- OpenLDAP
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-Kolab_deamon_Configuration">
- <title>Kolab deamon Configuration</title>
- <para>
- TODO: kolabd probably also needs a configuration file?
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-Cyrus_IMAP_Configuration_default">
- <title>Cyrus-IMAP Configuration (default)</title>
- <para>
- <filename>/etc/imapd.conf</filename>
- </para>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-servername">
- <title>servername</title>
-
-<screen>servername: <replaceable>example.org</replaceable></screen>
- <para>
- This is the hostname visible in the greeting messages of the POP, IMAP and LMTP daemons. If it is unset, then the result returned from gethostname(2) is used.
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-admin">
- <title>admin</title>
-
-<screen>admin: <replaceable>user1 user2</replaceable></screen>
- <para>
- The list of userids with administrative rights. Separate each userid with a space. Sites using Kerberos authentication may use separate "admin" instances.
- </para>
- <para>
- Note that accounts used by users should not be administrators. Administrative accounts should not receive mail. That is, if user "jbRo" is a user reading mail, he should not also be in the admins line. Some problems may occur otherwise, most notably the ability of administrators to create top-level mailboxes visible to users, but not writable by users.
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-ldap_base">
- <title>ldap_base</title>
-
-<screen>ldap_base: <replaceable>dc=example,dc=org</replaceable></screen>
- <para>
- Contains the LDAP base dn for the LDAP ptloader module
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-ldap_bind_dn">
- <title>ldap_bind_dn</title>
-
-<screen>ldap_bind_dn: <replaceable>cn=nobody,cn=internal,dc=example,dc=org</replaceable></screen>
- <para>
- Bind DN for the connection to the LDAP server (simple bind). Do not use for anonymous simple binds
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-ldap_password">
- <title>ldap_password</title>
-
-<screen>ldap_password: <replaceable>LDAPpassword</replaceable></screen>
- <para>
- Password for the LDAP server.
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-ldap_group_base">
- <title>ldap_group_base</title>
-
-<screen>ldap_group_base: <replaceable>ou=Groups,dc=example,dc=org</replaceable></screen>
- <para>
- LDAP base dn for ldap_group_filter.
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-ldap_member_base">
- <title>ldap_member_base</title>
-
-<screen>ldap_member_base: <replaceable>ou=People,dc=example,dc=org</replaceable></screen>
- <para>
- LDAP base dn for ldap_member_filter.
- </para>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-Cyrus_IMAP_Configuration_default-tls_cert">
- <title>tls-cert</title>
-
-<screen>tls_cert_file: <replaceable>/etc/pki/tls/certs/host.example.org.cert</replaceable></screen>
- <para>
- File containing the certificate presented for server authentication during STARTTLS. A value of "disabled" will disable SSL/TLS.
- </para>
-
-<screen>tls_key_file: <replaceable>/etc/pki/tls/private/host.example.org.key</replaceable></screen>
- <para>
- File containing the private key belonging to the server certificate. A value of "disabled" will disable SSL/TLS.
- </para>
-
-<screen>tls_ca_file: <replaceable>/etc/pki/tls/certs/host.example.org_ca.crt</replaceable></screen>
- <para>
- File containing one or more Certificate Authority (CA) certificates.
- </para>
- <note>
- <title>TLS Certificates</title>
- <para>
- TODO: note on generating a ca and intermediate ca and server certificates, add to that note the multi-valued cn attribute for web servers that are tcp/ip load-balanced
- </para>
-
- </note>
-
- </blockquote>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- <xref linkend="part-Community_Installation_Guide-Cyrus_IMAP" />
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-Dovecot_IMAP_Configuration_Alternative">
- <title>Dovecot-IMAP Configuration (Alternative)</title>
- <para>
- <filename>/etc/dovecot.conf</filename>
- </para>
- <blockquote id="bloc-Community_Installation_Guide-Dovecot_IMAP_Configuration_Alternative-TODO_placeholder">
- <title>TODO placeholder</title>
-
-<screen>placeholder <replaceable>replacable</replaceable></screen>
- <para>
- Comment.
- </para>
-
- </blockquote>
- <note>
- <title>Detailed Instructions</title>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- Dovecot-IMAP <!-- xref linkend="sect-Installation_Guide-Dovecot-IMAP" / -->
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </note>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-MTA_Configuration">
- <title>MTA Configuration</title>
- <para>
- <filename>/etc/postfix/main.cf</filename>
- </para>
- <para>
- The Postfix main.cf configuration file specifies a very small subset of all the parameters that control the operation of the Postfix mail system. Parameters not explicitly specified are left at their default values.
- </para>
- <blockquote id="bloc-Community_Installation_Guide-MTA_Configuration-tls_cert">
- <title>tls-cert</title>
-
-<screen>smtpd_tls_cert_file = <replaceable>/etc/pki/tls/certs/host.example.org.cert</replaceable></screen>
- <para>
- File with the Postfix SMTP server RSA certificate in PEM format. This file may also contain the Postfix SMTP server private RSA key.
- </para>
-
-<screen>smtpd_tls_key_file = <replaceable>/etc/pki/tls/private/host.example.org.key</replaceable></screen>
- <para>
- File with the Postfix SMTP server RSA private key in PEM format. This file may be combined with the Postfix SMTP server RSA certificate file specified with $smtpd_tls_cert_file. The private key must be accessible without a pass-phrase, i.e. it must not be encrypted. File permissions should grant read-only access to the system superuser account ("root"), and no access to anyone else.
- </para>
-
- </blockquote>
- <warning>
- <title>SASL related configurations</title>
- <para>
- Depending on the used IMAP server the SASL related configs must be replaced. See <ulink url="http://www.postfix.org/SASL_README.html#server_sasl">Postfix SASL documentation</ulink> for more info.
- </para>
-
- </warning>
- <blockquote id="bloc-Community_Installation_Guide-MTA_Configuration-SASL_with_Cyrus_IMAP">
- <title>SASL with Cyrus-IMAP</title>
-
-<screen>cyrus_sasl_config_path = <replaceable>/etc/sasl2/</replaceable></screen>
-
-<screen>smtpd_sasl_path = <replaceable>smtpd</replaceable></screen>
-
-<screen>smtpd_sasl_type = <replaceable>cyrus</replaceable></screen>
-
- </blockquote>
- <blockquote id="bloc-Community_Installation_Guide-MTA_Configuration-SASL_with_Dovecot_IMAP">
- <title>SASL with Dovecot-IMAP</title>
-
-<screen>smtpd_sasl_path = <replaceable>private/auth</replaceable></screen>
-
-<screen>smtpd_sasl_type = <replaceable>dovecot</replaceable></screen>
-
- </blockquote>
- <note>
- <title>Manpage</title>
- <para>
- For further info see <command>man 5 postconf</command>
- </para>
-
- </note>
- <para>
- <filename>/etc/postfix/master.cf</filename>
- </para>
- <para>
- The master.cf configuration file defines how a client program connects to a service, and what daemon program runs when a service is requested. TODO: configure kolabfilter first? Adjust the path to the config file of /etc/kolab/kolabfilter.conf
- </para>
- <note>
- <title>Manpage</title>
- <para>
- <userinput>man 5 master</userinput>
- </para>
-
- </note>
- <para>
- <filename>/etc/postfix/ldap/mydestination.cf</filename>
- </para>
- <para>
- Used for an ldap lookup of the mydestination parameter in main.cf.
- </para>
- <para>
- <filename>/etc/postfix/ldap/local_recipient_maps.cf</filename>
- </para>
- <para>
- Used for an ldap lookup of the local_recipient_maps parameter in main.cf
- </para>
- <para>
- <filename>/etc/postfix/ldap/virtual_alias_maps.cf</filename>
- </para>
- <para>
- <filename>/etc/postfix/ldap/virtual_alias_maps_mailenabled_distgroups.cf</filename>
- </para>
- <para>
- <filename>/etc/postfix/ldap/virtual_alias_maps_mailenabled_dynamic_distgroups.cf</filename>
- </para>
- <para>
- Used for an ldap lookup of the virtual_alias_maps parameter in main.cf
- </para>
- <important>
- <title>Adjust example.org domain names</title>
- <para>
- Adjust the example.org rootDNs and domain names in all these files.
- </para>
-
- </important>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- MTA
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-Kolab_Webadmin_Configuration">
- <title>Kolab-Webadmin Configuration</title>
- <para>
- <filename>/path/to/file</filename>
- </para>
- <blockquote id="bloc-Community_Installation_Guide-Kolab_Webadmin_Configuration-title">
- <title>title</title>
-
-<screen>var = <replaceable>value</replaceable></screen>
- <para>
- blabla
- </para>
-
- </blockquote>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- Webadmin
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-Webclient_Configuration">
- <title>Webclient Configuration</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- how to configure the webserver to show the web interface over SSL only
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- Webclient
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Manual_Configuration-Webclient_Database_Configuration">
- <title>Webclient Database Configuration</title>
- <para>
- The Webclient-Database needs a mysql server installation, which should have been installed as a dependency of the package.
- </para>
- <section id="sect-Community_Installation_Guide-Webclient_Database_Configuration-Configuration_of_the_MySQL_server_for_the_Horde_Database">
- <title>Configuration of the MySQL server for the Horde Database</title>
- <para>
- The following procedure ...
- </para>
- <para>
- <itemizedlist>
- <para>
- For detailed instructions for the manual setup please see:
- </para>
- <listitem>
- <para>
- Horde-Webclient-Database
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
-
- </section>
-
</section>
diff --git a/Installation_Guide/en-US/Kolab_Server_Installation.xml b/Installation_Guide/en-US/Kolab_Server_Installation.xml
index 628a491..5e4d340 100755
--- a/Installation_Guide/en-US/Kolab_Server_Installation.xml
+++ b/Installation_Guide/en-US/Kolab_Server_Installation.xml
@@ -14,10 +14,10 @@
To get a fully working Kolab installation all of the 6 components above need to be installed.
</para>
<para>
- The Kolab community provides APT and RPM packages for most commonly used Linux distributions. To get a fully working Kolab server on a single system, please install the “kolab-groupware” meta-package which will install all components, and run the setup script on a single machine.
+ The Kolab community provides APT and RPM packages for most commonly used Linux distributions. To get a fully working Kolab server on a single system, please install the “kolab-groupware” meta-package which will install all components, and run the setup script on a single system.
</para>
<para>
- The default installation assumes that all components are installed on the same machine.
+ The default installation assumes that all components are installed on the same system.
</para>
<para>
If you have a distributed deployment or want non default components, please see <xref linkend="sect-Community_Installation_Guide-Installation_with_APT_Packages" /> and <xref linkend="sect-Community_Installation_Guide-Installation_with_RPM_Packages" /> for more information.
@@ -41,12 +41,17 @@
<section id="sect-Community_Installation_Guide-Installation-Full_default_installation_on_a_single_server">
<title>Full default installation on a single server</title>
<para>
- If you want a default installation with all components on a single server, pleas run:
+ If you want a default installation with all components on a single server, please run:
+ </para>
+ <para>
+
<screen># <userinput>yum install kolab</userinput></screen>
- This meta-package will install all needed components.
</para>
<para>
- Once the installation is complete, you can continue with the configuration in the next chapter.
+ Installing this meta-package will install all needed software components.
+ </para>
+ <para>
+ Once the installation is complete, you can continue with the configuration process as described in <xref linkend="chap-Community_Installation_Guide-Configuration" />.
</para>
<para>
Alternatively you can install each component individually, which will give you the same result.
diff --git a/Installation_Guide/en-US/Kolab_Server_Overview.xml b/Installation_Guide/en-US/Kolab_Server_Overview.xml
index 96dcd32..d3c29ff 100755
--- a/Installation_Guide/en-US/Kolab_Server_Overview.xml
+++ b/Installation_Guide/en-US/Kolab_Server_Overview.xml
@@ -10,267 +10,87 @@
</para>
<itemizedlist>
<para>
- The Kolab server consist of the following 6 components, which can be distributed among several systems. Each of those components can be installed using the provided meta package.
+ The Kolab server consist of the following 6 components, which can be distributed among several systems. Each of those components can be installed using the provided meta-package.
+ </para>
+ <para>
+ To install all components on a single system, a <literal>kolab</literal> meta-package is available, pulling in all other packages and dependencies.
</para>
<listitem>
- <formalpara id="form-Community_Installation_Guide-Kolab_Server-Kolab_IMAP">
- <title>Kolab-IMAP</title>
+ <formalpara id="form-Community_Installation_Guide-Kolab_Server-IMAP">
+ <title>IMAP</title>
<para>
- The IMAP server component including a daemon which synchronizes user accounts from LDAP with IMAP mailboxes.
+ The IMAP server component of Kolab Groupware, including a daemon which synchronizes user accounts from LDAP with IMAP mailboxes.
</para>
</formalpara>
<para>
- <itemizedlist>
- <para>
- default meta-package:
- </para>
- <listitem>
- <para>
- <application>kolab-imap</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- default packages:
- </para>
- <listitem>
- <para>
- <application>cyrus-imap</application>
- </para>
-
- </listitem>
- <listitem>
- <para>
- <application>kolab-daemon</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- optional-packages:
- </para>
- <listitem>
- <para>
- <application>dovecot-imap</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
-
+ To install the IMAP component, use the <literal>kolab-imap</literal> meta-package. This meta-packages pulls in <application>cyrus-imapd</application> and <application>kolab-server</application>.
</para>
</listitem>
<listitem>
- <formalpara id="form-Community_Installation_Guide-Kolab_Server-Kolab_LDAP">
- <title>Kolab-LDAP</title>
+ <formalpara id="form-Community_Installation_Guide-Kolab_Server-LDAP">
+ <title>LDAP</title>
<para>
- The ldap directory component is used for the authentication of users.
+ The LDAP directory server component is used for user and group information, authentication and authorization.
</para>
</formalpara>
<para>
- <itemizedlist>
- <para>
- default meta-package:
- </para>
- <listitem>
- <para>
- <application>kolab-ldap</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- default packages:
- </para>
- <listitem>
- <para>
- <application>openldap-server</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
-
+ To install the LDAP component, use the <literal>kolab-ldap</literal> meta-package. This meta-package pulls in <application>389-ds</application> and dependencies, and <literal>kolab-schema</literal>, the package containing the Kolab LDAP Schema extensions.
</para>
</listitem>
<listitem>
- <formalpara id="form-Community_Installation_Guide-Kolab_Server-Kolab_MTA">
- <title>Kolab-MTA</title>
+ <formalpara id="form-Community_Installation_Guide-Kolab_Server-MTA">
+ <title>MTA</title>
<para>
- The MTA including spamfilter, virus-scanner and sasl authentication FIXME ?
+ The MTA, including spam-filter, virus-scanner, Kolab SMTP Access Policy and the Kolab content-filter.
</para>
</formalpara>
<para>
- <itemizedlist>
- <para>
- default meta-package:
- </para>
- <listitem>
- <para>
- <application>kolab-mta</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- default packages:
- </para>
- <listitem>
- <para>
- <application>postfix</application>
- </para>
-
- </listitem>
- <listitem>
- <para>
- <application>clamav</application>
- </para>
-
- </listitem>
- <listitem>
- <para>
- <application>amavis</application>
- </para>
-
- </listitem>
- <listitem>
- <para>
- <application>TODO kolab-postfix-filters?</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
-
+ To install the MTA component, use meta-package <literal>kolab-mta</literal>, which installs <application>Postfix</application>, <application>Amavisd</application>, <application>SpamAssassin</application>, <application>ClamAV</application>, <application>postfix-kolab</application> and <application>Wallace</application>.
</para>
</listitem>
<listitem>
- <formalpara id="form-Community_Installation_Guide-Kolab_Server-Kolab_Webadmin">
- <title>Kolab-Webadmin</title>
+ <formalpara id="form-Community_Installation_Guide-Kolab_Server-Web_Administration_Panel">
+ <title>Web Administration Panel</title>
<para>
- An administrator webinterface.
+ The Kolab web-based administration panel and API.
</para>
</formalpara>
- <itemizedlist>
- <para>
- default meta-package:
- </para>
- <listitem>
- <para>
- <application>kolab-webadmin</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
+ <para>
+ To install the Web Administration Panel and API, install the <literal>kolab-webadmin</literal> package.
+ </para>
</listitem>
<listitem>
- <formalpara id="form-Community_Installation_Guide-Kolab_Server-Kolab_Webclient">
- <title>Kolab-Webclient</title>
+ <formalpara id="form-Community_Installation_Guide-Kolab_Server-Web_Client">
+ <title>Web Client</title>
<para>
- An email webinterface.
+ The web-based client for Kolab, based on Roundcube.
</para>
</formalpara>
- <itemizedlist>
- <para>
- default meta-package:
- </para>
- <listitem>
- <para>
- <application>kolab-webclient</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- default packages:
- </para>
- <listitem>
- <para>
- <application>kolab-webclient-roundcube</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- optional-packages:
- </para>
- <listitem>
- <para>
- <application>kolab-webclient-horde</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
+ <para>
+ To install the Kolab web-client, use meta-package <literal>kolab-webclient</literal>. This meta-package pulls in <application>Roundcube</application>, the default MySQL database driver packages, and the Kolab plugins for Roundcube.
+ </para>
</listitem>
<listitem>
- <formalpara id="form-Community_Installation_Guide-Kolab_Server-Kolab_Webclient_Database">
- <title>Kolab-Webclient-Database</title>
+ <formalpara id="form-Community_Installation_Guide-Kolab_Server-Databases">
+ <title>Databases</title>
<para>
- A database for the Kolab-Webclient which stores the settings of the webclient and caches data from the imap server. This database can, but does not have to be on the same server as the webclient.
+ The database component, shared between the Kolab Web Administration Panel, the Web Client, and the MTAs.
</para>
</formalpara>
- <itemizedlist>
- <para>
- default meta-package:
- </para>
- <listitem>
- <para>
- <application>kolab-webclient-database</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- default packages:
- </para>
- <listitem>
- <para>
- <application>kolab-webclient-database-roundcube</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <itemizedlist>
- <para>
- optional-packages:
- </para>
- <listitem>
- <para>
- <application>kolab-webclient-database-horde</application>
- </para>
-
- </listitem>
-
- </itemizedlist>
+ <para>
+ No meta-package for this component exists, as the default choice for a MySQL server is contained within a single package throughout the supported platforms.
+ </para>
</listitem>
diff --git a/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_APT_Packages.xml b/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_APT_Packages.xml
index 6f9a47a..4d62d25 100644
--- a/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_APT_Packages.xml
+++ b/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_APT_Packages.xml
@@ -5,6 +5,13 @@
]>
<section id="sect-Community_Installation_Guide-Installation_with_APT_Packages">
<title>Installation with APT Packages</title>
+ <important>
+ <para>
+ APT packages for Kolab 2.4 are actively being worked on, but are not yet available.
+ </para>
+
+ </important>
+ <!--
<para>
APT packages are provided for the following GNU/Linux distributions, and distribution versions:
</para>
@@ -44,27 +51,7 @@
</row>
</thead>
- <!--
- <tfoot> <row>
- <entry>
- f1
- </entry>
- <entry>
- f2
- </entry>
- <entry>
- f3
- </entry>
- <entry>
- f4
- </entry>
- <entry>
- f5
- </entry>
-
- </row>
- </tfoot>
- --> <tbody>
+<tbody>
<row>
<entry>
Debian
@@ -303,7 +290,7 @@ Pin-Priority: 501</screen>
</para>
<para>
-<screen>$ <userinput>gpg --search squeeze-packages@kolabsys.com</userinput></screen>
+<screen>$ <userinput>gpg &min;&min;search squeeze-packages@kolabsys.com</userinput></screen>
</para>
<para>
@@ -459,8 +446,7 @@ E: Broken packages</screen>
</section>
-
-
+ // -->
</section>
diff --git a/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_RPM_Packages.xml b/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_RPM_Packages.xml
index 850eb42..2cc6ce3 100644
--- a/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_RPM_Packages.xml
+++ b/Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_RPM_Packages.xml
@@ -118,7 +118,7 @@
Q2, 2011
</entry>
- </row> --> <row>
+ </row> <row>
<entry>
Fedora
</entry>
@@ -154,6 +154,42 @@
</entry>
</row>
+ --> <row>
+ <entry>
+ Fedora
+ </entry>
+ <entry>
+ Verne
+ </entry>
+ <entry>
+ 16
+ </entry>
+ <entry>
+ i386, amd64
+ </entry>
+ <entry>
+ Q2, 2013
+ </entry>
+
+ </row>
+ <row>
+ <entry>
+ Fedora
+ </entry>
+ <entry>
+ Beefy Miracle
+ </entry>
+ <entry>
+ 17
+ </entry>
+ <entry>
+ i386, amd64
+ </entry>
+ <entry>
+ Q4, 2013
+ </entry>
+
+ </row>
<row>
<entry>
Red Hat Enterprise Linux
@@ -224,31 +260,105 @@
<section id="sect-Community_Installation_Guide-Prerequisites-Fedora">
<title>Fedora</title>
<para>
- To install Kolab Groupware on Fedora, additional Kolab Groupware software repositories are required.
+ The Kolab software repositories for Fedora ship two so-called <literal>-release</literal> packages:
</para>
- <procedure id="proc-Community_Installation_Guide-Fedora-Installing_the_Kolab_Groupware_repositories_for_Fedora">
- <title>Installing the Kolab Groupware repositories for Fedora</title>
- <step>
- <para>
- Depending on the version of Fedora, install the following package:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- TODO
- </para>
+ <para>
+ <orderedlist>
+ <listitem condition="community">
+ <para>
+ <literal>kolab-&PRODUCT_VERSION;-community-release</literal>
+ </para>
+ <para>
+ Depending on the version of Fedora, find the <literal>-release</literal> package at:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://mirror.kolabsys.com/pub/redhat/kolab-2.4/f16/release/i386/repoview/kolab-2.4-community-release.html">Fedora 16 (Verne)</ulink>
+ </para>
- </listitem>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://mirror.kolabsys.com/pub/redhat/kolab-2.4/f17/release/i386/repoview/kolab-2.4-community-release.html">Fedora 17 (Beefy Miracle)</ulink>
+ </para>
- </itemizedlist>
+ </listitem>
- </para>
+ </itemizedlist>
- </step>
+ </para>
- </procedure>
+ </listitem>
+ <listitem condition="enterprise">
+ <para>
+ <literal>kolab-&PRODUCT_VERSION;-enterprise-release</literal>
+ </para>
+ <para>
+ Depending on the version of Fedora, find the <literal>-release</literal> package at:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="https://mirror.kolabsys.com/redhat/kolab-2.4/f16/release/i386/repoview/kolab-2.4-enterprise-release.html">Fedora 16 (Verne)</ulink>
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="https://mirror.kolabsys.com/redhat/kolab-2.4/f17/release/i386/repoview/kolab-2.4-enterprise-release.html">Fedora 17 (Beefy Miracle)</ulink>
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </listitem>
+ <listitem condition="community">
+ <para>
+ <literal>kolab-&PRODUCT_VERSION;-community-release-development</literal>
+ </para>
+ <para>
+ You can install the <literal>kolab-&PRODUCT_VERSION;-community-release-development</literal> package using YUM, after having installed the <literal>kolab-&PRODUCT_VERSION;-community-release</literal> package;
+ </para>
+ <para>
+
+<screen># <userinput>yum install kolab-&PRODUCT_VERSION;-community-release-development</userinput></screen>
+
+ </para>
+
+ </listitem>
+ <listitem condition="enterprise">
+ <para>
+ <literal>kolab-&PRODUCT_VERSION;-enterprise-release-development</literal>
+ </para>
+ <para>
+ You can install the <literal>kolab-&PRODUCT_VERSION;-enterprise-release-development</literal> package using YUM, after having installed the <literal>kolab-&PRODUCT_VERSION;-enterprise-release</literal> package;
+ </para>
+ <para>
+
+<screen># <userinput>yum install kolab-&PRODUCT_VERSION;-enterprise-release-development</userinput></screen>
+
+ </para>
+
+ </listitem>
+ </orderedlist>
+
+ </para>
+ <para>
+ Install this package using the following command:
+ </para>
+ <para>
+
+<screen># <userinput>wget http://url/to/rpm</userinput>
+<userinput># yum localinstall --nogpgcheck /path/to/rpm</userinput></screen>
+
+ </para>
</section>
@@ -267,13 +377,13 @@
<itemizedlist>
<listitem>
<para>
- <ulink url="http://download.fedora.redhat.com/pub/epel/5/i386/repoview/epel-release.html">Enterprise Linux 5</ulink> (Tikanga)
+ <ulink url="http://download.fedoraproject.org/pub/epel/5/i386/repoview/epel-release.html">Enterprise Linux 5</ulink> (Tikanga)
</para>
</listitem>
<listitem>
<para>
- <ulink url="http://download.fedora.redhat.com/pub/epel/6/i386/repoview/epel-release.html">Enterprise Linux 6</ulink> (Santiago)
+ <ulink url="http://download.fedoraproject.org/pub/epel/6/i386/repoview/epel-release.html">Enterprise Linux 6</ulink> (Santiago)
</para>
</listitem>
@@ -392,160 +502,77 @@
</orderedlist>
</para>
- <formalpara id="form-Community_Installation_Guide-Red_Hat_Enterprise_Linux-Stable_Software">
+
+ </section>
+
+ <section id="sect-Community_Installation_Guide-Prerequisites-Repository_Package_Stages">
+ <title>Repository Package Stages</title>
+ <formalpara id="form-Community_Installation_Guide-Repository_Package_Stages-Stable_Software">
<title>Stable Software</title>
<para>
Stable software, versions of packages deemed ready for general availability and production environments are distributed through two repositories, <emphasis>release</emphasis> and <emphasis>updates</emphasis>. These repositories are configured on the system, and enabled by default, by installing the <literal condition="community">kolab-&PRODUCT_VERSION;-community-release</literal><literal condition="enterprise">kolab-&PRODUCT_VERSION;-enterprise-release</literal> package;
</para>
</formalpara>
- <formalpara id="form-Community_Installation_Guide-Red_Hat_Enterprise_Linux-Stable_Software_Currently_in_Testing">
+ <formalpara id="form-Community_Installation_Guide-Repository_Package_Stages-Stable_Software_Currently_in_Testing">
<title>Stable Software Currently in Testing</title>
<para>
The <literal condition="community">kolab-&PRODUCT_VERSION;-community-release</literal><literal condition="enterprise">kolab-&PRODUCT_VERSION;-enterprise-release</literal> package also installs a repository through which upcoming updates currently in their testing phase are distributed. This repository is called <emphasis>updates-testing</emphasis>, and is not enabled by default. Through Kolab Systems and/or community support channels, you may be asked to test an update distributed through the updates-testing repository to see if it fixes a bug you have reported. You would then, typically, temporarily enable the updates-testing repository by supplying the <literal>--enablerepo=kolab-2.4-updates-testing</literal> command-line option to YUM, overriding the system configuration file setting.
</para>
</formalpara>
- <formalpara id="form-Community_Installation_Guide-Red_Hat_Enterprise_Linux-Software_Currently_in_Development">
+ <formalpara id="form-Community_Installation_Guide-Repository_Package_Stages-Software_Currently_in_Development">
<title>Software Currently in Development</title>
<para>
Software that is currently in development for the product series you are running (in this case, series &PRODUCT_VERSION;) is available through the so-called <emphasis>development</emphasis> repository. This software is considered unstable. By default, you will not have the package installed that provides the configuration for this repository; the <literal condition="community">kolab-&PRODUCT_VERSION;-community-release-development</literal><literal condition="enterprise">kolab-&PRODUCT_VERSION;-enterprise-release-development</literal> package. Installing this package will cause the <emphasis>development</emphasis> repository to be enabled by default.
</para>
</formalpara>
- <procedure id="proc-Community_Installation_Guide-Red_Hat_Enterprise_Linux-Installing_the_kolab_PRODUCT_VERSION_community_release_Package">
- <title>Installing the <application>kolab-&PRODUCT_VERSION;-community-release</application> Package</title>
- <step>
- <para>
- Depending on the version of Red Hat Enterprise Linux, install the package as it is listed on the following page:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink condition="community" url="http://mirror.kolabsys.com/pub/redhat/kolab-2.4/el5/release/i386/repoview/kolab-2.4-community-release.html">Enterprise Linux 5</ulink> <ulink condition="enterprise" url="https://mirror.kolabsys.com/redhat/kolab-2.4/el5/release/i386/repoview/kolab-2.4-enterprise-release.html">Enterprise Linux 5</ulink>
- </para>
-
- </listitem>
- <listitem>
- <para>
- <ulink condition="community" url="http://mirror.kolabsys.com/pub/redhat/kolab-2.4/el6/release/i386/repoview/kolab-2.4-community-release.html">Enterprise Linux 6</ulink> <ulink condition="enterprise" url="https://mirror.kolabsys.com/redhat/kolab-2.4/el6/release/i386/repoview/kolab-2.4-enterprise-release.html">Enterprise Linux 6</ulink>
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </step>
- <step>
- <para>
- Install this package using the following command:
- </para>
- <para>
-<screen># <userinput>wget http://url/to/rpm</userinput>
-<userinput># yum localinstall --nogpgcheck /path/to/rpm</userinput></screen>
-
- </para>
+ </section>
- </step>
+ <section id="sect-Community_Installation_Guide-Prerequisites-Using_the_Priorities_YUM_Plugin_to_Avoid_Package_Conflicts">
+ <title>Using the Priorities YUM Plugin to Avoid Package Conflicts</title>
+ <para>
+ Since any given package may, at any time, be or become available to the system through both the Kolab repositories as well as through the regular distribution repositories, to avoid the risk of switching back and forth between the two different versions continuously, by mistake or by accident, we recommend you use the following procedure including employing YUM repository priorities to eliminate the risk of running in such problems in the future.
+ </para>
+ <para>
+ Consider installing the <application>yum-priorities</application> (Enterprise Linux 5) or <application>yum-plugin-priorities</application> package (all other platforms) to avoid such conflicts.
+ </para>
+ <procedure id="proc-Community_Installation_Guide-Using_the_Priorities_YUM_Plugin_to_Avoid_Package_Conflicts-Installing_and_Configuring_YUM_priorities">
+ <title>Installing and Configuring YUM priorities</title>
<step>
+ <title>Enterprise Linux 5</title>
<para>
- To test the installation of the repository configuration, please execute:
+ The <application>yum-priorities</application> is available from the <ulink url="http://fedoraproject.org/wiki/EPEL">package repository</ulink>. Please install it:
</para>
<para>
-<screen># <userinput>yum repolist</userinput>
-(...snip...)
-kolab-&PRODUCT_VERSION;
-kolab-&PRODUCT_VERSION;-updates
-(...snip...)</screen>
-
- </para>
- <note>
- <title>Output Abbreviated</title>
- <para>
- Note that the output is abbreviated for clarity. The output may actually include the description of the repository, and the number of packages available.
- </para>
+<screen># <userinput>yum install yum-priorities</userinput></screen>
- </note>
- <para>
- Optionally, to see which repositories have been configured though not enabled, also execute:
</para>
- <para>
-
-<screen># <userinput>yum repolist all</userinput>
-(...snip...)
-kolab-&PRODUCT_VERSION;
-kolab-&PRODUCT_VERSION;-debuginfo
-kolab-&PRODUCT_VERSION;-source
-kolab-&PRODUCT_VERSION;-updates
-kolab-&PRODUCT_VERSION;-updates-debuginfo
-kolab-&PRODUCT_VERSION;-updates-source
-kolab-&PRODUCT_VERSION;-updates-testing
-kolab-&PRODUCT_VERSION;-updates-testing-debuginfo
-kolab-&PRODUCT_VERSION;-updates-testing-source
-(...snip...)</screen>
-
- </para>
- <note>
- <title>Output Abbreviated</title>
- <para>
- Note that the output is abbreviated for clarity. The output may actually include the description of the repository, whether the repository is enabled by default or not, and the number of packages available in each repository as well as the total number of packages.
- </para>
-
- </note>
</step>
<step>
+ <title>Enterprise Linux 6</title>
<para>
- At this stage of the Kolab Groupware &PRODUCT_VERSION; development and release cycle, you may require to install the development repository as well. To do so, execute the following command:
+ The <application>yum-plugin-priorities</application> is available from the <ulink url="http://fedoraproject.org/wiki/EPEL">package repository</ulink>. Please install it:
</para>
<para>
-<screen># <userinput>yum -y install kolab-&PRODUCT_VERSION;-community-release-development</userinput></screen>
+<screen># <userinput>yum install yum-plugin-priorities</userinput></screen>
</para>
- <warning>
- <title>Development Repository Contains Unstable Software</title>
- <para>
- The development repository contains unstable software, in that new versions of the software can be released through the development repository quickly, for testing purposes, before they are approved to the updates-testing stage.
- </para>
-
- </warning>
</step>
-
- </procedure>
-
- <para>
- Please consider using <application>yum-priorities</application> as described in <xref linkend="sect-Community_Installation_Guide-Prerequisites-Using_yum_priorities_to_Avoid_Package_Conflicts" />. This is necessary for Enterprise Linux releases prior to Enterprise Linux 6 only.
- </para>
-
- </section>
-
- <section id="sect-Community_Installation_Guide-Prerequisites-Using_yum_priorities_to_Avoid_Package_Conflicts">
- <title>Using <application>yum-priorities</application> to Avoid Package Conflicts</title>
- <para>
- Since any given package may, at any time, be or become available to the system through both the Kolab repositories as well as through the regular distribution repositories, to avoid the risk of switching back and forth between the two different versions continuously, by mistake or by accident, we recommend you use the following procedure including employing YUM repository priorities to eliminate the risk of running in such problems in the future.
- </para>
- <note>
- <para>
- This is necessary only for Enterprise Linux 5.
- </para>
-
- </note>
- <procedure id="proc-Community_Installation_Guide-Using_yum_priorities_to_Avoid_Package_Conflicts-Installing_and_Configuring_YUM_priorities">
- <title>Installing and Configuring YUM priorities</title>
<step>
+ <title>Fedora</title>
<para>
- The <application>yum-priorities</application> is available from the <ulink url="http://fedoraproject.org/wiki/EPEL">package repository</ulink>. Please install it:
+ The <application>yum-plugin-priorities</application> is available in the standard repositories. Please install it:
</para>
<para>
-<screen># <userinput>yum install yum-priorities</userinput></screen>
+<screen># <userinput>yum install yum-plugin-priorities</userinput></screen>
</para>