From 129efd13c737ed714e1f5a83b4cb2e122a3569f3 Mon Sep 17 00:00:00 2001
From: Skylar Ittner <admin@netsyms.com>
Date: Thu, 20 Dec 2018 23:54:25 -0700
Subject: [PATCH] Add documentation comments to settings

---
 settings.template.php | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/settings.template.php b/settings.template.php
index 2e346e3..75a1896 100644
--- a/settings.template.php
+++ b/settings.template.php
@@ -6,8 +6,18 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
+// Settings for the app.
+// Copy to settings.php and customize.
+
 $SETTINGS = [
+    // Whether to output debugging info like PHP notices, warnings,
+    // and stacktraces.
+    // Turning this on in production is a security risk and can sometimes break
+    // things, such as JSON output where extra content is not expected.
     "debug" => false,
+
+    // Database connection settings
+    // See http://medoo.in/api/new for info
     "database" => [
         "type" => "mysql",
         "name" => "app",
@@ -16,19 +26,41 @@ $SETTINGS = [
         "password" => "",
         "charset" => "utf8"
     ],
+
+    // Name of the app.
     "site_title" => "Web App Template",
+
+    // Settings for connecting to the AccountHub server.
     "accounthub" => [
+        // URL for the API endpoint
         "api" => "http://localhost/accounthub/api/",
+        // URL of the home page
         "home" => "http://localhost/accounthub/home.php",
+        // API key
         "key" => "123"
     ],
+
+    // For supported values, see http://php.net/manual/en/timezones.php
     "timezone" => "America/Denver",
+
+    // Use Captcheck on login screen to slow down bots
+    // https://captcheck.netsyms.com
     "captcha" => [
         "enabled" => false,
         "server" => "https://captcheck.netsyms.com"
     ],
+
+    // Language to use for localization. See langs folder to add a language.
     "language" => "en",
+
+    // Shown in the footer of all the pages.
     "footer_text" => "",
+
+    // Also shown in the footer, but with "Copyright <current_year>" in front.
     "copyright" => "Netsyms Technologies",
+
+    // Base URL for building links relative to the location of the app.
+    // Only used when there's no good context for the path.
+    // The default is almost definitely fine.
     "url" => "."
-];
\ No newline at end of file
+];