Clearer directions.

diff --git a/config-dist.php b/config-dist.php
index 48b2b5c2fd16390aaa6813835b2a1e4331dafd82..a9d68d83978eb6c9ae43eea66dedfedede5ec181 100644 (file)
--- a/config-dist.php
+++ b/config-dist.php
@@ -12,7 +12,7 @@
 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //\r
 //          http://moodle.com                                            //\r
 //                                                                       //\r
-// Copyright (C) 2001-2002  Martin Dougiamas  http://dougiamas.com       //\r
+// Copyright (C) 2001-2003  Martin Dougiamas  http://dougiamas.com       //\r
 //                                                                       //\r
 // This program is free software; you can redistribute it and/or modify  //\r
 // it under the terms of the GNU General Public License as published by  //\r
@@ -29,47 +29,61 @@
 ///////////////////////////////////////////////////////////////////////////\r
 \r
 \r
-///////////////////////////////////////////////////////////////////////////\r
+//=========================================================================\r
+// 1. DATABASE SETUP\r
+//=========================================================================\r
 // First, you need to configure the database where all Moodle data       //\r
 // will be stored.  This database must already have been created         //\r
-// and a username/password created to access it.  If you specify mysql   //\r
-// then Moodle can set up all your tables for you.  If you try to use    //\r
-// a different database you will need to set up all your tables by hand  //\r
-// which could be a big job.    See doc/install.html                     //\r
+// and a username/password created to access it.                         //\r
+//                                                                       //\r
+//   mysql      - the prefix is optional, but useful when installing     //\r
+//                into databases that already contain tables.            //\r
+//   postgres7  - the prefix is REQUIRED, regardless of whether the      //\r
+//                database is empty of not.                              //\r
 \r
-$CFG->dbtype    = "mysql";     // mysql or postgres7 \r
-$CFG->dbhost    = "localhost"; // eg localhost \r
-$CFG->dbname    = "moodletest";    // eg moodle\r
-$CFG->dbuser    = "username";\r
-$CFG->dbpass    = "password";\r
+$CFG->dbtype    = "mysql";       // mysql or postgres7 (for now)\r
+$CFG->dbhost    = "localhost";   // eg localhost or db.isp.com \r
+$CFG->dbname    = "moodle";      // database name, eg moodle\r
+$CFG->dbuser    = "username";    // your database username\r
+$CFG->dbpass    = "password";    // your database password\r
 \r
-$CFG->prefix    = "mdl_";      // Prefix value to use for all table names\r
+$CFG->prefix    = "mdl_";        // Prefix to use for all table names\r
 \r
 \r
-///////////////////////////////////////////////////////////////////////////\r
+//=========================================================================\r
+// 2. WEB SITE LOCATION\r
+//=========================================================================\r
 // Now you need to tell Moodle where it is located. Specify the full\r
 // web address where moodle has been installed (without trailing slash)\r
 \r
 $CFG->wwwroot   = "http://example.com/moodle";\r
 \r
 \r
-///////////////////////////////////////////////////////////////////////////\r
+//=========================================================================\r
+// 3. SERVER FILES LOCATION\r
+//=========================================================================\r
 // Next, specify the full OS directory path to this same location\r
 // For Windows this might be something like "C:\apache\htdocs\moodle"\r
 \r
 $CFG->dirroot   = "/web/moodle";\r
 \r
 \r
-///////////////////////////////////////////////////////////////////////////\r
+//=========================================================================\r
+// 4. DATA FILES LOCATION\r
+//=========================================================================\r
 // Now you need a place where Moodle can save uploaded files.  This\r
 // directory should be writeable by the web server user (usually 'nobody'\r
 // or 'apache'), but it should not be accessible directly via the web.\r
-// On Windows systems you might specify something like "C:\moodledata"\r
+// - On hosting systems you might need to make sure that your "group" has\r
+//   no permissions at all, but that "others" have full permissions.\r
+// - On Windows systems you might specify something like "C:\moodledata"\r
 \r
 $CFG->dataroot  = "/home/moodledata";\r
 \r
 \r
-///////////////////////////////////////////////////////////////////////////\r
+//=========================================================================\r
+// 5. TROUBLESHOOTING  (most people can just ignore this setting)\r
+//=========================================================================\r
 // A very small percentage of servers have a bug which causes HTTP_REFERER\r
 // not to work.  The symptoms of this are that you fill out the configure\r
 // form during Moodle setup but when hit save you find yourself on the \r
@@ -79,11 +93,14 @@ $CFG->dataroot  = "/home/moodledata";
 $CFG->buggy_referer = false;\r
 \r
 \r
-///////////////////////////////////////////////////////////////////////////\r
-// To continue the setup, use your web browser to go to your Moodle page //\r
-///////////////////////////////////////////////////////////////////////////\r
+//=========================================================================\r
+// 6. ALL DONE!  To continue your setup, visit your Moodle web page.\r
+//=========================================================================\r
+\r
 \r
 $CFG->libdir    = "$CFG->dirroot/lib";   // Do not change this\r
 require("$CFG->libdir/setup.php");       // Do not change this\r
 \r
+// MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES, \r
+// RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.\r
 ?>\r