]> projects.mako.cc - scuttle/blobdiff - config.inc.php.example
updated readme with information on a series of bugs I know exist
[scuttle] / config.inc.php.example
index 71e6406c9c22cdcdb16b5761abce8c53674cd6e9..c55666a29bcfb192ef3a97506c9988b002b65d5b 100644 (file)
@@ -2,8 +2,7 @@
 ######################################################################
 # SCUTTLE: Online social bookmarks manager
 ######################################################################
-# Copyright (C) 2005 - 2006 Scuttle project
-# http://sourceforge.net/projects/scuttle/
+# Copyright (c) 2005 - 2010 Marcus Campbell
 # http://scuttle.org/
 #
 # This module is to configure the main options for your site
@@ -32,14 +31,26 @@ $dbuser = 'username';
 $dbpass = 'password';
 $dbname = 'scuttle';
 
+######################################################################
+# Basic Configuration
+######################################################################
+# sitename:     The name of this site
+# locale:       The locale used - de_DE, dk_DK, en_GB, es_ES, fr_FR, hi_IN,
+#               it_IT, ja_JP, lt_LT, nl_NL, pt_BR, sk_SK, zh_CN, zh_TW
+# adminemail:   Contact address for the site administrator. Used as the from:
+#               address in password retrieval e-mails.
+######################################################################
+
+$sitename   = 'Scuttle';
+$locale     = 'en_GB';
+$adminemail = 'admin@example.org';
+
 ######################################################################
 # You have finished configuring the database!
 # ONLY EDIT THE INFORMATION BELOW IF YOU KNOW WHAT YOU ARE DOING.
 ######################################################################
 # System Configuration
 #
-# sitename:         The name of this site.
-# locale:           The locale used.
 # top_include:      The header file.
 # bottom_include:   The footer file.
 # shortdate:        The format of short dates.
@@ -53,21 +64,23 @@ $dbname = 'scuttle';
 #                       be considered recent.
 # defaultOrderBy:   The default order in which bookmarks will appear.
 #                   Possible values are:
-#                   date_desc   - By date of entry descending.
-#                                 Latest entry first. (Default)
-#                   date_asc    - By date of entry ascending.
-#                                 Earliest entry first.
-#                   title_desc  - By title, descending alphabetically.
-#                   title_asc   - By title, ascending alphabetically.
-#                   url_desc    - By URL, descending alphabetically.
-#                   url_asc     - By URL, ascending alphabetically.
+#                   date_desc     - By date of entry descending.
+#                                   Latest entry first. (Default)
+#                   date_asc      - By date of entry ascending.
+#                                   Earliest entry first.
+#                   mod_date_desc - By modification date descending.
+#                                   Latest modified entry first.
+#                   mod_date_asc  - By modification date ascending.
+#                                   Earliest modified entry first.
+#                   title_desc    - By title, descending alphabetically.
+#                   title_asc     - By title, ascending alphabetically.
+#                   url_desc      - By URL, descending alphabetically.
+#                   url_asc       - By URL, ascending alphabetically.
 # TEMPLATES_DIR: The directory where the template files should be
 #                loaded from (the *.tpl.php files)
 # root         : Set to NULL to autodetect the root url of the website
 # cookieprefix : The prefix to use for the cookies on the site
 # tableprefix  : The table prefix used for this installation
-# adminemail   : Contact address for the site administrator. Used
-#                as the FROM address in password retrieval e-mails.
 # cleanurls    : true   - Use mod_rewrite to hide PHP extensions
 #              : false  - Don't hide extensions [Default]
 #
@@ -83,38 +96,50 @@ $dbname = 'scuttle';
 # filetypes    : An array of bookmark extensions that Scuttle should
 #                add system tags for.
 # reservedusers : An array of usernames that cannot be registered
+# email_whitelist : Array of regex patterns. Used to whitelist addresses that
+#                     may otherwise match the blacklist.
+# email_blacklist : Array of regex patterns. Registration is blocked if a
+#                     match is found.
 ######################################################################
 
-$sitename           = 'Scuttle';
-$locale             = 'en_GB';
-$top_include        = 'top.inc.php';
-$bottom_include     = 'bottom.inc.php';
-$shortdate          = 'd-m-Y';
-$longdate           = 'j F Y';
-$nofollow           = true;
-$defaultPerPage     = 10;
-$defaultRecentDays  = 14;
-$defaultOrderBy     = 'date_desc';
-$TEMPLATES_DIR      = dirname(__FILE__) .'/templates/';
-$root               = NULL;
-$cookieprefix       = 'SCUTTLE';
-$tableprefix        = 'sc_';
-$adminemail         = 'admin@example.org';
-$cleanurls          = false;
+$top_include       = 'top.inc.php';
+$bottom_include    = 'bottom.inc.php';
+$shortdate         = 'd-m-Y';
+$longdate          = 'j F Y';
+$nofollow          = TRUE;
+$defaultPerPage    = 10;
+$defaultRecentDays = 14;
+$defaultOrderBy    = 'date_desc';
+$TEMPLATES_DIR     = dirname(__FILE__) .'/templates/';
+$root              = NULL;
+$cookieprefix      = 'SCUTTLE';
+$tableprefix       = 'sc_';
+$adminemail        = 'admin@example.org';
+$cleanurls         = FALSE;
+
+$usecache          = FALSE;
+$dir_cache         = dirname(__FILE__) .'/cache/';
+
+$useredir          = FALSE;
+$url_redir         = 'http://www.google.com/url?sa=D&q=';
+
+$filetypes         = array(
+                      'audio'      => array('aac', 'mp3', 'm4a', 'oga', 'ogg', 'wav'),
+                      'document'   => array('doc', 'docx', 'odt', 'pages', 'pdf', 'txt'),
+                      'image'      => array('gif', 'jpe', 'jpeg', 'jpg', 'png', 'svg'),
+                      'bittorrent' => array('torrent'),
+                      'video'      => array('avi', 'flv', 'mov', 'mp4', 'mpeg', 'mpg', 'm4v', 'ogv', 'wmv')
+                     );
 
-$usecache           = false;
-$dir_cache          = dirname(__FILE__) .'/cache/';
+$reservedusers     = array('all', 'watchlist');
 
-$useredir           = false;
-$url_redir          = 'http://www.google.com/url?sa=D&q=';
+$email_whitelist   = NULL;
+$email_blacklist   = array(
+                      '/(.*-){2,}/',
+                      '/mailinator\.com/i'
+                     );
 
-$filetypes          = array(
-                        'audio' => array('mp3', 'ogg', 'wav'),
-                        'document' => array('doc', 'odt', 'pdf'),
-                        'image' => array('gif', 'jpeg', 'jpg', 'png'),
-                        'video' => array('avi', 'mov', 'mp4', 'mpeg', 'mpg', 'wmv')
-                        );
-$reservedusers      = array('all', 'watchlist');
+$archive_links = TRUE;
+$archive_base_url = "https://web.archive.org";
 
-include_once('debug.inc.php');
-?>
+include_once 'debug.inc.php';

Benjamin Mako Hill || Want to submit a patch?