This file describes the installation procedure of coWiki. For further
information refer to <http://www.develnet.org/>.

$Id: INSTALL,v 1.3 2003/09/09 02:46:56 dtg Exp $

Content

* Requirements
* Installation for the impatient

---------------------------------------------------------------------------

* Requirements

  * Unix or an unix-like operating system
    - coWiki is meant to run on Unix/Linux or similar operating system.
      It *might* run on Windows but it is not tested and currently not
      supported.
  * Apache 1.3.13 web server or later version
  * MySQL 3.23.23 database or later version
  * PHP 5.0.x or later version
  * of course all together up and running

---------------------------------------------------------------------------

* Installation for the impatient

  * HINT: If coWiki does not work for you out of the box, please watch
          the error.log of your virtual host where coWiki is located in:

          tail -f /PATH/TO/YOUR/VHOST/logs/error.log

  * Unpack the cowiki-x.x.x.tar.gz file. You will find following
    directories:

      htdocs/
      includes/
      misc/

  * Copy "htdocs/" and "includes/" to your virtual host location.

  * Make sure to change owner and group of all files to fit your setup.

  * Create a database and a user with all rights granted to this database.
    Reload the database to apply your changes.

  * Install the database using the appropriate "misc/database/*.sql" schema

  * In your virtual host directory, change to "includes/cowiki/"
    * copy the "core.conf-dist" file to "core.conf"
    * edit the "core.conf" file and set the appropriate values. At least
      set these values for the following directives (that's minimal)
    
      [.DOCUMENT]
          RESOURCE = ...
    
      [.AUTH]
          RESOURCE = ...

      [.USER]
          RESOURCE = ...

      In a standard standalone installation, all values for RESOURCE are
      equal.

  * Make sure that PHPs "include_path" setting points to the htdocs/ and
    coWiki includes/ directories. This could look like:

      include_path = ".:../includes/cowiki"

  * In case that you are running PHP as DSO (module for apache): change the
    access of the "core.conf" file to 0600 for the web server user id.

  * In case that you are running PHP as CGI (standalone executable): change
    the access of the "core.conf" file to 0600 for the user id the CGI is
    running.
