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