summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-05-11 00:52:04 (GMT)
committerJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-05-11 00:52:04 (GMT)
commit2438583bdc2094285507735373c4e94da8a40041 (patch)
treeedb2b836c8458b847cf77d06ad75c504d0139c30
parentad24998110c434057c33b2a48c6a201dfd43f403 (diff)
downloadkolab-docs-2438583bdc2094285507735373c4e94da8a40041.tar.gz
Add a chapter on first login notes and items
Update rest of documentation as well
-rwxr-xr-xInstallation_Guide/en-US/Kolab_Server_Configuration.xml29
-rw-r--r--Installation_Guide/en-US/Kolab_Server_First_Login.xml63
-rwxr-xr-xInstallation_Guide/en-US/Kolab_Server_Installation.xml30
-rw-r--r--Installation_Guide/en-US/Preparing_the_System.xml135
-rwxr-xr-xInstallation_Guide/en-US/part-Kolab_Server.xml1
-rw-r--r--Installation_Guide/en-US/sect-Repository_Configuration-Installation_with_RPM_Packages.xml9
6 files changed, 236 insertions, 31 deletions
diff --git a/Installation_Guide/en-US/Kolab_Server_Configuration.xml b/Installation_Guide/en-US/Kolab_Server_Configuration.xml
index 7542004..5ad0e19 100755
--- a/Installation_Guide/en-US/Kolab_Server_Configuration.xml
+++ b/Installation_Guide/en-US/Kolab_Server_Configuration.xml
@@ -8,22 +8,31 @@
<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>
+ <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>
<important>
<para>
- 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" />.
+ 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, obtained from the reverse DNS entry on the network) to setup the system with.
+ </para>
+ <para>
+ To use a custom hostname and domain-name, execute <command>setup-kolab</command> with the <literal>--fqdn</literal> option, specifying a fully qualified domain name. Fully qualified domain names are expected to consist of three components, the hostname, domain name and top-level domain, divided by a "." (dot) character.
+ </para>
+ <para>
+ The FQDN used, in any case, should resolve back to the system Kolab is being set up on.
+ </para>
+ <para>
+ To further customize the installation, please refer to <xref linkend="sect-Community_Installation_Guide-Configuration-Customizing_the_Setup_Process" />.
</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>
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>
- <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>
+ <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>
@@ -35,7 +44,7 @@
</example>
<important>
<para>
- Make sure the configuration file supplied to the setup process is complete, or the setup process will fail.
+ Make sure the configuration file supplied to the setup process is complete and contains all settings in the original configuration file, or the setup process will fail.
</para>
</important>
@@ -47,6 +56,12 @@
<para>
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>
+ <important>
+ <para>
+ At the time of this writing, the setup for the LDAP component expects the setup is performed on a clean system, that has no existing LDAP server or server instance running.
+ </para>
+
+ </important>
<para>
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>
diff --git a/Installation_Guide/en-US/Kolab_Server_First_Login.xml b/Installation_Guide/en-US/Kolab_Server_First_Login.xml
new file mode 100644
index 0000000..22b50e9
--- /dev/null
+++ b/Installation_Guide/en-US/Kolab_Server_First_Login.xml
@@ -0,0 +1,63 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Community_Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Community_Installation_Guide-First_Login">
+ <title>First Login</title>
+ <para>
+ Once you have successfully set up the Kolab Groupware server, it is time to add some users.
+ </para>
+ <para>
+ Navigate to the /kolab-webadmin URL on your webserver using HTTP. For example, a server set up on localhost would be at http://127.0.0.1/kolab-webadmin.
+ </para>
+ <para>
+ Login using the username <literal>cn=Directory Manager</literal> and the password you supplied during the setup process.
+ </para>
+ <section id="sect-Community_Installation_Guide-First_Login-Creating_a_User">
+ <title>Creating a User</title>
+ <para>
+ Create a first user, and verify the account is created successfully using <command>ldapsearch</command> from a terminal.
+ </para>
+ <para>
+ A mailbox should now also have been created. Examine the output of <command>/usr/lib/cyrus-imapd/ctl_mboxlist -d</command>, or, alternatively, run <command>kolab list-mailboxes</command>.
+ </para>
+ <section id="sect-Community_Installation_Guide-Creating_a_User-Troubleshooting">
+ <title>Troubleshooting</title>
+ <formalpara id="form-Community_Installation_Guide-Troubleshooting-LDAP_Entry_Created_but_No_Mailbox">
+ <title>LDAP Entry Created, but No Mailbox</title>
+ <para>
+ This is a common error should no recipient policy be in place. Please see the Administrator Guide for more details on the recipient policy.
+ </para>
+
+ </formalpara>
+ <formalpara id="form-Community_Installation_Guide-Troubleshooting-Cannot_Supply_Mail_andor_Alternative_Mail_Addresses_for_the_User">
+ <title>Cannot Supply Mail and/or Alternative Mail Addresses for the User</title>
+ <para>
+ Set <literal>auto_fields_admin_rw</literal> to <literal>True</literal> in section <literal>[kolab_wap]</literal> in <filename>/etc/kolab/kolab.conf</filename> and log out and back in to the Kolab Web Administration Panel.
+ </para>
+
+ </formalpara>
+
+ </section>
+
+
+ </section>
+
+ <section id="sect-Community_Installation_Guide-First_Login-Creating_a_Kolab_Administrator">
+ <title>Creating a Kolab Administrator</title>
+ <para>
+ It is very important to realize the <literal>cn=Directory Manager</literal> is virtually the "root" user on the LDAP directory server. You should not need to use the account for day-to-day operations.
+ </para>
+ <para>
+ The default Kolab Groupware deployment has added a so-called <emphasis>role</emphasis> to the directory tree that allows accounts that have such role to edit, add and remove entries from the directory tree.
+ </para>
+ <para>
+ Create a new account or choose an existing account and navigate to the <emphasis>System</emphasis> tab. In the <emphasis>Role(s)</emphasis>, enter <userinput>kolab</userinput> and select the <emphasis>kolab-admin</emphasis> entry. Click <emphasis>Submit</emphasis> to save the changes.
+ </para>
+
+ </section>
+
+
+</chapter>
+
diff --git a/Installation_Guide/en-US/Kolab_Server_Installation.xml b/Installation_Guide/en-US/Kolab_Server_Installation.xml
index 03976e5..b129f26 100755
--- a/Installation_Guide/en-US/Kolab_Server_Installation.xml
+++ b/Installation_Guide/en-US/Kolab_Server_Installation.xml
@@ -11,7 +11,7 @@
<section id="sect-Community_Installation_Guide-Installation-Kolab_Server_Installation">
<title>Kolab Server Installation</title>
<para>
- To get a fully working Kolab installation all of the components listed in <xref linkend="chap-Community_Installation_Guide-Kolab_Server" /> need to be installed.
+ To get a fully working Kolab installation all of the components listed in <xref linkend="chap-Community_Installation_Guide-First_Login" /> 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 system.
@@ -110,7 +110,7 @@
Complete Server
</entry>
<entry>
- kolab-groupware-server
+ kolab
</entry>
<entry>
-
@@ -137,7 +137,7 @@
-
</entry>
<entry>
- The LDAP component (openldap by default).
+ The LDAP component (389 Directory Server).
</entry>
</row>
@@ -149,13 +149,13 @@
kolab-imap
</entry>
<entry>
- kolab-imap-dovecot
+ -
</entry>
<entry>
-
</entry>
<entry>
- The IMAP component (cyrus by default).
+ The IMAP component (Cyrus IMAP).
</entry>
</row>
@@ -173,7 +173,7 @@
-
</entry>
<entry>
- The MTA component (postfix by default).
+ The MTA component (Postfix by default).
</entry>
</row>
@@ -197,24 +197,6 @@
</row>
<row>
<entry>
- Webclient-Database
- </entry>
- <entry>
- kolab-webclient-database
- </entry>
- <entry>
- -
- </entry>
- <entry>
- -
- </entry>
- <entry>
- -
- </entry>
-
- </row>
- <row>
- <entry>
Webclient
</entry>
<entry>
diff --git a/Installation_Guide/en-US/Preparing_the_System.xml b/Installation_Guide/en-US/Preparing_the_System.xml
index ec2cb99..8f5a877 100644
--- a/Installation_Guide/en-US/Preparing_the_System.xml
+++ b/Installation_Guide/en-US/Preparing_the_System.xml
@@ -43,6 +43,141 @@
</section>
+ <section id="sect-Community_Installation_Guide-Preparing_the_System-SELinux">
+ <title>SELinux</title>
+ <para>
+ Not all components of Kolab Groupware are currently completely compatible with running under SELinux enforcing the targeted policy.
+ </para>
+ <para>
+ Please consider configuring SELinux to be permissive. Please let us know what AVC denials occur so we can work on fixing the issue.
+ </para>
+
+ </section>
+
+ <section id="sect-Community_Installation_Guide-Preparing_the_System-System_Firewall">
+ <title>System Firewall</title>
+ <para>
+ Kolab Groupware deliberately does not touch any firewall settings, perhaps wrongly assuming you know best. Before you continue, you should verify your firewall allows the standard ports used with Kolab Groupware. These ports include:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_25_tcp">
+ <title>Port 25, tcp</title>
+ <para>
+ Used to receive emails.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_80_tcp">
+ <title>Port 80, tcp</title>
+ <para>
+ Used for web interfaces.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_110_tcp">
+ <title>Port 110, tcp</title>
+ <para>
+ Used for POP.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_143_tcp">
+ <title>Port 143, tcp</title>
+ <para>
+ Used for web IMAP.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_389_tcp">
+ <title>Port 389, tcp</title>
+ <para>
+ Used for LDAP directory services.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_443_tcp">
+ <title>Port 443, tcp</title>
+ <para>
+ Used for secure web interfaces.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_465_tcp">
+ <title>Port 465, tcp</title>
+ <para>
+ Used for secure mail transmission.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_567_tcp">
+ <title>Port 567, tcp</title>
+ <para>
+ Used for secure mail submission.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_636_tcp">
+ <title>Port 636, tcp</title>
+ <para>
+ Used for secure LDAP directory services.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_993_tcp">
+ <title>Port 993, tcp</title>
+ <para>
+ Used for secure IMAP.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+ <listitem>
+ <formalpara id="form-Community_Installation_Guide-System_Firewall-Port_995_tcp">
+ <title>Port 995, tcp</title>
+ <para>
+ Used for secure POP.
+ </para>
+
+ </formalpara>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+
+ </section>
+
<section id="sect-Community_Installation_Guide-Preparing_the_System-System_Users">
<title>System Users</title>
<para>
diff --git a/Installation_Guide/en-US/part-Kolab_Server.xml b/Installation_Guide/en-US/part-Kolab_Server.xml
index 19c54a1..fba3b01 100755
--- a/Installation_Guide/en-US/part-Kolab_Server.xml
+++ b/Installation_Guide/en-US/part-Kolab_Server.xml
@@ -9,6 +9,7 @@
<xi:include href="Kolab_Server_Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Kolab_Server_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Kolab_Server_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Kolab_Server_First_Login.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Kolab_Server_Appendix.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
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 70fcf4a..6176ace 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
@@ -577,6 +577,15 @@
</para>
</formalpara>
+ <example id="exam-Community_Installation_Guide-Repository_Package_Stages-Installing_an_Update_from_updates_testing">
+ <title>Installing an Update from <emphasis>updates-testing</emphasis></title>
+ <para>
+
+<screen># <userinput>yum --enablerepo=kolab-&PRODUCT_VERSION;-updates-testing update [package]</userinput></screen>
+
+ </para>
+
+ </example>
<formalpara id="form-Community_Installation_Guide-Repository_Package_Stages-Software_Currently_in_Development">
<title>Software Currently in Development</title>
<para>