changeset 536:380cd0151890

Update example configuration.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 13 Dec 2013 18:26:03 +0200
parents 88c048f3b9e1
children 12726b4be750
files mconfig.inc.php.example
diffstat 1 files changed, 20 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/mconfig.inc.php.example	Thu Dec 12 00:50:48 2013 +0200
+++ b/mconfig.inc.php.example	Fri Dec 13 18:26:03 2013 +0200
@@ -1,19 +1,35 @@
 <?
-// Site configuration, important settings that MUST be reviewed and set
-// correctly, and generally should not be changed afterwards ...
-// Apart from the debug, and timeout settings.
+//
+// Site configuration, important settings that MUST be
+// reviewed and set correctly before deployment.
+//
 $siteSettings = array(
+
+  // Admin interface password
 //  "admPassword"     => "xxx",
+
+  // SQL database PHP data source name, etc. Refer to
+  // http://www.php.net/manual/en/pdo.construct.php
   "sqlDB"           => "sqlite:fap.sqlite3",
+//  "sqlUsername"     => "",
+//  "sqlUsername"     => "",
 
+  // Debug information in error log, also enables
+  // using GET requests for certain data that normally
+  // can only be used via POST. WARNING! Do NOT enable
+  // for production databases without a good reason.
   "debug"           => false,
 
+  // Default page
   "defaultPage"     => "about", // Default page
 
+  // Vote key length in characters
   "userKeyLength"   => 8,
+
+  // Voting settings
   "voteMin"         => -1,
   "voteMax"         => 2,
-
+  
   "voteKeyMode"     => -1, // See msite.inc.php for VOTE_*
 
   "userTimeout"     => 120,