======================
 Installing Turba 3.0
======================

:Contact: turba@lists.horde.org

.. contents:: Contents
.. section-numbering::

This document contains instructions for installing the Turba contact manager
on your system.

For information on the capabilities and features of Turba, see the file
README_ in the top-level directory of the Turba distribution.


Prerequisites
=============

To function properly, Turba **requires** the following:

1. A working Horde installation.

   Turba runs within the `Horde Application Framework`_, a set of common tools
   for web applications written in PHP.  You must install Horde before
   installing Turba.

   .. Important:: Turba 3.0 requires version 4.0+ of the Horde Framework -
                  earlier versions of Horde will **not** work.

   .. Important:: Be sure to have completed all of the steps in the
                  `horde/docs/INSTALL`_ file for the Horde Framework before
                  installing Turba. Many of Turba's prerequisites are also
                  Horde prerequisites. Additionally, many of Turba's optional
                  features are configured via the Horde install.

   .. _`Horde Application Framework`: http://www.horde.org/horde/

The following are not required, but are strongly recommended:

1. SQL and/or LDAP support in PHP.

   Turba can store its contacts entries in either an SQL or an LDAP database,
   and can query public (read-only) LDAP databases for contacts as well.
   Build PHP with whichever LDAP or SQL drivers you require; see the Horde
   INSTALL_ file for details.

2. The following PEAR packages:
   (See `horde/docs/INSTALL`_ for instructions on installing PEAR packages)

   .. Important:: If you are going to install Turba the recommended way,
                  i.e. using the PEAR installer, you can skip the remainder of
                  this section. Installing Turba through PEAR will
                  automatically download and install all required PEAR modules.

   a. Net_LDAP [OPTIONAL]

      Net_LDAP is required when doing schema checks with LDAP address books.


Installing Turba
================

There are several ways to install Turba. The recommended way to install Turba
is using the PEAR installer. Alternatively it can be installed from
tarballs. Finally, if you want to run the latest development code, or get the
latest, not yet released, fixes, you can install Turba from Git.


Installing with PEAR
~~~~~~~~~~~~~~~~~~~~

First follow the instructions in `horde/docs/INSTALL`_ to prepare a PEAR
environment for Horde and install the Horde Framework.

When installing Turba through PEAR now, the installer will automatically
install any dependencies of Turba too. By default, only the required
dependencies will be installed::

   pear install horde/turba

If you want to install Turba even with all optional dependencies, you need to
specify the ``-a`` flag. Please note that this might also try to install PHP
extensions through PECL that might need further configuration or activation in
your PHP configuration::

   pear install -a horde/turba

If you want to install Turba with all optional dependencies, but without the
binary PECL packages that need to be compiled, specify both the ``-a`` and the
``-B`` flag::

   pear install -a -B horde/turba


Installing from Release Tarballs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Important:: As of today, there are no tarballs released for Turba 3
               yet. Please use the `Installing with PEAR`_ method to install
               Turba 3.

Turba can be obtained from the Horde website and FTP server, at

   http://www.horde.org/turba/

   ftp://ftp.horde.org/pub/turba/

Or use the mirror closest to you:

   http://www.horde.org/mirrors.php

Turba is written in PHP, and must be installed in a web-accessible directory.
The precise location of this directory will differ from system to system.
Conventionally, Turba is installed directly underneath Horde in the webserver's
document tree.

Since Turba is written in PHP, there is no compilation necessary; simply expand
the distribution where you want it to reside and rename the root directory of
the distribution to whatever you wish to appear in the URL.  For example, with
the Apache webserver's default document root of ``/usr/local/apache/htdocs``,
you would type::

   cd /usr/local/apache/htdocs/horde
   tar zxvf /path/to/turba-x.y.z.tar.gz
   mv turba-x.y.z turba

and would then find Turba at the URL::

   http://your-server/horde/turba/


Configuring Turba
=================

1. Configuring Turba.

   You must login to Horde as a Horde Administrator to finish the
   configuration of Turba.  Use the Horde ``Administration`` menu item to get
   to the administration page, and then click on the ``Configuration`` icon to
   get the configuration page.  Select ``Address Book`` from the selection
   list of applications.  Fill in or change any configuration values as
   needed.  When done click on ``Generate Address Book Configuration`` to
   generate the ``conf.php`` file.  If your web server doesn't have write
   permissions to the Turba configuration directory or file, it will not be
   able to write the file.  In this case, go back to ``Configuration`` and
   choose one of the other methods to create the configuration file
   ``turba/config/conf.php``.

   Documentation on the format and purpose of the other configuration files in
   the ``config/`` directory can be found in each file. You may create
   ``*.local.php`` versions of these files if you wish to customize Turba's
   appearance and behavior. See the header of the configuration files for
   details and examples. The defaults will be correct for most sites.

   You must create and configure a ``backends.local.php`` unless you only want
   to use the default SQL backend. Any LDAP or custom address book requires
   manual configuration.

2. Creating databases

   Once you finished the configuration in the previous step, you can create all
   database tables by clicking the ``DB schema is out of date.`` link in the
   Turba row of the configuration screen.

   Alternatively you creating the Turba database tables can be accomplished
   with horde's ``horde-db-migrate`` utility.  If your database is properly setup in
   the Horde configuration, just run the following::

      horde/bin/horde-db-migrate turba

3. Securing Turba

   Before you can secure Turba, you need a secure Horde installation.  Please
   read the file in `horde/docs/SECURITY`_ for Horde security information
   before proceeding.

   Some of Turba's configuration files might contain passwords which local
   users could use to access your database.  It is recommended to ensure that
   at least the Turba configuration files (in ``config/``) are not readable to
   system users.  There are ``.htaccess`` files restricting access to
   directories that do not need to be accessed directly; before relying on
   those, ensure that your webserver supports ``.htaccess`` and is configured
   to use them, and that the files in those directories are in fact
   inaccessible via the browser.

   An additional approach is to make Turba's configuration files owned by the
   user ``root`` and by a group which only the webserver user belongs to, and
   then making them readable only to owner and group.  For example, if your
   webserver runs as ``www.www``, do as follows::

      chown root.www config/*
      chmod 0440 config/*

4. Testing Turba

   To verify that Turba is working correctly, attempt to look up a known
   existing and a known nonexisting entry in each of your data sources, and to
   create and then look up a new entry in each data source which allows users
   to create new entries.


Obtaining Support
=================

If you encounter problems with Turba, help is available!

The Horde Frequently Asked Questions List (FAQ), available on the Web at

  http://www.horde.org/faq/

The Horde Project runs a number of mailing lists, for individual applications
and for issues relating to the project as a whole.  Information, archives, and
subscription information can be found at

  http://www.horde.org/mail/

Lastly, Horde developers, contributors and users may also be found on IRC,
on the channel #horde on the Freenode Network (irc.freenode.net).

Please keep in mind that Turba is free software written by volunteers.  For
information on reasonable support expectations, please read

  http://www.horde.org/support.php

Thanks for using Turba!

The Horde team


.. _README: ?f=README.html
.. _INSTALL:
.. _`horde/docs/INSTALL`: ../../horde/docs/?f=INSTALL.html
.. _`docs/HACKING`: ../../horde/docs/?f=HACKING.html
.. _`horde/docs/PERFORMANCE`: ../../horde/docs/?f=PERFORMANCE.html
.. _`horde/docs/SECURITY`: ../../horde/docs/?f=SECURITY.html
.. _`horde/docs/TRANSLATIONS`: ../../horde/docs/?f=TRANSLATIONS.html
