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