]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - config/config-dist.ini
USE_CAPTCHA_RANDOM_WORD by Dan Frankowski
[SourceForge/phpwiki.git] / config / config-dist.ini
1 ; This is the main configuration file for PhpWiki.
2 ; Note that certain characters are used as comment char and therefore 
3 ; these entries must be in double-quotes. Such as ":", ";", "," and "|"
4 ;
5 ; <?php die(); ?> for security
6 ;
7 ; This file is divided into eight parts. 
8 ; Each one has different configuration settings you can
9 ; change; in all cases the default should work on your system,
10 ; however, we recommend you tailor things to your particular setting.
11 ; Here undefined definitions get defined by config-default.ini settings.
12
13 ;=========================================================================
14 ; Part Zero: Latest Development and Tricky Options
15 ;=========================================================================
16
17 ; If PHP needs help in finding where you installed the rest of the PhpWiki
18 ; code, you can set the include_path here.
19 ;
20 ; Override PHP's include path so that it can find some needed additional libraries.
21 ; You shouldn't need to do this unless your system include_path esp. your 
22 ; system pear libs are broken or oudated. The PHPWIKI_DIR is automatically 
23 ; put to the front and the local lib/pear path is automatically added to the end.
24 ; But if you define it, be sure to include either the system pear path or 
25 ; the phpwiki/lib/pear path to override your Pear_DB.
26 ; Note that on Windows-based servers, you should use ; rather than :
27 ; as the path separator.
28 ;INCLUDE_PATH = ".:/usr/local/httpd/phpwiki:/usr/share/pear"
29
30 ; Set DEBUG to 1 to view the XHTML and CSS validator icons, page
31 ; processing timer, and possibly other debugging messages at the
32 ; bottom of each page. 65 for a more verbose level with AUTH hints. 
33 ; See lib/config.php for all supported values.
34 ; Default: 0
35 ;DEBUG = 1
36
37 ; Graphical buttons on edit. Default: true
38 ; Reportedly broken on MacOSX Safari
39 ;ENABLE_EDIT_TOOLBAR = false
40
41 ; Adds two additional buttons in EDIT_TOOLBAR, Search&Replace and Undo
42 ; Undo is experimental.
43 ; Default: true
44 ;JS_SEARCHREPLACE = true
45
46 ; Note: Enable it for all users. Otherwise as per-user setting in UserPreferences.
47 ; Default: false
48 ;ENABLE_DOUBLECLICKEDIT = false
49
50 ; Needed for inlined SVG and MathM, but conflicts with document.write(). 
51 ; Experimental. Default: false. Problematic with MSIE6
52 ; See http://hixie.ch/advocacy/xhtml
53 ;ENABLE_XHTML_XML = true
54
55 ; Needs babycart installed. See http://phpwiki.org/SpamAssassinIntegration
56 ; Optionally define BABYCART_PATH. Default: /usr/local/bin/babycart
57 ;ENABLE_SPAMASSASSIN = true
58
59 ; Check external links on edit against domains blocked by surbl.org and
60 ; bl.spamcop.net
61 ENABLE_SPAMBLOCKLIST = true
62
63 ; If more than this number of external links appear on non-authenticated 
64 ; edits it will be rejected as spam.
65 ;NUM_SPAM_LINKS = 20
66
67 ; If GOOGLE_LINKS_NOFOLLOW is true, ref=nofollow is added to 
68 ; all external links to discourage spam. You might want to turn it off,
69 ; if you want to improve pageranks on external links.
70 ; TODO: Add ref=nofollow only for external links added by anonymous users.
71 ;GOOGLE_LINKS_NOFOLLOW = false
72
73 ; LiveSearch enables immediate title search results via XMLHttpRequest.
74 ; Displays the results in a dropdown under the titlesearch inputbox
75 ; while typing. (experimental, only with certain themes)
76 ; You'll have to copy livesearch.js from http://blog.bitflux.ch/wiki/LiveSearch
77 ; to themes/default/ and define ENABLE_LIVESEARCH in config.ini to true. 
78 ; See themes/blog/themeinfo.php.
79 ; We used the bitflux.ch library temporarily, but we are changing to 
80 ; the better moacdropdown. 
81 ;ENABLE_LIVESEARCH = true
82
83 ; ENABLE_ACDROPDOWN replaces ENABLE_LIVESEARCH
84 ; http://momche.net/publish/article.php?page=acdropdown
85 ;ENABLE_ACDROPDOWN = true
86
87 ; Experimental WikiPedia feature: Force Discussion/Article link at the topnavbar.
88 ;ENABLE_DISCUSSION_LINK = true
89
90 ; If set to true, add some anti-spam countermeasures based on captcha
91 ; tests.  See http://www.captcha.net/ for more information on captcha.
92 ;ENABLE_CAPTCHA = true 
93
94 ; If USE_CAPTCHA_RANDOM_WORD is set to true,
95 ; Captcha will use a random word, otherwise a disctionary word.
96 ;USE_CAPTCHA_RANDOM_WORD = false
97
98 ; USE_SAFE_DBSESSION should be enabled, if you encounter session problems, with 
99 ; duplicate INSERT sess_id warnings at the bottom of the page. Reason is a 
100 ; unreliable affected_rows implementation() in the sql backend. 
101 ; Default is Disabled, using the fastest DbSession UPDATE method.
102 ;USE_SAFE_DBSESSION = false
103
104 ; If true don't use UserName/Blog/day/time pagenames for the ADMIN_USER, but 
105 ; Blog/day/time only. Convenience for a single-user blog theme.
106 ;BLOG_DEFAULT_EMPTY_PREFIX = true
107
108 ;==========================================================================
109 ; Part One: Authentication and security settings.
110 ;
111 ; See Part Three for more.
112 ;==========================================================================
113
114 ; The name of your wiki.
115 ;
116 ; This is used to generate a keywords meta tag in the HTML templates,
117 ; in bookmark titles for any bookmarks made to pages in your wiki,
118 ; and during RSS generation for the <title> of the RSS channel.
119 ;
120 ; To use your own logo and signature files, name them PhpWikiLogo.png
121 ; and PhpWikiSignature.png and put them into themes/default/images
122 ; (substituting "PhpWiki" in the filename with the name you define
123 ; here).
124 ;
125 ; It is recommended this be a relatively short WikiWord like the
126 ; InterWiki monikers found in the InterWikiMap. (For examples, see
127 ; lib/interwiki.map).
128 WIKI_NAME = PhpWiki
129
130 ; Username and password of administrator.
131 ;
132 ; Set these to your preferences. For heaven's sake pick a good
133 ; password and use the passencrypt.php tool to encrypt the password from
134 ; prying eyes.
135 ; http://wolfram.org/writing/howto/password.html
136
137 ; Logging into the wiki with the admin user and password allows you to lock,
138 ; unlock, or remove pages and to perform other PhpWikiAdministration
139 ; functions. On all other occasions you should simply log in with your
140 ; regular WikiName.
141 ; If your password contains special chars like ";" or ":" better quote it in double-quotes.
142 ;ADMIN_USER = 
143
144 ; You must set this! Username and password of the administrator.
145 ; ADMIN_PASSWD is ignored on HttpAuth
146 ;ADMIN_PASSWD =
147
148 ; It is recommended that you use encrypted passwords to be stored in the 
149 ; config.ini and the users homepages metadata.
150 ; You might want to use the passencrypt.php utility to encode the
151 ; admin password, in the event that someone gains ftp or ssh access to the
152 ; server and directory containing phpwiki. 
153 ; <i>SQL access passwords cannot be encrypted, besides using external DATABASE_DSN aliases within PDO.</i>
154
155 ; If true, all user passwords will be stored encrypted.
156 ; You might have to set it to false, if your PHP doesn't support crypt().
157 ; To use plain text passwords, in particular for the ADMIN_PASSWD, set
158 ; ENCRYPTED_PASSWD to false.
159 ENCRYPTED_PASSWD = true
160
161 ; Visitor Hostname Lookup
162 ;
163 ; If set, reverse dns lookups will be performed to attempt to convert
164 ; the user's IP number into a host name, in the case where the http
165 ; server does not do this.
166 ENABLE_REVERSE_DNS = true
167
168 ; Private ZIP Dumps of All Wiki Pages
169 ;
170 ; If true, only the admin user can make zip dumps. Otherwise anyone
171 ; may download all wiki pages as a single zip archive.
172 ZIPDUMP_AUTH = false
173
174 ; The RawHtml plugin allows page authors to embed real, raw HTML into Wiki
175 ; pages.  This is a possible security threat, as much HTML (or, rather,
176 ; JavaScript) can be very risky.  If you are in a controlled environment,
177 ; or you are using the two options below, however, it could be of use. 
178 ENABLE_RAW_HTML = true
179
180 ; If this is set, only pages locked by the Administrator may contain the
181 ; RawHtml plugin
182 ENABLE_RAW_HTML_LOCKEDONLY = true
183
184 ; If this is set, all unsafe html code is stripped automatically (experimental!)
185 ; See http://chxo.com/scripts/safe_html-test.php
186 ENABLE_RAW_HTML_SAFE = true
187
188 ; If you define this to true, (MIME-type) page-dumps (either zip dumps,
189 ; or "dumps to directory" will be encoded using the quoted-printable
190 ; encoding.  If you're actually thinking of mailing the raw page dumps,
191 ; then this might be useful, since (among other things,) it ensures
192 ; that all lines in the message body are under 80 characters in length.
193 ;
194 ; Also, setting this will cause a few additional mail headers
195 ; to be generated, so that the resulting dumps are valid
196 ; RFC 2822 e-mail messages.
197 ;
198 ; Probably you can just leave this set to false, in which case you get
199 ; raw ('binary' content-encoding) page dumps.
200 STRICT_MAILABLE_PAGEDUMPS = false
201
202 ; Here you can change the default dump directories.
203 ; (Can be overridden by the directory argument)
204 DEFAULT_DUMP_DIR = /tmp/wikidump
205 HTML_DUMP_DIR    = /tmp/wikidumphtml
206
207 ; Filename suffix used for XHTML page dumps.
208 ; If you don't want any suffix just comment this out.
209 HTML_DUMP_SUFFIX = .html
210
211 ; The maximum file upload size, in bytes.
212 ; The default, 16777216, is 16MB.
213 MAX_UPLOAD_SIZE = 16777216
214
215 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
216 ; default state for the "minor edit" checkbox on the edit page form
217 ; will be off.
218 ; The default, 604800, is one week (7 days): 7 * 24 * 3600
219 MINOR_EDIT_TIMEOUT = 604800
220
221 ; Actions listed in this array will not be allowed.  The complete list
222 ; of actions can be found in lib/main.php with the function
223 ; getActionDescription. 
224 ;
225 ; browse, create, diff, dumphtml, dumpserial, edit, loadfile, lock, 
226 ; remove, revert, xmlrpc, soap, unlock, upload, viewsource, zip, ziphtml, ...
227 ;DISABLED_ACTIONS = "dumpserial : loadfile"
228
229 ; If you enable this option, every page is moderated by the ModeratedPage
230 ; actionpage plugin. Changing a moderated page will be delayed to be 
231 ; granted by a moderator by email. Default: false to allow finer control.
232 ;ENABLE_MODERATEDPAGE_ALL = true
233
234 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
235 ; for you. If you want one, define this to the name of the log
236 ; file. The server must have write access to the directory specified.
237 ; Preferred is to use SQL access logging as below.
238 ; Note that even you define ACCESS_LOG_SQL logs are written to this file also.
239 ;
240 ; Default: empty - no access log file will be generated.
241 ;ACCESS_LOG = /var/tmp/wiki_access_log
242
243 ; PhpWiki can read and/or write mod_log_sql accesslog tables for faster
244 ; abuse detection and referer lists.
245 ; See http://www.outoforder.cc/projects/apache/mod_log_sql/docs-2.0/#id2756178
246 ;
247 ; If defined (e.g. 1) read-access is done via SQL. 
248 ; If flag 2 is set, phpwiki also writes. Default on SQL database.
249 ; This must use DATABASE_TYPE = SQL or ADODB or PDO.
250 ;   ACCESS_LOG_SQL = 0 ; disable SQL access logging
251 ;   ACCESS_LOG_SQL = 1 ; phpwiki reads, apache mod_log_sql writes
252 ;ACCESS_LOG_SQL = 2 ; read + write
253
254 ; By default PhpWiki will try to have PHP compress its output
255 ; before sending it to the browser, if you have a recent enough
256 ; version of PHP and the browser and action supports it.
257 ;
258 ; Define COMPRESS_OUTPUT to false to prevent output compression.
259 ; Define COMPRESS_OUTPUT to true to force output compression,
260 ; even if we think your version of PHP does this in a buggy
261 ; fashion.
262 ; Leave it undefined to leave the choice up to PhpWiki. (Recommended)
263 ;
264 ; WARNING: Compressing the output has been reported to cause problems
265 ; when PHP is running on MacOSX or on redirected requests.
266 ; This setting should now be correctly determined automatically.
267 ;COMPRESS_OUTPUT = false
268
269 ; This controls how PhpWiki sets the HTTP cache control
270 ; headers (Expires: and Cache-Control:) 
271 ;
272 ; Choose one of:
273 ;
274 ; NO_CACHE: This is roughly the old (pre 1.3.4) behavior.  PhpWiki will
275 ;       instruct proxies and browsers never to cache PhpWiki output.
276 ;       This was previously called 'NONE', but NONE was treated specially 
277 ;       by parse_ini_config().
278 ;
279 ; STRICT: Cached pages will be invalidated whenever the database global
280 ;       timestamp changes.  This should behave just like NO_CACHE (modulo
281 ;       bugs in PhpWiki and your proxies and browsers), except that
282 ;       things will be slightly more efficient.
283 ;
284 ; LOOSE: Cached pages will be invalidated whenever they are edited,
285 ;       or, if the pages include plugins, when the plugin output could
286 ;       concievably have changed.
287 ;
288 ;       Behavior should be much like STRICT, except that sometimes
289 ;       wikilinks will show up as undefined (with the question mark)
290 ;       when in fact they refer to (recently) created pages.
291 ;       (Hitting your browsers reload or perhaps shift-reload button
292 ;       should fix the problem.)
293 ;
294 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
295 ;       (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
296 ;
297 ;       This setting will result in quirky behavior.  When you edit a
298 ;       page your changes may not show up until you shift-reload the
299 ;       page, etc...
300 ;
301 ;       This setting is generally not advisable, however it may be useful
302 ;       in certain cases (e.g. if your wiki gets lots of page views,
303 ;       and few edits by knowledgable people who won't freak over the quirks.)
304 ;
305 ; The recommended default is currently LOOSE.
306 ;
307 CACHE_CONTROL = LOOSE
308
309 ; Maximum page staleness, in seconds.
310 ;
311 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
312 CACHE_CONTROL_MAX_AGE = 600
313
314 ; PhpWiki normally caches a preparsed version (i.e. mostly
315 ; converted to HTML) of the most recent version of each page.
316 ; (Parsing the wiki-markup takes a fair amount of CPU.)
317 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
318 ; caching of marked-up page content.
319 ; Note that you can also disable markup caching on a per-page
320 ; temporary basis by addinging a query arg of '?nocache=1'
321 ; to the URL to the page or by adding a NoCache plugin line. 
322 ; Use '?nocache=purge' to completely discard the cached version of the page.
323 ; You can also purge the cached markup globally by using the
324 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
325 ; Enable only for old php's with low memory or memory_limit=8MB.
326 ; Default: false
327 ;WIKIDB_NOCACHE_MARKUP = true
328
329 COOKIE_EXPIRATION_DAYS = 365
330 ; Default path for the wikiuser cookie. You need to specify this more explicitly
331 ; if you want to enable different users on different wikis on the same host.
332 ;COOKIE_DOMAIN = "/"
333
334 ; The login code now uses PHP's session support. Usually, the default
335 ; configuration of PHP is to store the session state information in
336 ; /tmp. That probably will work fine, but fails e.g. on clustered
337 ; servers where each server has their own distinct /tmp (this is the
338 ; case on SourceForge's project web server.) You can specify an
339 ; alternate directory in which to store state information like so
340 ; (whatever user your httpd runs as must have read/write permission
341 ; in this directory)
342 ;
343 ; On USE_DB_SESSION = true you can ignore this.
344 ;SESSION_SAVE_PATH = some_other_directory
345
346 ; On USE_DB_SESSION = true or false you can force the behaviour 
347 ; how to transport session data.
348 ;USE_DB_SESSION = false 
349
350 ;======================================================================
351 ; Part Two: Database Selection
352 ;======================================================================
353
354 ; Select the database backend type:
355 ;
356 ;       SQL:   access one of several SQL databases using the PEAR DB library.
357 ;       ADODB: uses the ADODB library for data access.     (most general)
358 ;       PDO:   The new PHP5 dataobkject library. (experimental, no paging yet)
359 ;       dba:   use one of the standard UNIX dbm libraries. Use BerkeleyDB (db3,4) (fastest)
360 ;       file:  use a flat file database. (easiest)
361 ;       cvs:   use a CVS server to store everything. (experimental, not recommended)
362 DATABASE_TYPE = dba
363    
364 ; Prefix for filenames or table names
365 ;
366 ; Currently you MUST EDIT THE SQL file too (in the schemas/
367 ; directory because we aren't doing on the fly sql generation
368 ; during the installation.
369 ; Note: This prefix is NOT prepended to the default DBAUTH_
370 ;       tables user, pref and member!
371 ;DATABASE_PREFIX = phpwiki_
372
373 ; For SQL based backends, specify the database as a DSN (Data Source Name),
374 ; a kind of URL for databases.
375 ;
376 ; The most general form of a DSN looks like:
377 ;
378 ;       dbtype(dbsyntax)://username:password@protocol+hostspec/database?option=value&option2=value2
379 ;
380 ; For a MySQL database, the following should work:
381 ;
382 ;       mysql://user:password@host/databasename
383 ;
384 ; To connect over a unix socket, use something like
385 ;
386 ;       mysql://user:password@unix(/path/to/socket)/databasename
387 ;
388 ; Valid values for dbtype are mysql, pgsql, or sqlite.
389 ;
390 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
391
392 ; Keep persistent connections: (mysql_pconnect, ...)
393 ; Recommended is false for bigger servers, and true for small servers 
394 ; with not so many connections. postgresql: Please leave it false. Default: false
395 ; Should really be set as database option in the DSN above.
396 DATABASE_PERSISTENT = false
397
398 ; A table to store session information.  Only needed by SQL backends.
399 ;
400 ; A word of warning - any prefix defined above will be prepended to whatever
401 ; is given here.
402 DATABASE_SESSION_TABLE = session
403
404 ; For the file and dba backends, this specifies where the data files will be
405 ; located.  Ensure that the user that the webserver runs as has write access
406 ; to this directory.
407 ;
408 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
409 ; you'll lose your wiki data at some stage.
410 DATABASE_DIRECTORY = /tmp
411
412 ; For the dba backend, this defines which DBA variant you wish to use.
413 ;       gdbm - commonly available, Fedora not. Not recommended anymore.
414 ;       db2 - Berkeley DB v2; not supported by modern versions of PHP.
415 ;       db3 - Berkeley DB v3; as per db2. The best on Windows.
416 ;       db4 - Berkeley DB v4; current version, however PHP has some issues
417 ;               with it's db4 support.
418 ;       dbm - Older dba handler; suffers from limits on the size of data
419 ;               items.
420 ; Better not use other hacks such as inifile, flatfile or cdb.
421 DATABASE_DBA_HANDLER = gdbm
422
423 ; How long will the system wait for a database operation to complete?
424 ; Specified in seconds.
425 DATABASE_TIMEOUT = 5
426
427 ; If action=upgrade detects mysql problems, but has no ALTER permissions, 
428 ; give here a database username which has the necessary ALTER or CREATE permissions.
429 ; Of course you can fix your database manually. See lib/upgrade.php for known issues.
430 ;DBADMIN_USER = root
431 ;DBADMIN_PASSWD = secret
432
433 ; Store DB query results in memory to avoid duplicate queries.
434 ; Disable only for old php's with low memory or memory_limit=8MB.
435 ; Default: true
436 ;USECACHE = false
437
438 ;========================================================================
439 ; Section 3a: Page revisions
440 ;
441 ; The next section controls how many old revisions of each page are
442 ; kept in the database.
443 ;========================================================================
444
445 ; There are two basic classes of revisions: major and minor. Which
446 ; class a revision belongs in is determined by whether the author
447 ; checked the "this is a minor revision" checkbox when they saved the
448 ; page.
449
450 ; There is, additionally, a third class of revisions: author
451 ; revisions. The most recent non-mergable revision from each distinct
452 ; author is an author revision.
453 ;
454 ; The expiry parameters for each of those three classes of revisions
455 ; can be adjusted seperately. For each class there are five
456 ; parameters (usually, only two or three of the five are actually
457 ; set) which control how long those revisions are kept in the
458 ; database.
459 ;
460 ;   MAX_KEEP: If set, this specifies an absolute maximum for the
461 ;             number of archived revisions of that class. This is
462 ;             meant to be used as a safety cap when a non-zero
463 ;             min_age is specified. It should be set relatively high,
464 ;             and it's purpose is to prevent malicious or accidental
465 ;             database overflow due to someone causing an
466 ;             unreasonable number of edits in a short period of time.
467 ;
468 ;   MIN_AGE:  Revisions younger than this (based upon the supplanted
469 ;             date) will be kept unless max_keep is exceeded. The age
470 ;             should be specified in days. It should be a
471 ;             non-negative, real number,
472 ;
473 ;   MIN_KEEP: At least this many revisions will be kept.
474 ;
475 ;   KEEP: No more than this many revisions will be kept.
476 ;
477 ;   MAX_AGE:  No revision older than this age will be kept.
478 ;
479 ; Definitions of terms used above:
480 ;
481 ; Supplanted date: Revisions are timestamped at the instant that they
482 ; cease being the current revision. Revision age is computed using
483 ; this timestamp, not the edit time of the page.
484 ;
485 ; Merging: When a minor revision is deleted, if the preceding
486 ; revision is by the same author, the minor revision is merged with
487 ; the preceding revision before it is deleted. Essentially: this
488 ; replaces the content (and supplanted timestamp) of the previous
489 ; revision with the content after the merged minor edit, the rest of
490 ; the page metadata for the preceding version (summary, mtime, ...)
491 ; is not changed.
492 ;
493 ; Let all revisions be stored. Default since 1.3.11
494 ;MAJOR_MIN_KEEP = 2147483647
495 ;MINOR_MIN_KEEP = 2147483647
496
497 ; Keep up to 8 major edits, but keep them no longer than a month.
498 MAJOR_MAX_AGE = 32
499 MAJOR_KEEP = 8
500
501 ; Keep up to 4 minor edits, but keep them no longer than a week.
502 MINOR_MAX_AGE = 7
503 MINOR_KEEP = 4
504
505 ; Keep the latest contributions of the last 8 authors up to a year.
506 ; Additionally, (in the case of a particularly active page) try to
507 ; keep the latest contributions of all authors in the last week (even
508 ; if there are more than eight of them,) but in no case keep more
509 ; than twenty unique author revisions.
510 AUTHOR_MAX_AGE = 365
511 AUTHOR_KEEP = 8
512 AUTHOR_MIN_AGE = 7
513 AUTHOR_MAX_KEEP = 20
514
515 ;========================================================================
516 ; Part Three: User Authentication
517 ;========================================================================
518 ;
519 ; New user authentication configuration:
520 ; We support three basic authentication methods and a stacked array 
521 ; of advanced auth methods to get and check the passwords:
522 ;
523 ; ALLOW_ANON_USER         default true
524 ; ALLOW_ANON_EDIT         default true
525 ; ALLOW_BOGO_LOGIN        default true
526 ; ALLOW_USER_PASSWORDS    default true
527
528 ; allow anon users to view or edit any existing pages
529 ALLOW_ANON_USER = true
530 ; allow anon users to edit pages
531 ALLOW_ANON_EDIT = true
532
533 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
534 ; any/no password) using any userid which: 
535 ;  1) is not the ADMIN_USER, and
536 ;  2) is a valid WikiWord (matches $WikiNameRegexp.)
537 ; If true, users may be created by themselves. Otherwise we need seperate auth. 
538 ; If such a user will create a so called HomePage with his userid, he will 
539 ; be able to store his preferences and password there.
540 ALLOW_BOGO_LOGIN = true
541
542 ; True User Authentication:
543 ; To require user passwords:
544 ;   ALLOW_ANON_USER = false
545 ;   ALLOW_ANON_EDIT = false
546 ;   ALLOW_BOGO_LOGIN = false,
547 ;   ALLOW_USER_PASSWORDS = true.
548 ; Otherwise any anon or bogo user might login without any or a wrong password.
549 ALLOW_USER_PASSWORDS = true
550
551 ; Many different methods can be used to check user's passwords:
552 ;   BogoLogin:     WikiWord username, with no *actual* password checking,
553 ;                   although the user will still have to enter one.
554 ;   PersonalPage:  Store passwords in the users homepage metadata (simple)
555 ;   Db:            Use DBAUTH_AUTH_* (see below) with PearDB or 
556 ;                   ADODB only.
557 ;   LDAP:          Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN (experimental)
558 ;   IMAP:          Authenticate against IMAP_AUTH_HOST (email account)
559 ;   POP3:          Authenticate against POP3_AUTH_HOST (email account)
560 ;   Session:       Get username and level from a PHP session variable. (e.g. for gforge)
561 ;   File:          Store username:crypted-passwords in .htaccess like files. 
562 ;                  Use Apache's htpasswd to manage this file.
563 ;   HttpAuth:      Use the protection by the webserver (.htaccess/.htpasswd)
564 ;                  Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also.
565 ;                  Using HttpAuth disables all other methods and no userauth sessions are used.
566 ;
567 ; Several of these methods can be used together, in the manner specified by
568 ; USER_AUTH_POLICY, below.  To specify multiple authentication methods,
569 ; separate the name of each one with colons.
570 ; USER_AUTH_ORDER = "BogoLogin : PersonalPage"
571 ;USER_AUTH_ORDER = "PersonalPage : Db"
572
573 ; For "security" purposes, you can specify that a password be at least a
574 ; certain number of characters long.  This applies even to the BogoLogin
575 ; method. Default: 0 (to allow immediate passwordless BogoLogin)
576 ;PASSWORD_LENGTH_MINIMUM = 6
577     
578 ; The following policies are available for user authentication:
579 ;       first-only: use only the first method in USER_AUTH_ORDER
580 ;       old:        ignore USER_AUTH_ORDER and try to use all available 
581 ;                       methods as in the previous PhpWiki releases (slow)
582 ;       strict:     check if the user exists for all methods: 
583 ;                       on the first existing user, try the password. 
584 ;                       dont try the other methods on failure then
585 ;       stacked:    check the given user - password combination for all
586 ;                       methods and return true on the first success.
587 USER_AUTH_POLICY = stacked
588
589 ; LDAP authentication options:
590 ;
591 ; The LDAP server to connect to.  Can either be a hostname, or a complete
592 ; URL to the server (useful if you want to use ldaps or specify a different
593 ; port number).
594 ;LDAP_AUTH_HOST = "ldap://localhost:389"
595
596 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
597 ;
598 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
599 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
600 ;LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
601
602 ; Some LDAP servers need some more options, such as the Windows Active
603 ; Directory Server.  Specify the options (as allowed by the PHP LDAP module)
604 ; and their values as NAME=value pairs separated by colons.
605 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
606
607 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't 
608 ; allow anonymous queries. (Windows Active Directory Server)
609 ; LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com"
610
611 ; Password to use to initially bind to the LDAP server, as the DN 
612 ; specified in the LDAP_AUTH_USER option (above).
613 ; LDAP_AUTH_PASSWORD = secret
614
615 ; If you want to match usernames against an attribute other than uid,
616 ; specify it here. Default: uid
617 ; LDAP_SEARCH_FIELD = sAMAccountName
618
619 ; If you have an organizational unit for all users, define it here.
620 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
621 ; Default: ou=Users
622 ; LDAP_OU_USERS = ou=Users
623
624 ; If you have an organizational unit for all groups, define it here.
625 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
626 ; The entries in this ou must have a gidNumber and cn attribute.
627 ; Default: ou=Groups
628 ; LDAP_OU_GROUP = ou=Groups
629
630
631 ; IMAP authentication options:
632 ;
633 ; The IMAP server to check usernames from.  Defaults to localhost.
634 ;
635 ; Some IMAP_AUTH_HOST samples:
636 ;   "localhost", "localhost:143/imap/notls", 
637 ;   "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
638 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
639
640 ; POP3 authentication options:
641 ;
642 ; Host to connect to.
643 ; POP3_AUTH_HOST = "localhost:110"
644
645 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
646 ; POP3_AUTH_PORT = 110
647
648 ; File authentication options:
649 ;
650 ; File to read for authentication information.
651 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
652 ; AUTH_USER_FILE = /etc/shadow
653
654 ; Defines whether the user is able to change their own password via PHPWiki.
655 ; Note that this means that the webserver user must be able to write to the
656 ; file specified in AUTH_USER_FILE.
657 ; AUTH_USER_FILE_STORABLE = false
658
659 ; Session Auth:
660 ; Name of the session variable which holds the already authenticated username.
661 ; Sample: "userid", "user[username]", "user->username"
662 ; AUTH_SESS_USER = userid
663 ; Which level will the user be? 1 = Bogo or 2 = Pass
664 ; AUTH_SESS_LEVEL = 2
665
666 ; Group membership.  PhpWiki supports defining permissions for a group as
667 ; well as for individual users.  This defines how group membership information
668 ; is obtained.  Supported values are:
669 ;
670 ;       "NONE"          Disable group membership (Fastest). Note the required quoting.
671 ;       WIKIPAGE        Define groups as list at "CategoryGroup". (Slowest, but easiest to maintain)
672 ;       DB              Stored in an SQL database. Optionally external. See USERS/GROUPS queries
673 ;       FILE            Flatfile. See AUTH_GROUP_FILE below.
674 ;       LDAP            LDAP groups. See "LDAP authentication options" above and 
675 ;                       lib/WikiGroup.php. (experimental)
676 GROUP_METHOD = WIKIPAGE
677
678 ; Page where all groups are listed. Default: Translation of "CategoryGroup"
679 ; CATEGORY_GROUP_PAGE = CategoryGroup
680
681 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
682 ; group membership information.  It should be in the same format as the
683 ; standard unix /etc/groups(5) file.
684 ; AUTH_GROUP_FILE = /etc/groups
685
686 ; External database authentication and authorization.
687 ;
688 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
689 ; below define the SQL queries used to obtain the information out of the
690 ; database, and (in some cases) store the information back to the DB.
691 ;
692 ; The options appropriate for each query are currently undocumented, and
693 ; you should not be surprised if things change mightily in the future.
694 ;
695 ; A database DSN to connect to.  Defaults to the DSN specified for the Wiki
696 ; as a whole.
697 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
698
699 ; USER/PASSWORD queries
700 ;
701 ; For USER_AUTH_POLICY=strict and the Db method this is required:
702 ;DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
703
704 ; Check to see if the supplied username/password pair is OK
705 ;
706 ; Plaintext Passwords:
707 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM pref WHERE userid='$userid'"
708 ;
709 ; Database-hashed passwords (more secure):
710 ;DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM pref WHERE userid='$userid'"
711 DBAUTH_AUTH_CRYPT_METHOD = plain
712
713 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
714 ; to get the password out of the database with a simple SELECT query, and
715 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
716 ;DBAUTH_AUTH_CHECK = "SELECT passwd FROM pref where userid='$userid'"
717 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
718
719 ; Update the user's authentication credential.  If this is not defined but
720 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
721 ; password.
722 ;
723 ; Database-hashed passwords:
724 ; DBAUTH_AUTH_UPDATE = "UPDATE pref SET passwd=PASSWORD('$password') WHERE userid='$userid'"
725 ; Plaintext passwords:
726 ;DBAUTH_AUTH_UPDATE = "UPDATE pref SET passwd='$password' WHERE userid='$userid'"
727
728 ; Allow users to create their own account.
729 ; with CRYPT_METHOD=crypt e.g:
730 ; DBAUTH_AUTH_CREATE = "INSERT INTO pref (passwd,userid) VALUES ('$password','$userid')"
731 ; with CRYPT_METHOD=plain:
732 ;DBAUTH_AUTH_CREATE = "INSERT INTO pref (passwd,userid) VALUES (PASSWORD('$password'),'$userid')"
733
734 ; USER/PREFERENCE queries
735 ;
736 ; If you choose to store your preferences in an external database, enable
737 ; the following queries.  Note that if you choose to store user preferences
738 ; in the 'user' table, only registered users get their prefs from the database,
739 ; self-created users do not.  Better to use the special 'pref' table.
740 ;
741 ; The prefs field stores the serialized form of the user's preferences array,
742 ; to ease the complication of storage.
743 ;DBAUTH_PREF_SELECT = "SELECT prefs FROM pref WHERE userid='$userid'"
744
745 ; Update the user's preferences
746 ;DBAUTH_PREF_UPDATE = "UPDATE pref SET prefs='$pref_blob' WHERE userid='$userid'"
747 ;DBAUTH_PREF_INSERT = "INSERT INTO pref (userid,prefs) VALUES ('$userid','$pref_blob')"
748
749 ; USERS/GROUPS queries
750 ;
751 ; You can define 1:n or n:m user<=>group relations, as you wish.
752 ;
753 ; Sample configurations:
754 ;  Only one group per user - 1:n: (Default)
755 ;   DBAUTH_IS_MEMBER     = "SELECT userid FROM pref WHERE userid='$userid' AND groupname='$groupname'"
756 ;   DBAUTH_GROUP_MEMBERS = "SELECT userid FROM pref WHERE groupname='$groupname'"
757 ;   DBAUTH_USER_GROUPS   = "SELECT groupname FROM pref WHERE userid='$userid'"
758 ;  Multiple groups per user - n:m:
759 ;   DBAUTH_IS_MEMBER     = "SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'"
760 ;   DBAUTH_GROUP_MEMBERS = "SELECT DISTINCT userid FROM member WHERE groupname='$groupname'"
761 ;   DBAUTH_USER_GROUPS   = "SELECT groupname FROM member WHERE userid='$userid'"
762
763 ; A interim page which gets displayed on every edit attempt, if it exists.
764 ;EDITING_POLICY = EditingPolicy
765
766 ; Enable the new extended method of handling WikiUsers to support external auth and PAGEPERM.
767 ; Servers with memory-limit problems might want to turn it off. It costs ~300KB
768 ; Default: true
769 ;ENABLE_USER_NEW = false
770
771 ; Use access control lists (as in Solaris and Windows NTFS) per page and group, 
772 ; not per user for the whole wiki.
773
774 ; We suspect ACL page permissions to degrade speed by 10%. 
775 ; GROUP_METHOD=WIKIPAGE is slowest.
776 ; Default: true
777 ;ENABLE_PAGEPERM = false
778
779 ;========================================================================
780 ; Part Four: Page appearance and layout
781 ;========================================================================
782
783 ; THEMES
784 ;
785 ; Most of the page appearance is controlled by files in the theme
786 ; subdirectory.
787 ;
788 ; There are a number of pre-defined themes shipped with PhpWiki.
789 ; Or you may create your own (e.g. by copying and then modifying one of
790 ; stock themes.)
791 ;
792 ; The complete list of installed themes can be found by doing 'ls themes/'
793 ; from the root of your PHPWiki installation.
794 ; white on yellow with fat blue links:
795 THEME = default
796 ; almost fully iconized classic grey MacOSX design:
797 ;THEME = MacOSX
798 ; as default, just some tricks to make the buttons smaller:
799 ;THEME = smaller
800 ; the popular Wordpress layout:
801 ;THEME = Wordpress
802 ; pure old-style c2wiki layout:
803 ;THEME = Portland
804 ; example with some sidebar boxes:
805 ;THEME = Sidebar
806 ; mozilla friendly, with lots of icons instead of buttons (i18n friendly):
807 ;THEME = Crao
808 ; wikipedia layout:
809 ;THEME = MonoBook
810 ; default + rateit navbar:
811 ;THEME = wikilens
812 ; blogger style, rounded (experimental):
813 ;THEME = blog
814 ; minimalistic:
815 ;THEME = shamino_com
816 ; heavy space-y layout:
817 ;THEME = SpaceWiki
818 ; random heavy images:
819 ;THEME = Hawaiian
820
821 ; Select a valid charset name to be inserted into the xml/html pages,
822 ; and to reference links to the stylesheets (css). For more info see:
823 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
824 ; has been extensively tested only with the latin1 (iso-8859-1)
825 ; character set.
826 ;
827 ; If you change the default from iso-8859-1 PhpWiki may not work
828 ; properly and will require modifications in all existing pages. 
829 ; At the very least you will have to convert the files in pgsrc 
830 ; or locale/xx/pgsrc to match!
831 ; Currently we support utf-8 for zh and ja, euc-jp for ja (not enabled)
832 ; and iso-8859-1 for all other langs. Changing languages (UserPreferences) 
833 ; from one charset to another will not work!
834 ;
835 ; Character sets similar to iso-8859-1 may work with little or no
836 ; modification depending on your setup. The database must also
837 ; support the same charset, and of course the same is true for the
838 ; web browser. (Some work is in progress hopefully to allow more
839 ; flexibility in this area in the future).
840 CHARSET = iso-8859-1
841
842 ; Select your language/locale - Default language is "" for auto-detection.
843 ; Available languages:
844 ; English  "en" (English    - HomePage)
845 ; Dutch    "nl" (Nederlands - ThuisPagina)
846 ; Spanish  "es" (Español    - PáginaPrincipal)
847 ; French   "fr" (Français   - PageAccueil))
848 ; German   "de" (Deutsch    - StartSeite)
849 ; Swedish  "sv" (Svenska    - Framsida)
850 ; Italian  "it" (Italiano   - PaginaPrincipale)
851 ; Japanese "ja" (Japanese   - Â¥Ã›Â¡Â¼Â¥Ã Â¥ÃšÂ¡Â¼Â¥Â¸)
852 ; Chinese  "zh" (Chinese    - ?)
853 ;
854 ; If you set DEFAULT_LANGUAGE to the empty string, the users 
855 ; preferred language as determined by the browser setting will be used.
856 ; Japanese requires CHARSET=euc-jp or utf-8 (not yet safe), Chinese CHARSET=utf-8
857 ;DEFAULT_LANGUAGE = en
858
859 ; WIKI_PGSRC -- specifies the source for the initial page contents of
860 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
861 ; accessed for the first time (or after clearing the database.)
862 ; WIKI_PGSRC can either name a directory or a zip file. In either case
863 ; WIKI_PGSRC is scanned for files -- one file per page.
864 ;WIKI_PGSRC = pgsrc
865
866 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
867 ; default (English) and when reading from a directory: in that case
868 ; some English pages are inserted into the wiki as well.
869 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
870 ;DEFAULT_WIKI_PGSRC = pgsrc
871 ; These are ':'-seperated pages which will get loaded untranslated from DEFAULT_WIKI_PGSRC.
872 ;DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
873
874 ;=========================================================================
875 ; Part Five: Mark-up options.
876 ;=========================================================================
877 ;
878 ; Allowed protocols for links - be careful not to allow "javascript:"
879 ; URL of these types will be automatically linked.
880 ; within a named link [name|uri] one more protocol is defined: phpwiki
881 ; Separate each of the protocol names with a vertical pipe, and ensure there
882 ; is no extraneous whitespace.
883 ;ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
884
885 ; URLs ending with the following extension should be inlined as images.
886 ; Specify as per ALLOWED_PROTOCOLS.
887 ; Note that you can now also allow class|svg|svgz|vrml|swf ...,
888 ; which will create embedded <object> instead of <img>. 
889 ; Typical CGI extensions as pl or cgi maybe allowed too, but those two will be enforced to <img>
890 ;INLINE_IMAGES = "png|jpg|gif"
891
892 ; Perl regexp for WikiNames ("bumpy words")
893 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
894 ;WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
895
896 ; Defaults to '/', but '.' was also used.
897 ;SUBPAGE_SEPARATOR = /
898
899 ; InterWiki linking -- wiki-style links to other wikis on the web
900 ;
901 ; The map will be taken from a page name InterWikiMap.
902 ; If that page is not found (or is not locked), or map
903 ; data can not be found in it, then the file specified
904 ; by INTERWIKI_MAP_FILE (if any) will be used.
905 ;INTERWIKI_MAP_FILE = lib/interwiki.map
906
907 ; Display a warning if the internal lib/interwiki.map is used, and 
908 ; not the public InterWikiMap page. This file is not readable from outside.
909 ;WARN_NONPUBLIC_INTERWIKIMAP = false
910
911 ; Search term used for automatic page classification by keyword extraction.
912 ;
913 ; Any links on a page to pages whose names match this search 
914 ; will be used keywords in the keywords html meta tag. This is an aid to
915 ; classification by search engines. The value of the match is
916 ; used as the keyword.
917 ;
918 ; The default behavior is to match Category* or Topic* links.
919 ;KEYWORDS = "Category* OR Topic*"
920
921 ; Author and Copyright Site Navigation Links
922 ;
923 ; These will be inserted as <link rel> tags in the html header of
924 ; every page, for search engines and for browsers like Mozilla which
925 ; take advantage of link rel site navigation.
926 ;
927 ; If you have your own copyright and contact information pages change
928 ; these as appropriate.
929 ;COPYRIGHTPAGE_TITLE = "GNU General Public License"
930 ;COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/gpl.html#SEC1"
931 ; Other useful alternatives to consider:
932 ; COPYRIGHTPAGE_TITLE = "GNU Free Documentation License"
933 ; COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/fdl.html"
934 ; COPYRIGHTPAGE_TITLE = "Creative Commons License 2.0"
935 ; COPYRIGHTPAGE_URL = "http://creativecommons.org/licenses/by/2.0/"
936 ;  see http://creativecommons.org/learn/licenses/ for variations
937 ;AUTHORPAGE_TITLE = The PhpWiki Programming Team
938 ;AUTHORPAGE_URL = http://phpwiki.org/ThePhpWikiProgrammingTeam
939
940 ; Allow full markup in headers to be parsed by the CreateToc plugin.
941 ;
942 ; If false you may not use WikiWords or [] links or any other markup in 
943 ; headers in pages with the CreateToc plugin. But if false the parsing is 
944 ; faster and more stable.
945 ;TOC_FULL_SYNTAX = true
946
947 ; If false the %color=... %% syntax will be disabled. Since 1.3.11
948 ; Default: true
949 ;ENABLE_MARKUP_COLOR = false
950
951 ; Enable mediawiki-style {{TemplatePage|vars=value|...}} syntax. Since 1.3.11
952 ; Default: undefined. Enabled automatically on the MonoBook theme if undefined.
953 ;ENABLE_MARKUP_TEMPLATE = true
954
955 ;==========================================================================
956 ; Part Six: URL options.
957 ;==========================================================================
958 ;
959 ; You can probably skip this section.
960
961 ; The following section contains settings which you can use to tailor
962 ; the URLs which PhpWiki generates.
963 ;
964 ; Any of these parameters which are left undefined will be deduced
965 ; automatically. You need only set them explicitly if the
966 ; auto-detected values prove to be incorrect.
967 ;
968 ; In most cases the auto-detected values should work fine, so
969 ; hopefully you don't need to mess with this section.
970 ;
971 ; In case of local overrides of short placeholders, which themselves 
972 ; include index.php, we check for most constants. See '/wiki'.
973 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki 
974 ; versions (for development), but most likely other values like 
975 ; THEME, LANG and DbParams for a WikiFarm.
976
977 ; Canonical name and httpd port of the server on which this PhpWiki
978 ; resides.
979 ;/
980 ;SERVER_NAME = some.host.com
981 ;SERVER_PORT = 80
982
983 ; Relative URL (from the server root) of the PhpWiki
984 ; script.
985 ;SCRIPT_NAME = /some/where/index.php
986
987 ; URL of the PhpWiki install directory.  (You only need to set this
988 ; if you've moved index.php out of the install directory.)  This can
989 ; be either a relative URL (from the directory where the top-level
990 ; PhpWiki script is) or an absolute one.
991 ;DATA_PATH = /home/user/phpwiki
992
993 ; Path to the PhpWiki install directory.  This is the local
994 ; filesystem counterpart to DATA_PATH.  (If you have to set
995 ; DATA_PATH, your probably have to set this as well.)  This can be
996 ; either an absolute path, or a relative path interpreted from the
997 ; directory where the top-level PhpWiki script (normally index.php)
998 ; resides.
999 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
1000
1001 ; PhpWiki will try to use short urls to pages, eg 
1002 ; http://www.example.com/index.php/HomePage
1003 ; If you want to use urls like 
1004 ; http://www.example.com/index.php?pagename=HomePage
1005 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
1006 ; NB:  If you are using Apache >= 2.0.30, then you may need to to use
1007 ; the directive "AcceptPathInfo On" in your Apache configuration file
1008 ; (or in an appropriate <.htaccess> file) for the short urls to work:  
1009 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
1010
1011 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
1012 ; on prettifying your urls.
1013 ;
1014 ; Note that Google doesn't follow the default /index.php/PageName links.
1015 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
1016 ;
1017 ; Default: PhpWiki will try to divine whether use of PATH_INFO
1018 ; is supported in by your webserver/PHP configuration, and will
1019 ; use PATH_INFO if it thinks that is possible.
1020 ;USE_PATH_INFO = false
1021
1022 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
1023 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
1024 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
1025 ; something different.
1026 ;
1027 ; If you do this, you should set VIRTUAL_PATH here.
1028 ;
1029 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
1030 ; but  * you've made it accessible through eg. /wiki/HomePage.
1031 ;
1032 ; One way to do this is to create a directory named 'wiki' in your
1033 ; server root. The directory contains only one file: an .htaccess
1034 ; file which reads something like:
1035 ;
1036 ;    Action x-phpwiki-page /scripts/phpwiki/index.php
1037 ;    SetHandler x-phpwiki-page
1038 ;    DirectoryIndex /scripts/phpwiki/index.php
1039 ;
1040 ; In that case you should set VIRTUAL_PATH to '/wiki'.
1041 ;
1042 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
1043 ;/
1044 ;VIRTUAL_PATH = /SomeWiki
1045
1046 ; In case your system has no idea about /tmp, TEMP or TMPDIR, 
1047 ; better provide it here. E.g. needed for zipdumps.
1048 ;TEMP_DIR = /tmp
1049
1050 ;===========================================================================
1051 ; Part Seven: Miscellaneous settings
1052 ;===========================================================================
1053
1054 ; Disable HTTP redirects.
1055 ; (You probably don't need to touch this.)
1056 ;
1057 ; PhpWiki uses HTTP redirects for some of it's functionality.
1058 ; (e.g. after saving changes, PhpWiki redirects your browser to
1059 ; view the page you just saved.)
1060 ; Some web service providers (notably free European Lycos) don't seem to
1061 ; allow these redirects.  (On Lycos the result in an "Internal Server Error"
1062 ; report.)  In that case you can set DISABLE_HTTP_REDIRECT to true.
1063 ; (In which case, PhpWiki will revert to sneakier tricks to try to
1064 ; redirect the browser...)
1065 ;DISABLE_HTTP_REDIRECT = true
1066
1067 ; Enable random quotes from a fortune directory when adding a new page.
1068 ; Usually at /usr/share/fortune or /usr/share/games/fortune
1069 ; If empty no quotes are inserted.
1070 ;FORTUNE_DIR = /usr/share/fortune
1071
1072 ; If you get a crash at loading LinkIcons you might want to disable 
1073 ; the getimagesize() function, which crashes on certain php versions and 
1074 ; and some external images (png's, ..). 
1075 ; getimagesize() is only needed for spam prevention.
1076 ;DISABLE_GETIMAGESIZE = true
1077
1078 ; Optional: administrative SQL DB access (for action=upgrade)
1079 ;DBADMIN_USER = 
1080 ;DBADMIN_PASSWD = 
1081
1082 ; Add additional EDIT_TOOLBAR buttons if defined:
1083 ; Insert a pagelink from this list:
1084 ;TOOLBAR_PAGELINK_PULLDOWN = *
1085 ; Insert a template from this list:
1086 ;TOOLBAR_TEMPLATE_PULLDOWN = Template*
1087
1088 ;===========================================================================
1089 ; Optional Plugin Settings and external executables
1090 ;===========================================================================
1091
1092 ; GoogleMaps and GooglePlugin
1093 ; For using the Google API and GoogleMaps
1094 ; http://www.google.com/apis/maps/signup.html
1095 ;GOOGLE_LICENSE_KEY = "..."
1096
1097 ; On action=pdf: If enabled don't use the internal fpdf library.
1098 ; External PDF executable, %s is the xhtml filename
1099
1100 ;USE_EXTERNAL_HTML2PDF = "htmldoc --quiet --format pdf14 --no-toc --no-title %s"
1101
1102 ; Optional: SPAMASSASSIN wrapper. Only used if ENABLE_SPAMASSASSIN = true
1103 ; http://www.cynistar.net/~apthorpe/code/babycart/babycart.html
1104 BABYCART_PATH = /usr/local/bin/babycart
1105
1106 ; wikilens RateIt widget
1107 ; style of the stars: empty = yellow, red or red
1108 ;RATEIT_IMGPREFIX = 
1109 ;RATEIT_IMGPREFIX = Star
1110 ;RATEIT_IMGPREFIX = BStar
1111
1112 ; GraphViz plugin:
1113 ; http://www.graphviz.org/
1114 ;GRAPHVIZ_EXE = /usr/local/bin/dot
1115
1116 ; VisualWiki Plugin needs graphviz
1117 ;VISUALWIKIFONT = Arial
1118
1119 ; disable user options
1120 ;VISUALWIKI_ALLOWOPTIONS = false
1121
1122 ; PloticusPlugin:
1123 ; http://ploticus.sourceforge.net/doc/welcome.html
1124 ;PLOTICUS_EXE = /usr/local/bin/pl
1125 ;PLOTICUS_PREFABS = /usr/share/ploticus
1126
1127 ; JabberPresence
1128 ; http://edgar.netflint.net/howto.php
1129 ;MY_JABBER_ID = 
1130
1131 ; PhpWeather needs this external php project
1132 ; http://sourceforge.net/projects/phpweather/
1133 ;PHPWEATHER_BASE_DIR = 
1134
1135 ; SyntaxHighlight plugin
1136 ; http://www.andre-simon.de/doku/highlight/highlight.html
1137 ;HIGHLIGHT_EXE = /usr/local/bin/highlight
1138 ;HIGHLIGHT_DATA_DIR = /usr/share/highlight
1139
1140 ;===========================================================================
1141 ; Part Eight: PLUGINCACHED Pear/Cache Settings
1142 ;===========================================================================
1143
1144 ; Cache_Container storage class: 'file' is the fastest. See pear/Cache/Container/
1145 ;PLUGIN_CACHED_DATABASE = file
1146
1147 ; This is only used if database is set to file.
1148 ; The webserver must have write access to this dir!
1149 ;PLUGIN_CACHED_CACHE_DIR = /tmp/cache
1150 ; Every file name in the cache begins with this prefix
1151 ;PLUGIN_CACHED_FILENAME_PREFIX = phpwiki
1152
1153 ; The maximum total space in bytes of all files in the cache. When
1154 ; highwater is exceeded, a garbage collection will start.  It will
1155 ; collect garbage till 'lowwater' is reached.  Default: 4 * Megabyte
1156 ;PLUGIN_CACHED_HIGHWATER = 4194304
1157 ; Default: 3 * Megabyte
1158 ;PLUGIN_CACHED_LOWWATER  = 3145728
1159
1160 ; If an image has not been used for maxlifetime remove it from the
1161 ; cache. (Since there is also the highwater/lowwater mechanism and an
1162 ; image usually requires only 1kb you don't have to make it very
1163 ; small, I think.)  
1164 ; Default: 30 * Day (30 * 24*60*60)
1165 ;PLUGIN_CACHED_MAXLIFETIME = 2592000
1166
1167 ; Number of characters allowed to be send as 
1168 ; parameters in the url before using sessions
1169 ; vars instead. 
1170 ; Usually send plugin arguments as URL, but when they become
1171 ; longer than maxarglen store them in session variables.
1172 ; Setting it to 3000 worked fine for me, 30000 completely
1173 ; crashed my linux, 1000 should be safe.
1174 ;PLUGIN_CACHED_MAXARGLEN = 1000
1175
1176 ; Actually use the cache (should be always true unless you are
1177 ; debugging). If you want to avoid the usage of a cache but need
1178 ; WikiPlugins that nevertheless rely on a cache you might set
1179 ; 'PLUGIN_CACHED_USECACHE' to false. You still need to set
1180 ; 'PLUGIN_CACHED_CACHE_DIR' appropriately to allow image creation and
1181 ; you should set 'PLUGIN_CACHED_FORCE_SYNCMAP' to false.
1182 ;PLUGIN_CACHED_USECACHE = true
1183
1184 ; Will prevent image creation for an image map 'on demand'. It is a
1185 ; good idea to set this to 'true' because it will also prevent the
1186 ; html part not to fit to the image of the map.  If you don't use a
1187 ; cache, you have to set it to 'false', maps will not work otherwise
1188 ; but strange effects may happen if the output of an image map
1189 ; producing WikiPlugin is not completely determined by its parameters.
1190 ; (As it is the case for a graphical site map.)
1191 ;PLUGIN_CACHED_FORCE_SYNCMAP = true
1192
1193 ; If ImageTypes() does not exist (PHP < 4.0.2) allow the
1194 ; following image formats (IMG_PNG | IMG_GIF | IMG_JPG | IMG_WBMP)
1195 ; In principal all image types which are compiled into php: 
1196 ;   libgd, libpng, libjpeg, libungif, libtiff, libgd2, ...
1197 ;PLUGIN_CACHED_IMGTYPES = "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm"