Add documentation comments to settings

master
Skylar Ittner 5 years ago
parent c179ed7ebb
commit 129efd13c7

@ -6,8 +6,18 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/ */
// Settings for the app.
// Copy to settings.php and customize.
$SETTINGS = [ $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, "debug" => false,
// Database connection settings
// See http://medoo.in/api/new for info
"database" => [ "database" => [
"type" => "mysql", "type" => "mysql",
"name" => "app", "name" => "app",
@ -16,19 +26,41 @@ $SETTINGS = [
"password" => "", "password" => "",
"charset" => "utf8" "charset" => "utf8"
], ],
// Name of the app.
"site_title" => "Web App Template", "site_title" => "Web App Template",
// Settings for connecting to the AccountHub server.
"accounthub" => [ "accounthub" => [
// URL for the API endpoint
"api" => "http://localhost/accounthub/api/", "api" => "http://localhost/accounthub/api/",
// URL of the home page
"home" => "http://localhost/accounthub/home.php", "home" => "http://localhost/accounthub/home.php",
// API key
"key" => "123" "key" => "123"
], ],
// For supported values, see http://php.net/manual/en/timezones.php
"timezone" => "America/Denver", "timezone" => "America/Denver",
// Use Captcheck on login screen to slow down bots
// https://captcheck.netsyms.com
"captcha" => [ "captcha" => [
"enabled" => false, "enabled" => false,
"server" => "https://captcheck.netsyms.com" "server" => "https://captcheck.netsyms.com"
], ],
// Language to use for localization. See langs folder to add a language.
"language" => "en", "language" => "en",
// Shown in the footer of all the pages.
"footer_text" => "", "footer_text" => "",
// Also shown in the footer, but with "Copyright <current_year>" in front.
"copyright" => "Netsyms Technologies", "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" => "." "url" => "."
]; ];

Loading…
Cancel
Save