1 files changed, 68 insertions, 71 deletions
diff --git a/engine/settings.example.php b/engine/settings.example.php
index 30d832456..3b139d710 100644
--- a/engine/settings.example.php
+++ b/engine/settings.example.php
@@ -1,11 +1,17 @@
 <?php
 /**
- * Elgg settings
+ * Defines database credentials.
  *
- * Elgg manages most of its configuration from the admin panel. However, we need you to
- * include your database settings below.
+ * Most of Elgg's configuration is stored in the database.  This file contains the
+ * credentials to connect to the database, as well as a few optional configuration
+ * values.
+ *
+ * The Elgg installation attempts to populate this file with the correct settings
+ * and then rename it to settings.php.
  *
  * @todo Turn this into something we handle more automatically.
+ * @package Elgg.Core
+ * @subpackage Configuration
  */
 
 global $CONFIG;
@@ -23,75 +29,47 @@ if (!isset($CONFIG)) {
  * to explain, but if you know you need it, skip past this section.
  */
 
-// Database username
-$CONFIG->dbuser = '{{CONFIG_DBUSER}}';
-
-// Database password
-$CONFIG->dbpass = '{{CONFIG_DBPASS}}';
-
-// Database name
-$CONFIG->dbname = '{{CONFIG_DBNAME}}';
-
-// Database server
-// (For most configurations, you can leave this as 'localhost')
-$CONFIG->dbhost = '{{CONFIG_DBHOST}}';
-
-// Database table prefix
-// If you're sharing a database with other applications, you will want to use this
-// to differentiate Elgg's tables.
-$CONFIG->dbprefix = '{{CONFIG_DBPREFIX}}';
-
-/*
- * Multiple database connections
+/**
+ * The database username
  *
- * Here you can set up multiple connections for reads and writes. To do this, uncomment out
- * the lines below.
+ * @global string $CONFIG->dbuser
+ * @name $CONFIG->dbuser
  */
+$CONFIG->dbuser = '{{dbuser}}';
 
-/*
-
-// Yes! We want to split reads and writes
-$CONFIG->db->split = true;
-
-// READS
-// Database username
-$CONFIG->db['read']->dbuser = "";
-
-// Database password
-$CONFIG->db['read']->dbpass = "";
-
-// Database name
-$CONFIG->db['read']->dbname = "";
-
-// Database server
-// (For most configurations, you can leave this as 'localhost')
-$CONFIG->db['read']->dbhost = "localhost";
-
-// WRITES
-// Database username
-$CONFIG->db['write']->dbuser = "";
-
-// Database password
-$CONFIG->db['write']->dbpass = "";
-
-// Database name
-$CONFIG->db['write']->dbname = "";
+/**
+ * The database password
+ *
+ * @global string $CONFIG->dbpass
+ */
+$CONFIG->dbpass = '{{dbpassword}}';
 
-// Database server
-// (For most configurations, you can leave this as 'localhost')
-$CONFIG->db['write']->dbhost = "localhost";
+/**
+ * The database name
+ *
+ * @global string $CONFIG->dbname
+ */
+$CONFIG->dbname = '{{dbname}}';
 
+/**
+ * The database host.
+ *
+ * For most installations, this is 'localhost'
+ *
+ * @global string $CONFIG->dbhost
  */
+$CONFIG->dbhost = '{{dbhost}}';
 
-/*
- * For extra connections for both reads and writes, you can turn both
- * $CONFIG->db['read'] and $CONFIG->db['write'] into an array, eg:
+/**
+ * The database prefix
  *
- * 	$CONFIG->db['read'][0]->dbhost = "localhost";
+ * This prefix will be appended to all Elgg tables.  If you're sharing
+ * a database with other applications, use a database prefix to namespace tables
+ * in order to avoid table name collisions.
  *
- * Note that the array keys must be numeric and consecutive, i.e., they start
- * at 0, the next one must be at 1, etc.
+ * @global string $CONFIG->dbprefix
  */
+$CONFIG->dbprefix = '{{dbprefix}}';
 
 
 /**
@@ -102,7 +80,8 @@ $CONFIG->db['write']->dbhost = "localhost";
  * 	1) One or more memcache servers (http://www.danga.com/memcached/)
  *  2) PHP memcache wrapper (http://uk.php.net/manual/en/memcache.setup.php)
  *
- * Note: Multiple server support is only available on server 1.2.1 or higher with PECL library > 2.0.0
+ * Note: Multiple server support is only available on server 1.2.1
+ * or higher with PECL library > 2.0.0
  */
 //$CONFIG->memcache = true;
 //
@@ -111,16 +90,34 @@ $CONFIG->db['write']->dbhost = "localhost";
 //	array('server2', 11211)
 //);
 
+
 /**
- * Some work-around flags.
+ * Use non-standard headers for broken MTAs.
+ *
+ * The default header EOL for headers is \r\n.  This causes problems
+ * on some broken MTAs.  Setting this to TRUE will cause Elgg to use
+ * \n, which will fix some problems sending email on broken MTAs.
+ *
+ * @global bool $CONFIG->broken_mta
  */
-
-// Try uncommenting the below if your notification emails are not being sent
-// $CONFIG->broken_mta = true;
+$CONFIG->broken_mta = FALSE;
 
 /**
- * Url - I am not sure if this will be here ?
- **/
+ * Disable the database query cache
+ *
+ * Elgg stores each query and its results in a query cache.
+ * On large sites or long-running scripts, this cache can grow to be
+ * large.  To disable query caching, set this to TRUE.
+ *
+ * @global bool $CONFIG->db_disable_query_cache
+ */
+$CONFIG->db_disable_query_cache = FALSE;
 
-// URL
-$CONFIG->url = "";
-\ No newline at end of file
+/**
+ * Minimum password length
+ *
+ * This value is used when validating a user's password during registration.
+ *
+ * @global int $CONFIG->min_password_length
+ */
+$CONFIG->min_password_length = 6;