==========================
|| INSTALLING Whups 1.0 ||
==========================

This document contains instructions for installing the Whups web-based
ticket-tracking application on your system.

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


OBTAINING Whups
----------------

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

   http://www.horde.org/whups/
   ftp://ftp.horde.org/pub/whups/

Bleeding-edge development versions of Whups are available via CVS; see
the file docs/HACKING in the Horde distribution for information on
accessing the Horde CVS repository.


PREREQUISITES
-------------

To function properly, Whups requires the following:

  1. A working Horde installation.

     Whups runs within the Horde Application Framework, a set of
     common tools for Web applications written in PHP. You must
     install Horde before installing Whups.

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

        http://www.horde.org/horde/
        ftp://ftp.horde.org/pub/horde/

     Many of Whups's prerequisites are also Horde prerequisites.
     Be sure to have completed all of the steps in the INSTALL
     file for the Horde Framework before installing Whups.

  2. SQL support in PHP.

     Whups store its data in an SQL database. Build PHP with whichever
     SQL driver you require; see the Horde INSTALL file for details.


INSTALLING Whups
----------------

Whups 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, Whups is installed directly underneath
Horde in the webserver's document tree.

Since Whups 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/whups-1.0.tar.gz
   mv whups-1.0 whups

and would then find Whups at the URL

   http://your-server/horde/whups/


CONFIGURING Whups
-----------------

1. Configuring Horde for Whups

   a. Register the application

      In horde/config/registry.php, find the applications['whups']
      stanza. The 'show' parameter should already be marked '=> true'.
      If you have changed the location of Whups relative to Horde,
      either in the URL or in the filesystem or both, you must
      update the 'fileroot' and 'webroot' settings to their correct
      values.

2. Creating the database table

   The specific steps to create the Whups database table depend
   on which database you've chosen to use.

   First, look in scripts/drivers/ to see if a script already
   exists for your database type. If so, you should be
   able to simply execute that script as superuser in your
   database. (Note that executing the script as the "horde" user will
   probably fail when granting privileges.)

   If such a script does not exist, you'll need to build your own, using
   the file whups.sql as a starting point. If you need
   assistance in creating databases, you may wish to let us know on
   the Whups mailing list.

3. Configuring Whups.

   To configure Whups, change to the config/ directory of the
   installed distribution, and make copies of all of the configuration
   "dist" files without the "dist" suffix:

      cd config/
      for foo in *.dist; do cp $foo `basename $foo .dist`; done

   Documentation on the format of those files can be found in each
   file.

   The files in config/ need only be modified if you wish
   to customize Whups' appearance or behavior, as the defaults will
   be correct for most sites.

   You must then login to Horde as a Horde Administrator to finish the
   configuration of Whups.  Use the Horde "Administration" menu item to get
   the the Administration page, and then on the click on the "Configuration"
   icon to get the Configuration page.  Select "Tickets" from the
   selection list of applications, and click on the "Configure" button.  Fill
   in or change any configuration values as needed.  When done click on
   "Generate Tickets Configuration" to generate the conf.php file.  If
   your web server doesn't have write permissions to the Whups configuration
   directory or file, it will not be able to write the file.  In this case, cut
   and paste the returned configuration information into the file
   whups/config/conf.php.

   Note for international users:  Whups uses GNU gettext to provide local
   translations of text displayed by applications; the translations are
   found in the po/ directory.  If a translation is not yet available
   for your locale (and you wish to create one), or if you're having
   trouble using a provided translation, please see the horde/docs/TRANSLATIONS
   file for instructions.

4. Testing Whups

   Use Whups to create your base data, create tickets, and modify
   tickets. Test at least the following:

     - Creating a new project
     - Creating ticket types, states, priorities for a project
     - Adding a ticket
     - Assigning a ticket
     - Closing a ticket


OBTAINING SUPPORT
-----------------

If you encounter problems with Whups, 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 also make occasional
appearances on IRC, on the channel #horde on the freenode Network
(irc.freenode.net).

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

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

Thanks for using Whups!

The Horde team
whups@lists.horde.org

$Horde: whups/docs/INSTALL,v 1.11 2004/10/13 01:42:34 chuck Exp $
