From 7a23dd2e88fd5b54ff4f5869cffefc1beec72464 Mon Sep 17 00:00:00 2001
From: Trevor Slocum <tslocum@gmail.com>
Date: Mon, 27 Oct 2014 16:55:58 -0700
Subject: [PATCH] Reformat settings file

---
 inc/html.php         |   4 +-
 settings.default.php | 102 ++++++++++++++++++++++++++++---------------
 2 files changed, 70 insertions(+), 36 deletions(-)

diff --git a/inc/html.php b/inc/html.php
index 63eca1e..ccaef23 100644
--- a/inc/html.php
+++ b/inc/html.php
@@ -29,7 +29,9 @@ EOF;
 }
 
 function pageFooter() {
-	/* If the footer is removed from the page, please link to TinyIB somewhere on the site. */
+	// If the footer link is removed from the page, please link to TinyIB somewhere on the site.
+	// This is all I ask in return for the free software you are using.
+
 	return <<<EOF
 		<div class="footer">
 			- <a href="http://www.2chan.net" target="_top">futaba</a> + <a href="http://www.1chan.net" target="_top">futallaby</a> + <a href="https://github.com/tslocum/TinyIB" target="_top">tinyib</a> -
diff --git a/settings.default.php b/settings.default.php
index 75c56a0..8658043 100644
--- a/settings.default.php
+++ b/settings.default.php
@@ -1,39 +1,71 @@
 <?php
-define('TINYIB_BOARD', "b"); // Unique identifier for this board using only letters and numbers
+# TinyIB
+#
+# https://github.com/tslocum/TinyIB
+#
+# Contact the author via tslocum@gmail.com if you need support.
+# See README for instructions on configuring, moderating, and upgrading your board.
+# Set TINYIB_DBMODE to a MySQL-related mode if it's available.  By default it's set to flatfile, which can be very slow.
+
+// Administrator/moderator credentials
+define('TINYIB_ADMINPASS', "");       // Administrators have full access to the board
+define('TINYIB_MODPASS', "");         // Moderators only have access to delete (and moderate if TINYIB_REQMOD is set) posts  ["" to disable]
+
+// Board description and behavior
+define('TINYIB_BOARD', "b");          // Unique identifier for this board using only letters and numbers
 define('TINYIB_BOARDDESC', "TinyIB"); // Displayed at the top of every page
-define('TINYIB_THREADSPERPAGE', 10); // Amount of threads shown per index page
-define('TINYIB_MAXTHREADS', 100); // Oldest threads are discarded over this limit  [0 to disable]
-define('TINYIB_TRUNCATE', 15); // Messages are truncated to this many lines on board index pages  [0 to disable]
-define('TINYIB_PREVIEWREPLIES', 3); // Amount of replies previewed on index pages
-define('TINYIB_MAXREPLIES', 0); // Maximum replies before a thread stops bumping  [0 to disable]
-define('TINYIB_MAXKB', 2048); // Maximum file size in kilobytes  [0 to disable]
-define('TINYIB_MAXKBDESC', "2 MB"); // Human-readable representation of the maximum file size
-define('TINYIB_PIC', true); // Enable .jpg, .png and .gif image file upload
-define('TINYIB_SWF', false); // Enable .swf Flash file upload
-define('TINYIB_WEBM', false); // Enable .weba and .webm audio/video file upload  (see README for instructions)
-define('TINYIB_MAXW', 250); // Maximum image width (reply) - Images exceeding these sizes will be thumbnailed
-define('TINYIB_MAXH', 250); // Maximum image height (reply)
-define('TINYIB_MAXWOP', 250); // Maximum image width (new thread)
-define('TINYIB_MAXHOP', 250); // Maximum image height (new thread)
-define('TINYIB_DELAY', 30); // Delay between posts to help control flooding  [0 to disable]
-define('TINYIB_LOGO', ""); // Logo HTML
-define('TINYIB_TRIPSEED', ""); // Enter some random text - Used when generating secure tripcodes - Must not change once set
-define('TINYIB_ADMINPASS', ""); // Text entered at the manage prompt to gain administrator access
-define('TINYIB_MODPASS', ""); // Moderators only have access to delete posts  ["" to disable]
-define('TINYIB_REQMOD', "disable"); // Require moderation before displaying posts: disable / files / all  (see README for instructions, only MySQL is supported)
-define('TINYIB_DBMODE', "flatfile"); // Choose: flatfile / mysql / mysqli / sqlite / pdo  (flatfile is not recommended for popular sites)
-define('TINYIB_DBMIGRATE', false); // Enable database migration tool  (see README for instructions)
+define('TINYIB_REQMOD', "disable");   // Require moderation before displaying posts: disable / files / all  (see README for instructions, only MySQL is supported)
 
-// Note: The following only apply when TINYIB_DBMODE is set to mysql, mysqli (recommended over mysql) or pdo with default (blank) TINYIB_DBDSN (this is recommended most)
-define('TINYIB_DBHOST', "localhost");
-define('TINYIB_DBPORT', 3306); // Set to 0 if you are using a UNIX socket as the host
-define('TINYIB_DBUSERNAME', "");
-define('TINYIB_DBPASSWORD', "");
-define('TINYIB_DBNAME', "");
-define('TINYIB_DBPOSTS', TINYIB_BOARD . "_posts");
-define('TINYIB_DBBANS', "bans");
+// Board appearance
+define('TINYIB_LOGO', "");            // Logo HTML
+define('TINYIB_THREADSPERPAGE', 10);  // Amount of threads shown per index page
+define('TINYIB_PREVIEWREPLIES', 3);   // Amount of replies previewed on index pages
+define('TINYIB_TRUNCATE', 15);        // Messages are truncated to this many lines on board index pages  [0 to disable]
 
-// Note: The following only apply when TINYIB_DBMODE is set to pdo  (see README for instructions)
-define('TINYIB_DBDRIVER', "mysql"); // PDO driver to use (mysql / sqlite / pgsql / etc.)
-define('TINYIB_DBDSN', ""); // Enter a custom DSN to override all of the connection/driver settings above  (see README for instructions)
-# You should still set TINYIB_DBDRIVER appropriately when using a custom DSN
+// Post control
+define('TINYIB_DELAY', 30);           // Delay (in seconds) between posts from the same IP address to help control flooding  [0 to disable]
+define('TINYIB_MAXTHREADS', 100);     // Oldest threads are discarded when the thread count passes this limit  [0 to disable]
+define('TINYIB_MAXREPLIES', 0);       // Maximum replies before a thread stops bumping  [0 to disable]
+
+// File types
+define('TINYIB_PIC', true);           // Enable .jpg, .png and .gif image file upload
+define('TINYIB_SWF', false);          // Enable .swf Flash file upload
+define('TINYIB_WEBM', false);         // Enable .weba and .webm audio/video file upload  (see README for instructions)
+
+// File control
+define('TINYIB_MAXKB', 2048);         // Maximum file size in kilobytes  [0 to disable]
+define('TINYIB_MAXKBDESC', "2 MB");   // Human-readable representation of the maximum file size
+
+// Thumbnail size - new thread
+define('TINYIB_MAXWOP', 250);         // Width
+define('TINYIB_MAXHOP', 250);         // Height
+
+// Thumbnail size - reply
+define('TINYIB_MAXW', 250);           // Width
+define('TINYIB_MAXH', 250);           // Height
+
+// Tripcode seed - Must not change once set!
+define('TINYIB_TRIPSEED', "");        // Enter some random text  (used when generating secure tripcodes)
+
+// Database
+//   Recommended database modes from best to worst:
+//     pdo, mysqli, mysql, sqlite, flatfile  (flatfile is only useful if you need portability or lack any kind of database)
+define('TINYIB_DBMODE', "flatfile");  // Mode
+define('TINYIB_DBMIGRATE', false);    // Enable database migration tool  (see README for instructions)
+define('TINYIB_DBBANS', "bans");      // Bans table name (use the same bans table across boards for global bans)
+define('TINYIB_DBPOSTS', TINYIB_BOARD . "_posts"); // Posts table name
+
+// Database configuration - MySQL
+//   The following only apply when TINYIB_DBMODE is set to mysql, mysqli or pdo with default (blank) TINYIB_DBDSN
+define('TINYIB_DBHOST', "localhost"); // Hostname
+define('TINYIB_DBPORT', 3306);        // Port  (set to 0 if you are using a UNIX socket as the host)
+define('TINYIB_DBUSERNAME', "");      // Username
+define('TINYIB_DBPASSWORD', "");      // Password
+define('TINYIB_DBNAME', "");          // Database
+
+// Database configuration - PDO
+//   The following only apply when TINYIB_DBMODE is set to pdo  (see README for instructions)
+define('TINYIB_DBDRIVER', "mysql");   // PDO driver to use (mysql / sqlite / pgsql / etc.)
+define('TINYIB_DBDSN', "");           // Enter a custom DSN to override all of the connection/driver settings above  (see README for instructions)
+//                                         When changing this, you should still set TINYIB_DBDRIVER appropriately.
+//                                         If you're using PDO with MySQL, you should leave this blank so TinyIB can build the DSN.