baseline
[omp.pkp.sfu.ca.git] / config.TEMPLATE.inc.php
blobac57df5123dc0b8dc9152d0632ebb7338bc7985a
1 ; <?php exit(); // DO NOT DELETE ?>
2 ; DO NOT DELETE THE ABOVE LINE!!!
3 ; Doing so will expose this configuration file through your web site!
4 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
8 ; config.TEMPLATE.inc.php
10 ; Copyright (c) 2003-2008 John Willinsky
11 ; Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
13 ; OMP Configuration settings.
14 ; Rename config.TEMPLATE.inc.php to config.inc.php to use.
16 ; $Id: config.TEMPLATE.inc.php,v 1.3 2009/09/19 00:12:39 asmecher Exp $
18 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
21 ;;;;;;;;;;;;;;;;;;;;
22 ; General Settings ;
23 ;;;;;;;;;;;;;;;;;;;;
25 [general]
27 ; Set this to On once the system has been installed
28 ; (This is generally done automatically by the installer)
29 installed = Off
31 ; The canonical URL to the OMP installation (excluding the trailing slash)
32 base_url = "http://pkp.sfu.ca/omp"
34 ; Path to the registry directory (containing various settings files)
35 ; Although the files in this directory generally do not contain any
36 ; sensitive information, the directory can be moved to a location that
37 ; is not web-accessible if desired
38 registry_dir = registry
40 ; Session cookie name
41 session_cookie_name = OMPSID
43 ; Number of days to save login cookie for if user selects to remember
44 ; (set to 0 to force expiration at end of current session)
45 session_lifetime = 30
47 ; Enable support for running scheduled tasks
48 ; Set this to On if you have set up the scheduled tasks script to
49 ; execute periodically
50 scheduled_tasks = Off
52 ; Short and long date formats
53 date_format_trunc = "%m-%d"
54 date_format_short = "%Y-%m-%d"
55 date_format_long = "%B %e, %Y"
56 datetime_format_short = "%Y-%m-%d %I:%M %p"
57 datetime_format_long = "%B %e, %Y - %I:%M %p"
58 time_format = "%I:%M %p"
60 ; Use URL parameters instead of CGI PATH_INFO. This is useful for
61 ; broken server setups that don't support the PATH_INFO environment
62 ; variable.
63 disable_path_info = Off
65 ; Use fopen(...) for URL-based reads. Modern versions of dspace
66 ; will not accept requests using fopen, as it does not provide a
67 ; User Agent, so this option is disabled by default. If this feature
68 ; is disabled by PHP's configuration, this setting will be ignored.
69 allow_url_fopen = Off
71 ; Base URL override settings: Entries like the following examples can
72 ; be used to override the base URLs used by OMP. If you want to use a
73 ; proxy to rewrite URLs to OMP, configure your proxy's URL here.
74 ; Syntax: base_url[press_path] = http://www.myUrl.com
75 ; To override URLs that aren't part of a particular press, use a
76 ; press_path of "index".
77 ; Examples:
78 ; base_url[index] = http://www.myUrl.com
79 ; base_url[myPress] = http://www.myUrl.com/myPress
80 ; base_url[myOtherPress] = http://myOtherPress.myUrl.com
82 ;;;;;;;;;;;;;;;;;;;;;
83 ; Database Settings ;
84 ;;;;;;;;;;;;;;;;;;;;;
86 [database]
88 driver = mysql
89 host = localhost
90 username = omp
91 password = omp
92 name = omp
94 ; Enable persistent connections (recommended)
95 persistent = On
97 ; Enable database debug output (very verbose!)
98 debug = Off
100 ;;;;;;;;;;;;;;;;;;
101 ; Cache Settings ;
102 ;;;;;;;;;;;;;;;;;;
104 [cache]
106 ; The type of data caching to use. Options are:
107 ; - memcache: Use the memcache server configured below
108 ; - file: Use file-based caching; configured below
109 ; - none: Use no caching. This may be extremely slow.
110 ; This setting affects locale data, press settings, and plugin settings.
112 cache = file
114 ; Enable memcache support
115 memcache_hostname = localhost
116 memcache_port = 11211
118 ; For site visitors who are not logged in, many pages are often entirely
119 ; static (e.g. About, the home page, etc). If the option below is enabled,
120 ; these pages will be cached in local flat files for the number of hours
121 ; specified in the web_cache_hours option. This will cut down on server
122 ; overhead for many requests, but should be used with caution because:
123 ; 1) Things like press metadata changes will not be reflected in cached
124 ; data until the cache expires or is cleared, and
125 ; 2) This caching WILL NOT RESPECT DOMAIN-BASED SUBSCRIPTIONS.
126 ; However, for situations like hosting high-volume open access presses, it's
127 ; an easy way of decreasing server load.
129 web_cache = Off
130 web_cache_hours = 1
133 ;;;;;;;;;;;;;;;;;;;;;;;;;
134 ; Localization Settings ;
135 ;;;;;;;;;;;;;;;;;;;;;;;;;
137 [i18n]
139 ; Default locale
140 locale = en_US
142 ; Client output/input character set
143 client_charset = utf-8
145 ; Database connection character set
146 ; Must be set to "Off" if not supported by the database server
147 ; If enabled, must be the same character set as "client_charset"
148 ; (although the actual name may differ slightly depending on the server)
149 connection_charset = Off
151 ; Database storage character set
152 ; Must be set to "Off" if not supported by the database server
153 database_charset = Off
155 ; Enable character normalization to utf-8 (recommended)
156 ; If disabled, strings will be passed through in their native encoding
157 charset_normalization = On
159 ;;;;;;;;;;;;;;;;;
160 ; File Settings ;
161 ;;;;;;;;;;;;;;;;;
163 [files]
165 ; Complete path to directory to store uploaded files
166 ; (This directory should not be directly web-accessible)
167 ; Windows users should use forward slashes
168 files_dir = files
170 ; Path to the directory to store public uploaded files
171 ; (This directory should be web-accessible and the specified path
172 ; should be relative to the base OMP directory)
173 ; Windows users should use forward slashes
174 public_files_dir = public
176 ; Permissions mask for created files and directories
177 umask = 0022
180 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
181 ; Fileinfo (MIME) Settings ;
182 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
184 [finfo]
185 mime_database_path = /etc/magic.mime
188 ;;;;;;;;;;;;;;;;;;;;;
189 ; Security Settings ;
190 ;;;;;;;;;;;;;;;;;;;;;
192 [security]
194 ; Force SSL connections site-wide
195 force_ssl = Off
197 ; Force SSL connections for login only
198 force_login_ssl = Off
200 ; This check will invalidate a session if the user's IP address changes.
201 ; Enabling this option provides some amount of additional security, but may
202 ; cause problems for users behind a proxy farm (e.g., AOL).
203 session_check_ip = On
205 ; The encryption (hashing) algorithm to use for encrypting user passwords
206 ; Valid values are: md5, sha1
207 ; Note that sha1 requires PHP >= 4.3.0
208 encryption = md5
210 ; Allowed HTML tags for fields that permit restricted HTML.
211 allowed_html = "<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <b> <i> <u> <img> <sup> <sub> <br> <p>"
213 ; Prevent VIM from attempting to highlight the rest of the config file
214 ; with unclosed tags:
215 ; </p></sub></sup></u></i></b></dd></dt></dl></li></ol></ul></code></cite></strong></em></a>
218 ;Is implicit authentication enabled or not
220 ;implicit_auth = On
222 ;Implicit Auth Header Variables
224 ;implicit_auth_header_first_name = HTTP_TDL_GIVENNAME
225 ;implicit_auth_header_last_name = HTTP_TDL_SN
226 ;implicit_auth_header_email = HTTP_TDL_MAIL
227 ;implicit_auth_header_phone = HTTP_TDL_TELEPHONENUMBER
228 ;implicit_auth_header_initials = HTTP_TDL_METADATA_INITIALS
229 ;implicit_auth_header_mailing_address = HTTP_TDL_METADATA_TDLHOMEPOSTALADDRESS
230 ;implicit_auth_header_uin = HTTP_TDL_TDLUID
232 ; A space delimited list of uins to make admin
233 ;implicit_auth_admin_list = "100000040@tdl.org 85B7FA892DAA90F7@utexas.edu 100000012@tdl.org"
235 ; URL of the implicit auth 'Way Finder' page. See pages/login/LoginHandler.inc.php for usage.
237 ;implicit_auth_wayf_url = "/Shibboleth.sso/wayf"
241 ;;;;;;;;;;;;;;;;;;
242 ; Email Settings ;
243 ;;;;;;;;;;;;;;;;;;
245 [email]
247 ; Use SMTP for sending mail instead of mail()
248 ; smtp = On
250 ; SMTP server settings
251 ; smtp_server = mail.example.com
252 ; smtp_port = 25
254 ; Enable SMTP authentication
255 ; Supported mechanisms: PLAIN, LOGIN, CRAM-MD5, and DIGEST-MD5
256 ; smtp_auth = PLAIN
257 ; smtp_username = username
258 ; smtp_password = password
260 ; Allow envelope sender to be specified
261 ; (may not be possible with some server configurations)
262 ; allow_envelope_sender = Off
264 ; Default envelope sender to use if none is specified elsewhere
265 ; default_envelope_sender = my_address@my_host.com
267 ; Enable attachments in the various "Send Email" pages.
268 ; (Disabling here will not disable attachments on features that
269 ; require them, e.g. attachment-based reviews)
270 enable_attachments = On
272 ; Amount of time required between attempts to send non-editorial emails
273 ; in seconds. This can be used to help prevent email relaying via OMP.
274 time_between_emails = 3600
276 ; Maximum number of recipients that can be included in a single email
277 ; (either as To:, Cc:, or Bcc: addresses) for a non-priveleged user
278 max_recipients = 10
280 ; If enabled, email addresses must be validated before login is possible.
281 require_validation = Off
283 ; Maximum number of days before an unvalidated account expires and is deleted
284 validation_timeout = 14
287 ;;;;;;;;;;;;;;;;;;;
288 ; Search Settings ;
289 ;;;;;;;;;;;;;;;;;;;
291 [search]
293 ; Minimum indexed word length
294 min_word_length = 3
296 ; The maximum number of search results fetched per keyword. These results
297 ; are fetched and merged to provide results for searches with several keywords.
298 results_per_keyword = 500
300 ; The number of hours for which keyword search results are cached.
301 result_cache_hours = 1
303 ; Paths to helper programs for indexing non-text files.
304 ; Programs are assumed to output the converted text to stdout, and "%s" is
305 ; replaced by the file argument.
306 ; Note that using full paths to the binaries is recommended.
307 ; Uncomment applicable lines to enable (at most one per file type).
308 ; Additional "index[MIME_TYPE]" lines can be added for any mime type to be
309 ; indexed.
311 ; PDF
312 ; index[application/pdf] = "/usr/bin/pstotext %s"
313 ; index[application/pdf] = "/usr/bin/pdftotext %s -"
315 ; PostScript
316 ; index[application/postscript] = "/usr/bin/pstotext %s"
317 ; index[application/postscript] = "/usr/bin/ps2ascii %s"
319 ; Microsoft Word
320 ; index[application/msword] = "/usr/bin/antiword %s"
321 ; index[application/msword] = "/usr/bin/catdoc %s"
324 ;;;;;;;;;;;;;;;;
325 ; OAI Settings ;
326 ;;;;;;;;;;;;;;;;
328 [oai]
330 ; Enable OAI front-end to the site
331 oai = On
333 ; OAI Repository identifier
334 repository_id = omp.pkp.sfu.ca
337 ;;;;;;;;;;;;;;;;;;;;;;
338 ; Interface Settings ;
339 ;;;;;;;;;;;;;;;;;;;;;;
341 [interface]
343 ; Number of items to display per page; overridable on a per-press basis
344 items_per_page = 25
346 ; Number of page links to display; overridable on a per-press basis
347 page_links = 10
350 ;;;;;;;;;;;;;;;;;;;;
351 ; Captcha Settings ;
352 ;;;;;;;;;;;;;;;;;;;;
354 [captcha]
356 ; Whether or not to enable Captcha features
357 captcha = off
359 ; Whether or not to use Captcha on user registration
360 captcha_on_register = on
362 ; Whether or not to use Captcha on user comments
363 captcha_on_comments = on
365 ; Font location for font to use in Captcha images
366 font_location = /usr/share/fonts/truetype/freefont/FreeSerif.ttf
369 ;;;;;;;;;;;;;;;;;;
370 ; Proxy Settings ;
371 ;;;;;;;;;;;;;;;;;;
373 [proxy]
375 ; Note that allow_url_fopen must be set to Off before these proxy settings
376 ; will take effect.
378 ; The HTTP proxy configuration to use
379 ; http_host = localhost
380 ; http_port = 80
381 ; proxy_username = username
382 ; proxy_password = password
385 ;;;;;;;;;;;;;;;;;;
386 ; Debug Settings ;
387 ;;;;;;;;;;;;;;;;;;
389 [debug]
391 ; Display execution stats in the footer
392 show_stats = Off
394 ; Display a stack trace when a fatal error occurs.
395 ; Note that this may expose private information and should be disabled
396 ; for any production system.
397 show_stacktrace = Off
399 ; Display an error message when something goes wrong.
400 display_errors = Off