Administrator_Guide/en-US

Jeroen van Meeuwen vanmeeuwen at kolabsys.com
Mon Aug 6 16:42:01 CEST 2012


 Administrator_Guide/en-US/Verifying_the_Installation.xml |  363 +++++++++++++--
 1 file changed, 333 insertions(+), 30 deletions(-)

New commits:
commit b8bf3b0de7671290ac3a6e8fa704a9df0e10c205
Author: Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen at kolabsys.com>
Date:   Mon Aug 6 15:41:44 2012 +0100

    Start off with at least some verbiage on verifying the installation

diff --git a/Administrator_Guide/en-US/Verifying_the_Installation.xml b/Administrator_Guide/en-US/Verifying_the_Installation.xml
index c027db2..73d4a22 100644
--- a/Administrator_Guide/en-US/Verifying_the_Installation.xml
+++ b/Administrator_Guide/en-US/Verifying_the_Installation.xml
@@ -6,37 +6,340 @@
 <chapter id="chap-Administrator_Guide-Verifying_the_Installation">
     <title>Verifying the Installation</title>
     <para>
-        para
+        This chapter concerns verifying the Kolab Groupware installation works as expected, to the limited realm this documentation can serve. If you have modified the Kolab Groupware deployment to match your needs, some of the following verification steps may not function as expected.
     </para>
-    <para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    running services
-                </para>
-
-            </listitem>
-            <listitem>
-                <para>
-                    configuration file changes since the installation
-                </para>
-
-            </listitem>
-            <listitem>
-                <para>
-                    dumping all configuration variables
-                </para>
-
-            </listitem>
-            <listitem>
-                <para>
-                    verifying all files installed
-                </para>
-
-            </listitem>
-
-        </itemizedlist>
+    <section id="sect-Administrator_Guide-Verifying_the_Installation-Running_Services">
+        <title>Running Services</title>
+        <para>
+            Verify the following services are running:
+        </para>
+        <para>
+            <itemizedlist>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-a389_Directory_Server">
+                        <title>389 Directory Server</title>
+                        <para>
+                            The LDAP server is crucial to authentication, authorization, user and group information and mail routing, and must be running.
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                Verify the service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service dirsrv status</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Verify the service is listening on the expected port(s):
+                            </para>
+                            <para>
+
+<screen># <userinput>netstat -ltnp | grep -E ":(389|636)"</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Verify the firewall allows access to those ports, if the <literal>iptables</literal> service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service iptables status</userinput>
+# <userinput>iptables -L INPUT -n -v | grep -E "dpt:(389|636)" | grep ACCEPT</userinput></screen>
+
+                            </para>
+                            <note>
+                                <para>
+                                    Kolab Groupware does not configure your firewall for you. You may have decided to work your firewall yourself, in which case the former commands may not include any ouput.
+                                </para>
+
+                            </note>
+
+                        </step>
+
+                    </procedure>
+
+                    <para>
+                        Log files for 389 Directory Server are located in <filename>/var/log/dirsrv/slapd-*/</filename>.
+                    </para>
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-Kolab_SASL_Authentication_Daemon">
+                        <title>Kolab SASL Authentication Daemon</title>
+                        <para>
+                            The Kolab SASL authentication daemon is used by Postfix and Cyrus IMAP, to authenticate users.
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                Verify the service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service kolab-saslauthd status</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Make some attempts to authenticate:
+                            </para>
+                            <para>
+
+<screen># <userinput>testsaslauthd -u <replaceable>cyrus-admin</replaceable> -p <replaceable>$password</replaceable></userinput>
+# <userinput>testsaslauthd -u <replaceable>john.doe at example.org</replaceable> -p <replaceable>$password</replaceable></userinput>
+# <userinput>testsaslauthd -u <replaceable>doe</replaceable> -p <replaceable>$password</replaceable></userinput>
+# <userinput>testsaslauthd -u <replaceable>doe</replaceable> -r <replaceable>example.org</replaceable> -p <replaceable>$password</replaceable></userinput></screen>
+
+                            </para>
+
+                        </step>
+
+                    </procedure>
+
+                    <para>
+                        The log file for the Kolab SASL authentication daemon is <filename>/var/log/kolab/pykolab.log</filename>.
+                    </para>
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-Cyrus_IMAP">
+                        <title>Cyrus IMAP</title>
+                        <para>
+                            Essential for access to all email and other groupware data.
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                Verify the service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service cyrus-imapd status</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Verify the service is listening on the expected port(s):
+                            </para>
+                            <para>
+
+<screen># <userinput>netstat -tlnp | grep -E ":(143|993)"</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Verify the firewall allows access to those ports, if the <literal>iptables</literal> service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service iptables status</userinput>
+# <userinput>iptables -L INPUT -n -v | grep -E "dpt:(143|993)" | grep ACCEPT</userinput></screen>
+
+                            </para>
+                            <note>
+                                <para>
+                                    Kolab Groupware does not configure your firewall for you. You may have decided to work your firewall yourself, in which case the former commands may not include any ouput.
+                                </para>
+
+                            </note>
+
+                        </step>
+                        <step>
+                            <para>
+                                Attempt to connect and authenticate:
+                            </para>
+                            <para>
+
+<screen># <userinput>imtest -t "" -u <replaceable>john.doe at example.org</replaceable> -w <replaceable>$password</replaceable> localhost</userinput>
+# <userinput>imtest -t "" -u <replaceable>doe</replaceable> -w <replaceable>$password</replaceable> localhost</userinput></screen>
+
+                            </para>
+
+                        </step>
+
+                    </procedure>
+
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-Apache_Webserver">
+                        <title>Apache Webserver</title>
+                        <para>
+                            The Apache webserver is needed for the Kolab Web Client, Administration Panel and the exchange of Free/Busy information.
+                        </para>
+
+                    </formalpara>
+                    <procedure id="proc-Administrator_Guide-Running_Services-Verifying_the_Apache_Webserver_Service_is_Running">
+                        <title>Verifying the Apache Webserver Service is Running</title>
+                        <step>
+                            <para>
+                                Verify the service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service httpd status</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Verify the service is listening on the correct ports:
+                            </para>
+                            <para>
+
+<screen># <userinput>netstat -ltnp | grep -E ":(80|443)"</userinput></screen>
+
+                            </para>
+
+                        </step>
+                        <step>
+                            <para>
+                                Verify the firewall allows access to those ports, if the <literal>iptables</literal> service is running:
+                            </para>
+                            <para>
+
+<screen># <userinput>service iptables status</userinput>
+# <userinput>iptables -L INPUT -n -v | grep -E "dpt:(80|443)" | grep ACCEPT</userinput></screen>
+
+                            </para>
+                            <note>
+                                <para>
+                                    Kolab Groupware does not configure your firewall for you. You may have decided to work your firewall yourself, in which case the former commands may not include any ouput.
+                                </para>
+
+                            </note>
+
+                        </step>
+                        <step>
+                            <para>
+                                Attempt to get a few pages:
+                            </para>
+                            <para>
+
+<screen># <userinput>wget -O- http://localhost</userinput>
+# <userinput>wget -O- https://localhost</userinput></screen>
+
+                            </para>
+                            <note>
+                                <para>
+                                    Kolab Groupware does not, by default, configure the webserver to also listen on HTTPS port 443.
+                                </para>
+
+                            </note>
+
+                        </step>
+
+                    </procedure>
+
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-MySQL">
+                        <title>MySQL</title>
+                        <para>
+                            para
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                para
+                            </para>
+
+                        </step>
+
+                    </procedure>
+
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-Kolab_Web_Administration_Panel">
+                        <title>Kolab Web Administration Panel</title>
+                        <para>
+                            para
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                para
+                            </para>
+
+                        </step>
+
+                    </procedure>
+
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-Roundcube_Webmail">
+                        <title>Roundcube Webmail</title>
+                        <para>
+                            para
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                para
+                            </para>
+
+                        </step>
+
+                    </procedure>
+
+
+                </listitem>
+                <listitem>
+                    <formalpara id="form-Administrator_Guide-Running_Services-The_Kolab_Daemon">
+                        <title>The Kolab Daemon</title>
+                        <para>
+                            para
+                        </para>
+
+                    </formalpara>
+                    <procedure>
+                        <step>
+                            <para>
+                                para
+                            </para>
+
+                        </step>
+
+                    </procedure>
+
+
+                </listitem>
+
+            </itemizedlist>
+
+        </para>
+
+    </section>
+
 
-    </para>
 </chapter>
 





More information about the commits mailing list