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