- Allow blacklisting and whitelisting of e-mail addresses used for new user accounts
[scuttle] / config.inc.php.example
1 <?php
2 ######################################################################
3 # SCUTTLE: Online social bookmarks manager
4 ######################################################################
5 # Copyright (c) 2005 - 2010 Scuttle project
6 # http://scuttle.org/
7 #
8 # This module is to configure the main options for your site
9 #
10 # This program is free software. You can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 2 of the License.
13 ######################################################################
14
15 ######################################################################
16 # Database Configuration
17 #
18 # dbtype:   Database driver - mysql, mysqli, mysql4, oracle, postgres,
19 #                             sqlite, db2, firebird, mssql, mssq-odbc
20 # dbhost:   Database hostname
21 # dbport:   Database port
22 # dbuser:   Database username
23 # dbpass:   Database password
24 # dbname:   Database name
25 ######################################################################
26
27 $dbtype = 'mysql';
28 $dbhost = '127.0.0.1';
29 $dbport = '3306';
30 $dbuser = 'username';
31 $dbpass = 'password';
32 $dbname = 'scuttle';
33
34 ######################################################################
35 # Basic Configuration
36 ######################################################################
37 # sitename:     The name of this site
38 # locale:       The locale used - de_DE, dk_DK, en_GB, es_ES, fr_FR, hi_IN,
39 #               it_IT, ja_JP, lt_LT, nl_NL, pt_BR, sk_SK, zh_CN, zh_TW
40 # adminemail:   Contact address for the site administrator. Used as the from:
41 #               address in password retrieval e-mails.
42 ######################################################################
43
44 $sitename   = 'Scuttle';
45 $locale     = 'en_GB';
46 $adminemail = 'admin@example.org';
47
48 ######################################################################
49 # You have finished configuring the database!
50 # ONLY EDIT THE INFORMATION BELOW IF YOU KNOW WHAT YOU ARE DOING.
51 ######################################################################
52 # System Configuration
53 #
54 # top_include:      The header file.
55 # bottom_include:   The footer file.
56 # shortdate:        The format of short dates.
57 # longdate:         The format of long dates.
58 # nofollow:             true    - Include rel="nofollow" attribute on
59 #                                 bookmark links.
60 #                       false   - Don't include rel="nofollow".
61 # defaultPerPage:   The default number of bookmarks per page.
62 #                   -1 means no limit!
63 # defaultRecentDays:    The number of days that bookmarks or tags should
64 #                       be considered recent.
65 # defaultOrderBy:   The default order in which bookmarks will appear.
66 #                   Possible values are:
67 #                   date_desc   - By date of entry descending.
68 #                                 Latest entry first. (Default)
69 #                   date_asc    - By date of entry ascending.
70 #                                 Earliest entry first.
71 #                   title_desc  - By title, descending alphabetically.
72 #                   title_asc   - By title, ascending alphabetically.
73 #                   url_desc    - By URL, descending alphabetically.
74 #                   url_asc     - By URL, ascending alphabetically.
75 # TEMPLATES_DIR: The directory where the template files should be
76 #                loaded from (the *.tpl.php files)
77 # root         : Set to NULL to autodetect the root url of the website
78 # cookieprefix : The prefix to use for the cookies on the site
79 # tableprefix  : The table prefix used for this installation
80 # cleanurls    : true   - Use mod_rewrite to hide PHP extensions
81 #              : false  - Don't hide extensions [Default]
82 #
83 # usecache     : true   - Cache pages when possible
84 #                false  - Don't cache at all [Default]
85 # dir_cache    : The directory where cache files will be stored
86 #
87 # useredir     : true   - Improve privacy by redirecting all bookmarks
88 #                         through the address specified in url_redir
89 #                false  - Don't redirect bookmarks
90 # url_redir    : URL prefix for bookmarks to redirect through
91 #
92 # filetypes    : An array of bookmark extensions that Scuttle should
93 #                add system tags for.
94 # reservedusers : An array of usernames that cannot be registered
95 # url_blacklist   : Array of regex patterns. User is banned and existing
96 #                     bookmarks are hidden if a match is found.
97 # email_whitelist : Array of regex patterns. Used to whitelist addresses that
98 #                     may otherwise match the blacklist.
99 # email_blacklist : Array of regex patterns. Registration is blocked if a
100 #                     match is found.
101 ######################################################################
102
103 $top_include       = 'top.inc.php';
104 $bottom_include    = 'bottom.inc.php';
105 $shortdate         = 'd-m-Y';
106 $longdate          = 'j F Y';
107 $nofollow          = true;
108 $defaultPerPage    = 10;
109 $defaultRecentDays = 14;
110 $defaultOrderBy    = 'date_desc';
111 $TEMPLATES_DIR     = dirname(__FILE__) .'/templates/';
112 $root              = NULL;
113 $cookieprefix      = 'SCUTTLE';
114 $tableprefix       = 'sc_';
115 $adminemail        = 'admin@example.org';
116 $cleanurls         = false;
117
118 $usecache          = false;
119 $dir_cache         = dirname(__FILE__) .'/cache/';
120
121 $useredir          = false;
122 $url_redir         = 'http://www.google.com/url?sa=D&q=';
123
124 $filetypes         = array(
125                        'audio' => array('mp3', 'ogg', 'wav'),
126                        'document' => array('doc', 'odt', 'pdf'),
127                        'image' => array('gif', 'jpeg', 'jpg', 'png'),
128                        'video' => array('avi', 'mov', 'mp4', 'mpeg', 'mpg', 'wmv')
129                      );
130
131 $reservedusers     = array('all', 'watchlist');
132
133 $email_whitelist   = NULL;
134 $email_blacklist   = array(
135                        '/(.*-){2,}/',
136                         '/mailinator\.com/i'
137                      );
138
139 include_once 'debug.inc.php';

Benjamin Mako Hill || Want to submit a patch?