BUGFIX: fixed missing include in update_db.php
[e-DoKo.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 8cdf132fbd68a92a650d03565c0bb255f1c0cebb..1929213241253db014ba7c4b55d6ac0419a74152 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,44 +1,60 @@
+
 Installation
 ------------
 
-0) get files
+-1) What you need
+   all you need is PHP and MYSQL. PHP has to include gettext support.
+
+0) Get files
+
+  get all files from
 
-get all files from 
+  http://nubati.net/git/e-DoKo
 
-http://svn.nubati.net/emaildoko/trunk
+1) Create database
 
-1) create database
+  create a mysql database using the provided file
 
-create a mysql database using the provided file
+  mysql < create_database.sql
 
-mysql < create_database.sql
+  use user, password, database and host option of mysql as needed
 
-use user, password, database and host option of mysql as needed
+2) Configure
 
-2) create a config.php file that defines the following variables:
+  Copy config.php_template to config.php and edit it. These variables need to be set:
 
-$host : for example "http://localhost/index.php", note: include the index.php here
+  $HOST:  for example "http://localhost"
+  $INDEX: the absolute web path to your index.php file e.g. "/mypath/index.php"
+  $STATS: the absolute web path to your stats.php file e.g. "/mypath/stast.php"
+  $RSSS:  the absolute web path to your rss.php file e.g. "/mypath/rss.php"
 
-database info:
+  database info:
 
-$DB_host 
-$DB_user 
-$DB_password 
-$DB_database 
+    $DB_host
+    $DB_user
+    $DB_password
+    $DB_database
 
-you can also turn the debug mode on by defining:
-$debug=1;
+  working on the database:
+    in case you need to work on the database for some reason, you can suspend the game
+    by setting $DB_work to 1
 
-this will give some extra output and won't send out emails, but display them in the browser
+  debug mode:
+    you can also turn the debug mode on by defining:
+    $debug=1;
 
-If you hvae problem with the timezone, that is an older PHP version, try adding this in config.php
+    this will give some extra output and won't send out emails, but
+    display them in the browser
 
-function       date_default_timezone_set($zone)
-{
-  return;
-}
+  timezone problem:
+    If you hvae problem with the timezone, that is an older PHP version,
+    try adding this in config.php
 
+    function   date_default_timezone_set($zone)
+    {
+       return;
+    }
 
-3) log in and enjoy ;)
+3) Log in and enjoy ;)
 
 Arun