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