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