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