Rev 231 Rev 246
1 ; singapore main configuration file <http://singapore.sourceforge.net> 1 ; singapore main configuration file <http://singapore.sourceforge.net>
2 ; 2 ;
3 ; Split into sections (Basic, Paths, Functionality, SQL & Advanced) 3 ; Split into sections (Basic, Paths, Functionality, SQL & Advanced)
4 ; for ease of reading. Sections are ignored by the script. 4 ; for ease of reading. Sections are ignored by the script.
5 ; 5 ;
6 ; Any of these settings can be overridden in gallery.ini or 6 ; Any of these settings can be overridden in gallery.ini or
7 ; template.ini files. See the readme for more information. 7 ; template.ini files. See the readme for more information.
8 ; 8 ;
9 ; Template specific settings may be found in the template.ini 9 ; Template specific settings may be found in the template.ini
10 ; file located in the template's root directory. 10 ; file located in the template's root directory.
11   11  
12   12  
13 [Basic] 13 [Basic]
14 ; 14 ;
15 ; settings that most users will want to look at and possibly change 15 ; settings that most users will want to look at and possibly change
16 ; 16 ;
17   17  
18 thumbnail_software = "gd2" 18 thumbnail_software = "gd2"
19 ;the software to use to generate the thumbnails 19 ;the software to use to generate the thumbnails
20 ; gd1 = GD v1.x 20 ; gd1 = GD v1.x
21 ; gd2 = GD v2.x 21 ; gd2 = GD v2.x
22 ; im = ImageMagick v5.x 22 ; im = ImageMagick v5.x
23 ; im6 = ImageMagick v6.x 23 ; im6 = ImageMagick v6.x
24 24
25 gallery_name = "MLAB" 25 gallery_name = "MLAB"
26 ;this is the text that will appear in the title bar of all 26 ;this is the text that will appear in the title bar of all
27 ;generated pages and also the root node of the crumb line 27 ;generated pages and also the root node of the crumb line
28 28
29 default_template = "modern" 29 default_template = "modern"
30 ;the name of the template to use when none is specified 30 ;the name of the template to use when none is specified
31 31
32 default_language = "en" 32 default_language = "en"
33 ;the language code for the language that you would like to use. 33 ;the language code for the language that you would like to use.
34 ;you must have the appropriate language file in the locale directory. 34 ;you must have the appropriate language file in the locale directory.
35   35  
36 gallery_sort_order = "x" 36 gallery_sort_order = "x"
37 ;the order in which galleries will be displayed. Can take the following values: 37 ;the order in which galleries will be displayed. Can take the following values:
38 ; p = sort by directory name (ascending) 38 ; p = sort by directory name (ascending)
39 ; P = sort by directory name (descending) 39 ; P = sort by directory name (descending)
40 ; n = sort by gallery name (ascending) 40 ; n = sort by gallery name (ascending)
41 ; N = sort by gallery name (descending) 41 ; N = sort by gallery name (descending)
42 ; i = sort by gallery name (case insensitive, ascending) 42 ; i = sort by gallery name (case insensitive, ascending)
43 ; I = sort by gallery name (case insensitive, descending) 43 ; I = sort by gallery name (case insensitive, descending)
44 ; a = sort by artist name (ascending) 44 ; a = sort by artist name (ascending)
45 ; A = sort by artist name (descending) 45 ; A = sort by artist name (descending)
46 ; d = sort by date (ascending) 46 ; d = sort by date (ascending)
47 ; D = sort by date (descending) 47 ; D = sort by date (descending)
48 ; note: date comparison is done as a string comparison on the 'date' database 48 ; note: date comparison is done as a string comparison on the 'date' database
49 ; field. So for example "2003-10-22" comes before "22 October 2003" 49 ; field. So for example "2003-10-22" comes before "22 October 2003"
50 ; x = do not sort (default) 50 ; x = do not sort (default)
51 51
52 image_sort_order = "x" 52 image_sort_order = "x"
53 ;the order in which images will be displayed. Can take the following values: 53 ;the order in which images will be displayed. Can take the following values:
54 ; f = sort by file name (ascending) 54 ; f = sort by file name (ascending)
55 ; F = sort by file name (descending) 55 ; F = sort by file name (descending)
56 ; n = sort by image name (ascending) 56 ; n = sort by image name (ascending)
57 ; N = sort by image name (descending) 57 ; N = sort by image name (descending)
58 ; i = sort by image name (case insensitive, ascending) 58 ; i = sort by image name (case insensitive, ascending)
59 ; I = sort by image name (case insensitive, descending) 59 ; I = sort by image name (case insensitive, descending)
60 ; a = sort by artist name (ascending) 60 ; a = sort by artist name (ascending)
61 ; A = sort by artist name (descending) 61 ; A = sort by artist name (descending)
62 ; d = sort by date (ascending) 62 ; d = sort by date (ascending)
63 ; D = sort by date (descending) 63 ; D = sort by date (descending)
64 ; note: date comparison is done as a string comparison on the 'date' database 64 ; note: date comparison is done as a string comparison on the 'date' database
65 ; field. So for example "2003-10-22" comes before "22 October 2003" 65 ; field. So for example "2003-10-22" comes before "22 October 2003"
66 ; l = sort by location (ascending) 66 ; l = sort by location (ascending)
67 ; L = sort by location (descending) 67 ; L = sort by location (descending)
68 ; x = do not sort (default) 68 ; x = do not sort (default)
69 69
70 upload_overwrite = 2 70 upload_overwrite = 2
71 ;what to do when uploading an image or gallery that already exists: 71 ;what to do when uploading an image or gallery that already exists:
72 ; 0 do not overwrite, raise an error (default) 72 ; 0 do not overwrite, raise an error (default)
73 ; 1 overwrite without prompting 73 ; 1 overwrite without prompting
74 ; 2 attempt to generate a new unique name 74 ; 2 attempt to generate a new unique name
75 75
76   76  
77 [Functionality] 77 [Functionality]
78 ; 78 ;
79 ; some features are turned off by default. Try them out by turning them on here. 79 ; some features are turned off by default. Try them out by turning them on here.
80 ; 80 ;
81   81  
82 language_flipper = on 82 language_flipper = on
83 ;turn on to display a select box which allows users to select a language 83 ;turn on to display a select box which allows users to select a language
84   84  
85 template_flipper = on 85 template_flipper = on
86 ;turn on to display a select box which allows users to select a template 86 ;turn on to display a select box which allows users to select a template
87   87  
88 full_image_resize = off 88 full_image_resize = off
89 ;turn on to force all full-size images to be resized to the size specified 89 ;turn on to force all full-size images to be resized to the size specified
90 ;in the current template's template.ini 90 ;in the current template's template.ini
91 91
92 imagemap_navigation = off 92 imagemap_navigation = off
93 ;turns full-size images into image maps so that clicking on 93 ;turns full-size images into image maps so that clicking on
94 ;them takes you forward/backward/up 94 ;them takes you forward/backward/up
95 95
96 track_views = on 96 track_views = on
97 ;whether to keep track of how many times images and 97 ;whether to keep track of how many times images and
98 ;galleries have been viewed 98 ;galleries have been viewed
99   99  
100 show_views = on 100 show_views = on
101 ;whether to display how many times images and galleries 101 ;whether to display how many times images and galleries
102 ;have been viewed 102 ;have been viewed
103   103  
104 show_execution_time = on 104 show_execution_time = on
105 ;display script execution time in milliseconds 105 ;display script execution time in milliseconds
106   106  
107 enable_iifn = on 107 enable_iifn = on
108 ;enables parsing of directory and file names of the form 108 ;enables parsing of directory and file names of the form
109 ;'artist_name - image_name' into metadata information 109 ;'artist_name - image_name' into metadata information
110 110
111 obfuscate_email = on 111 obfuscate_email = on
112 ;tries to conceal email addresses from spambots by 112 ;tries to conceal email addresses from spambots by
113 ;replacing '.' with ' dot ' and '@' with ' at ' 113 ;replacing '.' with ' dot ' and '@' with ' at '
114 114
115 enable_clickable_urls = on 115 enable_clickable_urls = on
116 ;makes the script detect URLs in image & gallery descriptions 116 ;makes the script detect URLs in image & gallery descriptions
117 ;and make them 'clickable' by adding the appropriate HTML 117 ;and make them 'clickable' by adding the appropriate HTML
118   118  
119 remove_jpeg_profile = off 119 remove_jpeg_profile = off
120 ;true to tell ImageMagick to remove any profile information 120 ;true to tell ImageMagick to remove any profile information
121 ;from generated thumbnails. This has been known to cause some 121 ;from generated thumbnails. This has been known to cause some
122 ;problems hence it being disabled by default 122 ;problems hence it being disabled by default
123 123
124 progressive_thumbs = on 124 progressive_thumbs = on
125 ;generate progressive JPEG and interlaced GIF & PNG images. 125 ;generate progressive JPEG and interlaced GIF & PNG images.
126 126
127 use_mod_rewrite = off 127 use_mod_rewrite = off
128 ;format generated URLs for use with Apache mod_rewrite 128 ;format generated URLs for use with Apache mod_rewrite
129 ;you need to enable mod_rewrite and create an appropriate .htaccess file 129 ;you need to enable mod_rewrite and create an appropriate .htaccess file
130 130
131 detect_language = off 131 detect_language = off
132 ;attempt to detect user language from browser information 132 ;attempt to detect user language from browser information
133 ;if this fails the default_language will be used 133 ;if this fails the default_language will be used
134 134
135   135  
136 [Paths] 136 [Paths]
137 ; 137 ;
138 ; The default paths will be fine for most people. 138 ; The default paths will be fine for most people.
139 ; 139 ;
140   140  
141 pathto_templates = "templates/" 141 pathto_templates = "templates/"
142 ;path to directory containing templates 142 ;path to directory containing templates
143 ;must be specified relative to singapore root 143 ;must be specified relative to singapore root
144 144
145 pathto_data_dir = "data/" 145 pathto_data_dir = "data/"
146 ;path to writable data directory 146 ;path to writable data directory
147 ;must be specified relative to singapore root 147 ;must be specified relative to singapore root
148 148
149 pathto_galleries = "galleries/" 149 pathto_galleries = "galleries/"
150 ;path to galleries directory 150 ;path to galleries directory
151 ;must be specified relative to singapore root 151 ;must be specified relative to singapore root
152 152
153 pathto_locale = "locale/" 153 pathto_locale = "locale/"
154 ;path to directory containing internationalisation files (singapore.LANG.pmo) 154 ;path to directory containing internationalisation files (singapore.LANG.pmo)
155 ;must be specified relative to singapore root 155 ;must be specified relative to singapore root
156   156  
157 pathto_convert = "convert" 157 pathto_convert = "convert"
158 ;full path to ImageMagick convert utility if it is not in your PATH 158 ;full path to ImageMagick convert utility if it is not in your PATH
159 159
160 pathto_unzip = "unzip" 160 pathto_unzip = "unzip"
161 ;full path to Info-Zip unzip utility or equivalent if it is not in your PATH 161 ;full path to Info-Zip unzip utility or equivalent if it is not in your PATH
162   162  
163 ;base_path option is in the [Advanced] section below 163 ;base_path option is in the [Advanced] section below
164   164  
165 [SQL] 165 [SQL]
166 ; 166 ;
167 ; settings relevant to all the SQL backends (except SQLite). 167 ; settings relevant to all the SQL backends (except SQLite).
168 ; You may ignore these if you are not using one of these backends. 168 ; You may ignore these if you are not using one of these backends.
169 ; For security reasons username and password are stored in secret.ini.php 169 ; For security reasons username and password are stored in secret.ini.php
170 ; 170 ;
171   171  
172 sql_host = "localhost" 172 sql_host = "localhost"
173 ;name of computer running MySQL server (usually localhost) 173 ;name of computer running MySQL server (usually localhost)
174 ;a port number may be included as in "example.com:1234" 174 ;a port number may be included as in "example.com:1234"
175 175
176 sql_database = "singapore" 176 sql_database = "singapore"
177 ;database in which information will be stored. this must already exist. 177 ;database in which information will be stored. this must already exist.
178   178  
179 sql_prefix = "sg_" 179 sql_prefix = "sg_"
180 ;this will be prefixed to the names of the tables created (galleries, images & users). 180 ;this will be prefixed to the names of the tables created (galleries, images & users).
181 ;each singapore installation running on same database should have a different prefix. 181 ;each singapore installation running on same database should have a different prefix.
182   182  
183 [FTP] 183 [FTP]
184 ; 184 ;
185 ; The safe_mode hack uses FTP to create galleries. 185 ; The safe_mode hack uses FTP to create galleries.
186 ; You may ignore these settings if your server is not runing in safe_mode. 186 ; You may ignore these settings if your server is not runing in safe_mode.
187 ; For security reasons username and password are stored in secret.ini.php 187 ; For security reasons username and password are stored in secret.ini.php
188 ; 188 ;
189   189  
190 safe_mode_hack = off 190 safe_mode_hack = off
191 ;set to on to enable the hack 191 ;set to on to enable the hack
192   192  
193 ftp_server = "" 193 ftp_server = ""
194 ;the hostname you use to login to your website 194 ;the hostname you use to login to your website
195 ;a port number may be included as in "example.com:1234" 195 ;a port number may be included as in "example.com:1234"
196 196
197 ftp_base_path = "" 197 ftp_base_path = ""
198 ;path from ftp root to singapore root 198 ;path from ftp root to singapore root
199 199
200 [Advanced] 200 [Advanced]
201 ; 201 ;
202 ; settings most users will not need to change 202 ; settings most users will not need to change
203 ; 203 ;
204   204  
205 io_handler = "mysql" 205 io_handler = "mysql"
206 ;the type of database to use. recognised values are: 206 ;the type of database to use. recognised values are:
207 ; csv = flat file, no database needed (default) 207 ; csv = flat file, no database needed (default)
208 ; mysql = MySQL database (configure sql_* settings above and in secret.ini.php) 208 ; mysql = MySQL database (configure sql_* settings above and in secret.ini.php)
209 ; sqlite = SQLite database (does not require any further configuration) 209 ; sqlite = SQLite database (does not require any further configuration)
210 210
211 allow_dir_upload = 0 211 allow_dir_upload = 0
212 ;allow uploading archives containing arbitrary files. 212 ;allow uploading archives containing arbitrary files.
213 ; 0 = allow no one 213 ; 0 = allow no one
214 ; 1 = allow all registered users 214 ; 1 = allow all registered users
215 ; 2 = allow only administrators 215 ; 2 = allow only administrators
216 216
217 admin_template_name = "admin_default" 217 admin_template_name = "admin_default"
218 ;the name of the admin template to use 218 ;the name of the admin template to use
219 219
220 thumbnail_quality = 75 220 thumbnail_quality = 75
221 ;the JPEG quality of generated thumbnails 221 ;the JPEG quality of generated thumbnails
222 ;100 is the highest quality 0 is the lowest 222 ;100 is the highest quality 0 is the lowest
223 223
224 session_name = "PHPSESSID" 224 session_name = "PHPSESSID"
225 ;the name of the admin session. each independent singapore 225 ;the name of the admin session. each independent singapore
226 ;installation on the same domain should have a different name 226 ;installation on the same domain should have a different name
227 227
228 default_charset = "utf-8" 228 default_charset = "utf-8"
229 ;the character encoding to use for generated pages if none 229 ;the character encoding to use for generated pages if none
230 ;is specified in the current language file 230 ;is specified in the current language file
231 231
232 index_file_url = "index.php?" 232 index_file_url = "index.php?"
233 ;filename of index file plus any query-string 233 ;filename of index file plus any query-string
234 ;if a path is specified it must be absolute 234 ;if a path is specified it must be absolute
235 235
236 base_path = "" 236 base_path = ""
237 ;file-system-view absolute or relative path to installation 237 ;file-system-view absolute or relative path to installation
238 ;can usually be left blank 238 ;can usually be left blank
239 239
240 base_url = "" 240 base_url = ""
241 ;web-view absolute or relative url of installation. 241 ;web-view absolute or relative url of installation.
242 ;can usually be left blank 242 ;can usually be left blank
243 243
244 recognised_extensions = "jpeg|jpg|jpe|png|gif|bmp|tif|tiff" 244 recognised_extensions = "jpeg|jpg|jpe|png|gif|bmp|tif|tiff"
245 ;list of file extensions that will be recognised as images 245 ;list of file extensions that will be recognised as images
246 ;this forms part of a pcre hence the vertical bars (meaning OR) 246 ;this forms part of a pcre hence the vertical bars (meaning OR)
247   247  
248 allowed_tags = "<a><b><i><u><em><strong><strike>" 248 allowed_tags = "<a><b><i><u><em><strong><strike>"
249 ;list of HTML tags which will be allowed in multiline database entries 249 ;list of HTML tags which will be allowed in multiline database entries
250 ;such as description and summary 250 ;such as description and summary
251 251
252 directory_mode = 0777 252 directory_mode = 0777
253 ;the permissions to set on directories 253 ;the permissions to set on directories
254 ;(i.e. galleries) created by the script 254 ;(i.e. galleries) created by the script
255   255  
256 file_mode = 0666 256 file_mode = 0666
257 ;the permissions to set on files (thumbnails, logs, 257 ;the permissions to set on files (thumbnails, logs,
258 ;images & metadata files) created by the script. 258 ;images & metadata files) created by the script.
259 259
260 [GET variable names] 260 [GET variable names]
261 ; 261 ;
262 ; names of variables used to pass information in URLs 262 ; names of variables used to pass information in URLs
263 ; you will only need to change these if there is a conflict with 263 ; you will only need to change these if there is a conflict with
264 ; already existing variables and the installation is being integrated. 264 ; already existing variables and the installation is being integrated.
265 ; 265 ;
266   266  
267 url_gallery = "gallery" 267 url_gallery = "gallery"
268 url_image = "image" 268 url_image = "image"
269 url_startat = "startat" 269 url_startat = "startat"
270 url_action = "action" 270 url_action = "action"
271 url_lang = "lang" 271 url_lang = "lang"
272 url_template = "template" 272 url_template = "template"