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