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