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