bernhard: doc/www/src webclient.html.m4,1.6,1.7
cvs at kolab.org
cvs at kolab.org
Mon Aug 21 15:16:59 CEST 2006
Author: bernhard
Update of /kolabrepository/doc/www/src
In directory doto:/tmp/cvs-serv18731
Modified Files:
webclient.html.m4
Log Message:
Removed outdated horde installation instructions and pointed to two wiki pages.
Index: webclient.html.m4
===================================================================
RCS file: /kolabrepository/doc/www/src/webclient.html.m4,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- webclient.html.m4 18 Jul 2005 07:35:36 -0000 1.6
+++ webclient.html.m4 21 Aug 2006 13:16:57 -0000 1.7
@@ -2,464 +2,32 @@
m4_include(header.html.m4)
<div id="date">This page was updated on:<br />$Date$</div>
-<p class="hint">Please direct any comments and suggestions about this guide to
-<a href="mailto:omicron at mighty.co.za">Stuart Bingë</a></p>
-<hr />
+<p>
+
+</p>
<div class="warning">
-<b>NOTE: The webclient is considered EXPERIMENTAL and as such should NOT be
-used in production.</b> However, if you're feeling brave and want to help out
+<b>NOTE: The Horde webclient is considered EXPERIMENTAL
+and as such should NOT be used in production.</b>
+However, if you're feeling brave and want to help out
with testing & identifying problems with the webclient, your help would be
greatly appreciated. You may discuss any issues that you have on the
-<a href="/mailman/listinfo/kolab-devel">kolab-devel</a> mailing list. All bugs
-should be reported on the <a href="http://bugs.horde.org/">Horde bug
+<a href="/mailman/listinfo/kolab-devel">kolab-devel</a> mailing list.
+All bugs should be reported on the <a href="http://bugs.horde.org/">Horde bug
tracker</a>.
</div>
-<div class="section">
-<p>Credits and thanks must also go out to the
-<a href="http://www.horde.org/">Horde project</a>, on which the Kolab Webclient
-is based. The Kolab Webclient is essentially a composition of several Horde
-applications (namely the Horde framework, IMP, Turba, Mnemo, Nag and Kronolith),
-with additional code allowing these applications to use a Kolab server as a
-groupware backend.</p>
-
-<p>You may also find additional information about the webclient installation
-on the <a href="http://wiki.kolab.org/">Kolab Wiki</a> - if you encounter
-problems when installing the webclient be sure to visit the wiki. It is updated
-more frequently than this guide and as such will probably contain additional
-information to help you out. Specifically, be sure to take a look at the
-<a href="http://wiki.kolab.org/index.php/Kolab2_Installation_-_Horde">Kolab2 Installation - Horde</a>
-page.</p>
-
-<p>Before you begin with this guide, it is recommended that you put the
-following in the <code>~/.cvsrc</code> file of the user who will be checking
-out and installing the webclient code from CVS:
-<pre class="shell">
-cvs -z4 -q
-update -dP
-checkout -P
-diff -u3 -p
-</pre></p>
-</div>
-
-<hr />
-
-<a name="toc"><h2>Table of Contents</h2></a>
-<ol>
-
-<li><a href="#install">Installation</a>
-<ol>
-<li><a href="#inst_sql">SQL</a></li>
-<li><a href="#inst_pear">PEAR</a></li>
-<li><a href="#inst_horde">Horde</a></li>
-</ol>
-</li>
-
-<li><a href="#config">Configuration</a>
-<ol>
-<li><a href="#conf_ldap">LDAP</a></li>
-<li><a href="#conf_sql">SQL</a></li>
-<li><a href="#conf_horde">Horde</a></li>
-</ol>
-</li>
-
-<li><a href="#optional">Optional</a>
-<ol>
-<li><a href="#opt_phpa">PHP Accelerator</a></li>
-<li><a href="#opt_opa">OPA Script</a></li>
-</ol>
-</li>
-
-</ol>
-
-<hr />
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="install"><h2>1. Installation</h2></a>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="inst_sql"><h3>1.1. SQL</h3></a>
-
-<div class="section">
-<p>Horde requires a SQL server to store various server and user data. Several
-SQL servers are supported, however only two are covered here (as they are part
-of OpenPKG and as such are easy to install alongside Kolab):
-<a href="ftp://ftp.openpkg.org/release/2.2/UPD/mysql-4.0.21-2.2.1.src.rpm">MySQL</a>
-and
-<a href="ftp://ftp.openpkg.org/release/2.2/UPD/postgresql-7.4.5-2.2.1.src.rpm">PostgreSQL</a>.
-</p>
-
-<p>Select the SQL server that you wish to use above and install the necessary
-RPM. With either selection, you will need to recompile your Apache and PHP RPMs
-with additional flags in order to allow PHP to support your chosen SQL variant.
-For MySQL you'll need:
-<pre class="shell">
---with=mod_php_mysql # for your apache rpm
---with=mysql # for your php rpm
-</pre>
-and for PostgreSQL you'll need:
-<pre class="shell">
---with=mod_php_pgsql # for your apache rpm
---with=pgsql # for your php rpm
-</pre>
-in addition to the existing <code>--with</code> flags for both packages,
-of course.</p>
-
-<p>For those of you who are interested: the dependency on a SQL server can be
-dropped if a LDAP driver is written for the Horde Datatree system, in which case
-the same data that would be stored in SQL will be stored in LDAP. This has not
-yet been attempted, so for the moment SQL is still needed.</p>
-</div>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="inst_pear"><h3>1.2. PEAR</h3></a>
-
-<div class="section">
-<p>The Apache package that Kolab 2 uses includes recent versions of several
-PEAR packages, however there are a couple of additional packages that you will
-need to obtain in order for Horde to operate properly:
-
-<pre class="shell">
-# /kolab/bin/pear install -f Net_IMAP Log Mail_Mime File Date
-</pre></p>
-
-<p>If you receive errors about being unable to modify files and directories
-because of safe_mode being in effect, then you'll have to modify your
-<code>/kolab/etc/php/php.ini</code> file and disable safe mode. The line in
-question should look like the following after modification:
-
-<pre class="shell">
-safe_mode = off ; Enable Safe Mode (file UID comparisons)
-</pre></p>
-</div>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="inst_horde"><h3>1.3. Horde</h3></a>
-
-<div class="section">
-<p>Horde is installed by checking out code from CVS. You'll need to install a
-CVS client if you don't already have one, or else you can check out the code
-on another machine and simply copy the files across.
-<a href="http://ftp.horde.org/pub/snaps/latest/">Snapshots</a> are also
-available via HTTP, so if you do not have access to CVS you can fall back to
-these. Installation via CVS is preferred, as updating your Horde installation
-is much simpler this way than performing the same operation using snapshot
-tarballs. Also note that the HEAD branch of each horde module is required.</p>
-
-<p>Check out the necessary Horde modules from Horde's CVS (instructions from
-<a href="http://www.horde.org/source/using.php">http://www.horde.org/source/using.php</a>):
-<pre class="shell">
-# cd /kolab/var/kolab/www
-# cvs -d :pserver:cvsread at anoncvs.horde.org:/repository login
-</pre>
-(When asked for a password, use 'horde').
-<pre class="shell">
-# cvs -d :pserver:cvsread at anoncvs.horde.org:/repository checkout horde
-# cd horde
-# cvs -d :pserver:cvsread at anoncvs.horde.org:/repository checkout framework imp kronolith mnemo nag passwd turba ingo
-</pre>
-You now need to install the Horde Framework (this must be run within the Kolab
-OpenPKG environment, e.g. by using the <a href="#opt_opa">opa</a> script):
-<pre class="shell">
-# cd framework
-# /kolab/bin/php install-packages.php
-</pre></p>
-<p>At any time after this point you can update your Horde instance to the latest
-available code by simply performing the following commands:
-<pre class="shell">
-# cd /kolab/var/kolab/www/horde
-# cvs update
-</pre>
-Be sure to repeat the process to install the Horde Framework when updating CVS,
-otherwise you may encounter critical errors when using the webclient.
-</p>
-
-<p>Finally, create a data directory that Horde can use:
-<pre class="shell">
-# mkdir -p /kolab/var/horde/vfs
-# chown -R kolab-n:kolab-n /kolab/var/horde
-</pre>
-</p>
-
-<p>Most of the following instructions can also be found in the
-<code>/kolab/var/kolab/www/horde/docs/INSTALL</code> file, which goes into far
-more detail about the installation process than what is presented here. It is
-recommended that you read this file to gain a greater understanding of the
-Horde installation process - this install guide glosses over many details, only
-presenting the major steps that are required to set up Horde specifically for
-use as a Kolab 2 client.</p>
-</div>
-
-<hr />
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="config"><h2>2. Configuration</h2></a>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="conf_ldap"><h3>2.1. LDAP</h3></a>
-
-<div class="section">
-<p>Horde requires an additional schema file to be installed in order to use
-LDAP as a preference backend. Add the following to your
-<code>/kolab/etc/kolab/templates/slapd.conf.template</code> after
-the existing schema include lines:
-<pre class="shell">
-include /kolab/var/kolab/www/horde/scripts/ldap/horde.schema
-</pre>
-Save the template and run <code>/kolab/sbin/kolabconf</code> to regenerate the
-configuration file and restart OpenLDAP.</p>
-</div>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="conf_sql"><h3>2.2. SQL</h3></a>
-
-<div class="section">
-<p>Horde requires its own table within your SQL server to store various
-configuration data. You can find instructions on how to configure your database
-in the following file:
-<code>/kolab/var/kolab/www/horde/scripts/sql/README</code>. Be sure to change
-the Horde user's password when setting up the tables, as well as the password of
-your database's root user (if applicable).</p>
-</div>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="conf_horde"><h3>2.3. Horde</h3></a>
-
-<div class="section">
-<p>Firstly you need to install the distribution default configuration files,
-present in the <code>config</code> subdirectory within each Horde application
-(including the base Horde library itself):
-<pre class="shell">
-# for a in . mnemo nag turba imp ingo kronolith passwd; do cd /kolab/var/kolab/www/horde/$a/config; for f in *.dist; do cp $f `basename $f .dist`; done; done
-</pre>
-and then set the correct file permissions:
-<pre class="shell">
-# cd /kolab/var/kolab/www
-# chown -R kolab-n:kolab-n horde
-# chmod -R o-rwx horde
-</pre></p>
-
-<p>Some Horde configuration files need to be edited by hand; the rest can be
-auto-generated through the Horde Admin interface. The files you need to edit,
-and what needs to be done in each file, is as follows:</p>
-
-<dl>
-<dt><code>imp/config/servers.php</code></dt>
-<dd>Delete all the <code>$servers['XXX']</code> blocks except the
-<code>$servers['kolab']</code> definition (should be right at the end
-of the file).</dd>
-
-<dt><code>ingo/config/backends.php</code></dt>
-<dd>Delete all the <code>$backends['XXX']</code> blocks except the
-<code>$backends['kolab']</code> definition (should be right at the end
-of the file).</dd>
-
-<dt><code>passwd/config/backends.php</code></dt>
-<dd>Delete all the <code>$backends['XXX']</code> blocks except the
-<code>$backends['kolab']</code> definition (should be right at the end
-of the file).</dd>
-
-<dt><code>turba/config/sources.php</code></dt>
-<dd>Delete all the <code>$cfgSources['XXX']</code> blocks except the
-<code>$backends['kolab_global']</code> and <code>$backends['kolab_local']</code>
-definitions (should both be the last two entries in the file).</dd>
-</dl>
-</p>
-
-<p>You now need to configure all the Horde applications. Log in to your Horde
-installation, at <code>http://your.kolab.server/horde/</code>. Once you're in,
-click on the <code>Administration</code> link on the sidebar, then the
-<code>Setup</code> sub-option. You should see a list of available Horde
-applications in the main frame - you now need to go through this list and
-configure each Horde application as you please. Click on an entry in this list;
-you should be brought to a configuration screen. Go through each tab within
-this screen (if there are multiple tabs; otherwise there will just be a single
-page) and change any settings as you see fit (although the default options
-are usually sufficient if you don't feel comfortable editing all the available
-variables). Once you have finished configuring an application, click on the
-<code>Generate XXX Configuration</code> button at the bottom of the page to
-auto-generate the relevant <code>conf.php</code> file for the specific
-application. Repeat this process for every application in the
-<code>Configuration</code> page.</p>
-
-<p>To enable Horde to inter-operate with your Kolab server the following
-configuration options should be adhered to for each application:</p>
-
-<dl>
-<dt>Address Book (<code>turba</code>)</dt>
-<dd>The default configuration should prove sufficient.</dd>
-
-<dt>Calendar (<code>kronolith</code>)</dt>
-<dd>Select the <code>Kolab</code> driver for both the <code>Calendar</code>
-and <code>Free/Busy</code> sections.</dd>
-
-<dt>Filters (<code>ingo</code>)</dt>
-<dd>The default configuration should prove sufficient.</dd>
+<p>
+The Horde webclient is discussed on the
+<a href="http://wiki.kolab.org/">Kolab Wiki</a>.
+Specifically sections:
-<dt>Horde (<code>horde</code>)</dt>
-<dd><ul><li>In the <code>Database</code> tab, select the database that you are
-using in the top select box. You must also set the <code>password</code> field
-to whatever you specified for the horde user when setting up the database.</li>
-<li>In the <code>Authentication</code> tab, select <code>Kolab (Cyrus IMAP)
-authentication</code> as the authentication backend (should be the last entry
-in the drop-down list). You will also need to specify a Kolab account in the
-<code>Administrators</code> field in order to re-configure Horde at a later
-stage (as well as to complete configuration of the remaining applications!).
-It is recommended that you create a Kolab account such as
-<code>horde-admin at my.kolab.domain</code> for this purpose.</li>
-<li>In the <code>Logging</code> tab, change the <code>Path to the log
-file</code> field to <code>/kolab/var/horde/horde.log</code>.</li>
-<li>In the <code>Preference System</code> tab, select <code>Kolab (LDAP)</code>
-as the preferences driver (again, should be the last entry in the drop-down
-list).</li>
-<li>In the <code>DataTree System</code> tab, select <code>SQL Database</code>
-as the DataTree backend storage. Make sure the <code>Driver configuration</code>
-is also set to <code>Horde defaults</code>.</li>
-<li>In the <code>Mailer</code> tab, select <code>Use a SMTP server</code> as
-the method for sending mail.</li>
-<li>In the <code>Virtual File Storage</code>, leave the VFS backend selection
-as <code>File on the local system</code>; in the <code>Where on the real
-filesystem should Horde use as root of the virtual filesystem?</code> field,
-enter <code>/kolab/var/horde/vfs</code>.</li>
-<li>Finally, in the <code>Kolab Groupware Server</code> tab, change the
-<code>Horde/Kolab integration status</code> field to <code>enabled</code> and
-set each field in the resulting screen to the values pertaining to your
-specific kolab installation. The most important of these correspond to those
-in your <code>/kolab/etc/kolab/kolab.conf</code> file.</li>
+<ul>
+ <li> <a href="http://wiki.kolab.org/index.php/Kolab2_Installation_-_Horde"
+ >Kolab2 Installation - Horde</a>
+ <li> <a href="http://wiki.kolab.org/index.php/Horde">Horde</a>
</ul>
-</dd>
-
-<dt>Mail (<code>imp</code>)</dt>
-<dd><!-- Make sure the bottom two options are checked on the <code>Custom
-Hooks</code> tab. --> You may want to specify the location of the
-<code>ispell</code> or <code>aspell</code> binary, if you have one of these
-installed, in the <code>External Utilities and Menu</code> tab in order to
-allow users to spellcheck their email. There is also the option of using a
-<code>gpg</code> binary to provide encryption support to the mail
-application.</dd>
-
-<dt>Notes (<code>mnemo</code>)</dt>
-<dd>Select the <code>Kolab</code> driver under the <code>Storage System</code>
-section.</dd>
-
-<dt>Password (<code>passwd</code>)</dt>
-<dd>Uncheck the option entitled <code>Should we allow the user to specify the
-username?</code>.</dd>
-
-<dt>Tasks (<code>nag</code>)</dt>
-<dd>Select the <code>Kolab</code> driver under the <code>Storage System</code>
-section.</dd>
-</dl>
-</p>
-
-</div>
-
-<hr />
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="optional"><h2>3. Optional</h2></a>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="opt_phpa"><h3>3.1. PHP Accelerator</h3></a>
-
-<div class="section">
-<p>This step is not needed in order for Horde to operate, however it is highly
-recommended if you are concerned about the operating speed of the webclient.
-This guide instructs on how to install the
-<a href="http://www.phpaccelerator.co.uk/">ionCube PHP Accelerator</a>, as it
-is simple to set up and provides a noticeable performance boost. If you prefer
-other accelerators and are able to get them to work with Kolab then please send
-instructions on how to install them and we'll add them here.</p>
-
-<p>Download the relevant package for your platform and PHP version from the
-<a href="http://www.phpaccelerator.co.uk/download.php">ionCube Downloads
-Page</a>. As of time of writing for PHP version 4.3.0 running on x86 Linux,
-this would be
-<a href="http://www.phpaccelerator.co.uk/releases/linux_i686-glibc2.1.3/1.3.3r2_4.3.0/php_accelerator-1.3.3r2_php-4.3.0_linux_i686-glibc2.1.3.tgz">1.3.3r2</a>.
-You should read the <code>INSTALL</code> and <code>CONFIGURATION</code> files
-that are distributed with PHPA for details on how to fine-tune performance.
-If you just want to quickly set up an accelerated environment for use with
-Horde then the following commands should be suitable:</p>
-
-<pre class="shell">
-# cd /tmp
-# gzip -dc php_accelerator*.tgz | tar -xvf -
-# mv php_accelerator*/php_accelerator*.so /kolab/lib
-# chown kolab:kolab /kolab/lib/php_accelerator*.so
-</pre>
-
-<p>Add the following to <code>/kolab/etc/kolab/templates/php.ini.template</code>:
-<pre class="shell">
-; PHP Accelerator extension
-zend_extension="/kolab/lib/php_accelerator_1.3.3r2.so"
-
-; This should be as large as you can spare. The default is 8, which is not
-; optimal for a project as large as Horde.
-phpa.shm_size = 16
-</pre>
-</p>
-
-<p>It is also recommended that you increase the value of
-<code>memory_limit</code> in the same template file to <code>12M</code> or even
-<code>16M</code>, for optimal use with Horde.</p>
-
-<p>Save <code>/kolab/etc/kolab/templates/php.ini.template</code> and run
-<code>/kolab/sbin/kolabconf</code> to re-generate PHP's configuration file and
-restart Apache. You can test to see if the extension is operational by viewing
-the following script through your Kolab web server:
-<pre class="shell">
-<?php phpinfo(); ?>
-</pre>
-</p>
-
-<p>You should see something similar to the following after the initial
-version information:
-<pre class="shell">
-This program makes use of the Zend Scripting Language Engine:
-Zend Engine v1.3.0, Copyright (c) 1998-2003 Zend Technologies
-with the ionCube PHP Accelerator v1.3.3r2, Copyright (c) 2001-2002,
-by Nick Lindridge
-</pre>
-</p>
-</div>
-
-<div class="toclnk"><a href="#toc">↑ contents</a></div>
-<a name="opt_opa"><h3>3.2. OPA Script</h3></a>
-
-<div class="section">
-<p>The OPA script is a small shell script used to place the current session in
-the Kolab (or indeed any OpenPKG) environment. This is generally needed when
-working with the Kolab server; otherwise you run the risk of your base systems'
-utilities handling commands instead of the corresponding Kolab programs.</p>
-
-<p>To place yourself in the Kolab environment using the OPA script, you simply
-type the following (assuming your kolab hierarchy is stored in the
-<code>/kolab</code> directory):
-<pre class="shell">
-# opa /kolab
-</pre>
</p>
-
-<p>Place this script in your <code>~/.bashrc</code> file, or other similar such
-shell startup file.
-<pre class="shell">
-opa () {
- root="$1"
- if [ ! -d $root ]; then
- echo "opa:ERROR: OpenPKG root directory $root not found"
- return 1
- fi
- if [ ! -f "$root/etc/rc" ]; then
- echo "opa:ERROR: does not contain OpenPKG hierarchy"
- return 1
- fi
- eval `$root/etc/rc --eval all env`
-}
-</pre>
-</p>
-
-</div>
m4_include(footer.html.m4)
More information about the commits
mailing list