BUGFIX: added a config.php template to the repository and updated the INSTALL files

diff --git a/INSTALL b/INSTALL
index bed28d57d550e1d9699da6596c206ba39516bff3..a30d26ca05255a33ebde3ab0641d5515fc0c829b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,13 +1,17 @@
+
 Installation
 ------------
 
-0) get files
+-1) What you need
+   all you need is PHP and MYSQL
+
+0) Get files
 
-  get all files from 
+  get all files from
 
   http://nubati.net/git/e-DoKo
 
-1) create database
+1) Create database
 
   create a mysql database using the provided file
 
@@ -15,16 +19,18 @@ Installation
 
   use user, password, database and host option of mysql as needed
 
-2) create a config.php file that defines the following variables:
+2) Configure
+
+  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
 
   database info:
 
-    $DB_host 
-    $DB_user 
-    $DB_password 
-    $DB_database 
+    $DB_host
+    $DB_user
+    $DB_password
+    $DB_database
 
   working on the database:
     in case you need to work on the database for some reason, you can suspend the game
@@ -46,7 +52,6 @@ Installation
        return;
     }
 
-
-3) log in and enjoy ;)
+3) Log in and enjoy ;)
 
 Arun

diff --git a/config.php_template b/config.php_template
new file mode 100644 (file)
index 0000000..fb84a51
--- /dev/null
+++ b/config.php_template
@@ -0,0 +1,32 @@
+<?php
+
+    /* the program needs this to access the mysql database */
+    $DB_host    = "";
+    $DB_user    = "";
+    $DB_password = "";
+    $DB_database = "";
+
+    /* set this to 1 to debug the server
+     * emails won't be send out, but  be shown on the page;
+     * each player name at the table will be a link to get
+     * to his view;
+     */
+    $debug = 0;
+
+    /* set this to 1, if you want to work on the DB
+     * the users won't be able to log in and get a message
+     * to check back later
+     */
+    $DB_work = 0;
+
+    $ADMIN_NAME = "";
+    $ADMIN_EMAIL = "";
+
+    /* the prefix for the subject of each email */
+    $EmailName = "[DoKo]";
+    /* used as the reply email in each email */
+    $EMAIL_REPLY="";
+
+    /* this should point to your index.file */
+    $host = "http://.../index.php"
+?>
\ No newline at end of file