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