1 ; This is the main configuration file for PhpWiki.
2 ; Note that seartain characters are used as comment char and therefore
3 ; these entries must be in double-quotes. Such as ":", ";", "," and "|"
5 ; This file is divided into eight parts.
6 ; Each one has different configuration settings you can
7 ; change; in all cases the default should work on your system,
8 ; however, we recommend you tailor things to your particular setting.
9 ; Here undefined definitions get defined by config-default.ini settings.
11 ;=========================================================================
12 ; Part Zero: Latest Development and Tricky Options
13 ;=========================================================================
15 ; If PHP needs help in finding where you installed the rest of the PhpWiki
16 ; code, you can set the include_path here.
18 ; Override PHP's include path so that it can find some needed additional libraries.
19 ; You shouldn't need to do this unless your system include_path esp. your
20 ; system pear libs are broken or oudated. The PHPWIKI_DIR is automatically
21 ; put to the front and the local lib/pear path is automatically added to the end.
22 ; But if you define it, be sure to include either the system pear path or
23 ; the phpwiki/lib/pear path to override your Pear_DB.
24 ; Note that on Windows-based servers, you should use ; rather than :
25 ; as the path separator.
26 ;INCLUDE_PATH = ".:/usr/local/httpd/phpwiki:/usr/share/pear"
28 ; Set DEBUG to 1 to view the XHTML and CSS validator icons, page
29 ; processing timer, and possibly other debugging messages at the
30 ; bottom of each page. 2 for a more verbose level. See lib/config.php.
34 ; Enable the new method of handling WikiUsers. This is currently an
35 ; experimental feature, although it is considered fairly stable. It's best
36 ; to leave it on, and only disable it if you have problems with it.
37 ; Servers with memory-limit problems might want to turn it off. It costs ~300KB
39 ;ENABLE_USER_NEW = false
41 ; I suspect ACL page permissions to degrade speed by 10%. Default: true
42 ;ENABLE_PAGEPERM = false
44 ; Experimental new edit feature. Default: true
45 ; Reportedly broken on MacOSX Safari, and with application/xhtml+xml
46 ;ENABLE_EDIT_TOOLBAR = false
48 ; Adds two additional buttons in EDIT_TOOLBAR, Search&Replace and Undo
49 ; Currently broken. Default: false
50 ;JS_SEARCHREPLACE = true
53 ;ENABLE_DOUBLECLICKEDIT = false
55 ; Experimental. Conflicts with ENABLE_EDIT_TOOLBAR and Signin Button
56 ; document.write() javascript. Needed for inlined SVG and MathML.
58 ;ENABLE_XHTML_XML = true
60 ; Store DB query results in memory to avoid duplicate queries.
61 ; Disable only for old php's with low memory or memory_limit=8MB.
65 ;ENABLE_SPAMASSASSIN = true
67 ;==========================================================================
68 ; Part One: Authentication and security settings.
70 ; See Part Three for more.
71 ;==========================================================================
73 ; The name of your wiki.
75 ; This is used to generate a keywords meta tag in the HTML templates,
76 ; in bookmark titles for any bookmarks made to pages in your wiki,
77 ; and during RSS generation for the <title> of the RSS channel.
79 ; To use your own logo and signature files, name them PhpWikiLogo.png
80 ; and PhpWikiSignature.png and put them into themes/default/images
81 ; (substituting "PhpWiki" in the filename with the name you define
84 ; It is recommended this be a relatively short WikiWord like the
85 ; InterWiki monikers found in the InterWikiMap. (For examples, see
89 ; Visitor Hostname Lookup
91 ; If set, reverse dns lookups will be performed to attempt to convert
92 ; the user's IP number into a host name, in the case where the http
93 ; server does not do this.
94 ENABLE_REVERSE_DNS = true
96 ; Username and password of administrator.
98 ; Set these to your preferences. For heaven's sake pick a good
99 ; password and use the passencrypt.php tool to encrypt the password from
101 ; http://wolfram.org/writing/howto/password.html
103 ; Logging into the wiki with the admin user and password allows you to lock,
104 ; unlock, or remove pages and to perform other PhpWikiAdministration
105 ; functions. On all other occasions you should simply log in with your
107 ; If your password contains special chars like ";" or ":" better quote it in double-quotes.
111 ; It is recommended that you use the passencrypt.php utility to encode the
112 ; admin password, in the event that someone gains ftp or ssh access to the
113 ; server and directory containing phpwiki. Once you have pasted the
114 ; encrypted password into ADMIN_PASSWD, uncomment this next line.
115 ENCRYPTED_PASSWD = true
117 ; Private ZIP Dumps of All Wiki Pages
119 ; If true, only the admin user can make zip dumps. Otherwise anyone
120 ; may download all wiki pages as a single zip archive.
123 ; The RawHtml plugin allows page authors to embed real, raw HTML into Wiki
124 ; pages. This is a possible security threat, as much HTML (or, rather,
125 ; JavaScript) can be very risky. If you are in a controlled environment,
126 ; however, it could be of use.
127 ENABLE_RAW_HTML = true
128 ; If this is set, only pages locked by the Administrator may contain the RawHtml plugin
129 ENABLE_RAW_HTML_LOCKEDONLY = true
130 ; If this is set, all unsafe html code is stripped automatically (experimental!)
131 ; See http://chxo.com/scripts/safe_html-test.php
132 ENABLE_RAW_HTML_SAFE = true
134 ; If you define this to true, (MIME-type) page-dumps (either zip dumps,
135 ; or "dumps to directory" will be encoded using the quoted-printable
136 ; encoding. If you're actually thinking of mailing the raw page dumps,
137 ; then this might be useful, since (among other things,) it ensures
138 ; that all lines in the message body are under 80 characters in length.
140 ; Also, setting this will cause a few additional mail headers
141 ; to be generated, so that the resulting dumps are valid
142 ; RFC 2822 e-mail messages.
144 ; Probably you can just leave this set to false, in which case you get
145 ; raw ('binary' content-encoding) page dumps.
146 STRICT_MAILABLE_PAGEDUMPS = false
148 ; Here you can change the default dump directories.
149 ; (Can be overridden by the directory argument)
150 DEFAULT_DUMP_DIR = /tmp/wikidump
151 HTML_DUMP_DIR = /tmp/wikidumphtml
152 ; Filename suffix used for XHTML page dumps.
153 ; If you don't want any suffix just comment this out.
154 HTML_DUMP_SUFFIX = .html
156 ; The maximum file upload size, in bytes.
157 ; The default, 16777216, is 16MB.
158 MAX_UPLOAD_SIZE = 16777216
160 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
161 ; default state for the "minor edit" checkbox on the edit page form
163 ; The default, 604800, is one week (7 days)
164 MINOR_EDIT_TIMEOUT = 604800
166 ; Actions listed in this array will not be allowed. The complete list
167 ; of actions can be found in lib/main.php with the function
168 ; getActionDescription.
169 ; DISABLED_ACTIONS = "dumpserial : loadfile"
171 ; If you enable this option every page is moderated by the ModeratedPage
172 ; action page plugin. Changing a moderated page will be delayed to be
173 ; granted by a moderator by email.
174 ; ENABLE_MODERATEDPAGE_ALL = true
176 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
177 ; for you. If you want one, define this to the name of the log
178 ; file. The server must have write access to the directory specified.
179 ; Note that even you define ACCESS_LOG_SQL logs are written to this file also.
180 ;ACCESS_LOG = /var/tmp/wiki_access_log
182 ; PhpWiki can read and/or write mod_log_sql accesslog tables for faster
183 ; abuse detection and referer lists.
184 ; If defined (e.g. 1) read-access is done via SQL. If flag 2 is set, phpwiki also writes.
185 ;ACCESS_LOG_SQL = 1 ; read
186 ;ACCESS_LOG_SQL = 2 ; read + write
188 ; By default PhpWiki will try to have PHP compress its output
189 ; before sending it to the browser (if you have a recent enough
190 ; version of PHP and the browser supports it.)
191 ; Define COMPRESS_OUTPUT to false to prevent output compression.
192 ; Define COMPRESS_OUTPUT to true to force output compression,
193 ; even if we think your version of PHP does this in a buggy
195 ; Leave it undefined to leave the choice up to PhpWiki.
197 ; WARNING: Compressing the output has been reported to cause problems
198 ; when PHP is running on MacOSX or on redirected requests.
199 ; This setting should now be correctly determined automatically.
200 ;COMPRESS_OUTPUT = false
202 ; This controls how PhpWiki sets the HTTP cache control
203 ; headers (Expires: and Cache-Control:)
207 ; NO_CACHE: This is roughly the old (pre 1.3.4) behavior. PhpWiki will
208 ; instruct proxies and browsers never to cache PhpWiki output.
209 ; This was previously called 'NONE', but NONE was treated specially
210 ; by parse_ini_config().
212 ; STRICT: Cached pages will be invalidated whenever the database global
213 ; timestamp changes. This should behave just like NONE (modulo
214 ; bugs in PhpWiki and your proxies and browsers), except that
215 ; things will be slightly more efficient.
217 ; LOOSE: Cached pages will be invalidated whenever they are edited,
218 ; or, if the pages include plugins, when the plugin output could
219 ; concievably have changed.
221 ; Behavior should be much like STRICT, except that sometimes
222 ; wikilinks will show up as undefined (with the question mark)
223 ; when in fact they refer to (recently) created pages.
224 ; (Hitting your browsers reload or perhaps shift-reload button
225 ; should fix the problem.)
227 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
228 ; (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
230 ; This setting will result in quirky behavior. When you edit a
231 ; page your changes may not show up until you shift-reload the
234 ; This setting is generally not advisable, however it may be useful
235 ; in certain cases (e.g. if your wiki gets lots of page views,
236 ; and few edits by knowledgable people who won't freak over the quirks.)
238 ; The recommended default is currently LOOSE.
240 CACHE_CONTROL = LOOSE
242 ; Maximum page staleness, in seconds.
244 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
245 CACHE_CONTROL_MAX_AGE = 600
247 ; PhpWiki normally caches a preparsed version (i.e. mostly
248 ; converted to HTML) of the most recent version of each page.
249 ; (Parsing the wiki-markup takes a fair amount of CPU.)
250 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
251 ; caching of marked-up page content.
252 ; Note that you can also disable markup caching on a per-page
253 ; temporary basis by addinging a query arg of '?nocache=1'
254 ; to the URL to the page or by adding a NoCache plugin line.
255 ; Use '?nocache=purge' to completely discard the cached version of the page.
256 ; You can also purge the cached markup globally by using the
257 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
258 ; Enable only for old php's with low memory or memory_limit=8MB.
260 ;WIKIDB_NOCACHE_MARKUP = true
262 COOKIE_EXPIRATION_DAYS = 365
263 ; Default path for the wikiuser cookie. You need to specify this more explicitly
264 ; if you want to enable different users on different wikis on the same host.
267 ;======================================================================
268 ; Part Two: Database Selection
269 ;======================================================================
271 ; Select the database type:
273 ; SQL: access one of several SQL databases using the PEAR DB library.
274 ; ADODB: uses the ADODB library for data access.
275 ; dba: use one of the standard UNIX dbm libraries.
276 ; file: use a flat file database.
277 ; cvs: use a CVS server to store everything.
280 ; prefix for filenames or table names
282 ; Currently you MUST EDIT THE SQL file too (in the schemas/
283 ; directory because we aren't doing on the fly sql generation
284 ; during the installation.
285 ; Note: This prefix is NOT prepended to the default DBAUTH_
286 ; tables user, pref and member!
287 ;DATABASE_PREFIX = phpwiki_
289 ; For SQL based backends, specify the database as a DSN (Data Source Name),
290 ; a kind of URL for databases.
292 ; The most general form of a DSN looks like:
294 ; dbtype(dbsyntax)://username:password@protocol+hostspec/database
296 ; For a MySQL database, the following should work:
298 ; mysql://user:password@host/databasename
300 ; To connect over a unix socket, use something like
302 ; mysql://user:password@unix(/path/to/socket)/databasename
304 ; Valid values for dbtype are mysql, pgsql, or sqlite.
306 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
308 ; A table to store session information. Only needed by SQL backends.
310 ; A word of warning - any prefix defined above will be prepended to whatever
312 DATABASE_SESSION_TABLE = session
314 ; For the file and dba backends, this specifies where the data files will be
315 ; located. Ensure that the user that the webserver runs as has write access
318 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
319 ; you'll lose your wiki data at some stage.
320 DATABASE_DIRECTORY = /tmp
322 ; For the dba backend, this defines which DBA variant you wish to use.
323 ; gdbm - commonly available, Fedora not
324 ; db2 - Berkeley DB v2; not supported by modern versions of PHP
325 ; db3 - Berkeley DB v3; as per db2. The best on Windows
326 ; db4 - Berkeley DB v4; current version, however PHP has some issues
327 ; with it's db4 support.
328 ; dbm - Older dba handler; suffers from limits on the size of data
330 DATABASE_DBA_HANDLER = gdbm
332 ; How long will the system wait for a database operation to complete?
333 ; Specified in seconds.
336 ; If action=upgrade detects mysql problems, but has no ALTER permissions,
337 ; give here a user which has the necessary ALTER or CREATE permissions.
338 ; Of course you can fix your database manually. See lib/upgrade.php for known issues.
340 ;DBADMIN_PASSWD = secret
342 ; The login code now uses PHP's session support. Usually, the default
343 ; configuration of PHP is to store the session state information in
344 ; /tmp. That probably will work fine, but fails e.g. on clustered
345 ; servers where each server has their own distinct /tmp (this is the
346 ; case on SourceForge's project web server.) You can specify an
347 ; alternate directory in which to store state information like so
348 ; (whatever user your httpd runs as must have read/write permission
349 ; in this directory):
350 ;SESSION_SAVE_PATH = some_other_directory
352 ;========================================================================
353 ; Section 3a: Page revisions
355 ; The next section controls how many old revisions of each page are
356 ; kept in the database.
357 ;========================================================================
359 ; There are two basic classes of revisions: major and minor. Which
360 ; class a revision belongs in is determined by whether the author
361 ; checked the "this is a minor revision" checkbox when they saved the
364 ; There is, additionally, a third class of revisions: author
365 ; revisions. The most recent non-mergable revision from each distinct
366 ; author is an author revision.
368 ; The expiry parameters for each of those three classes of revisions
369 ; can be adjusted seperately. For each class there are five
370 ; parameters (usually, only two or three of the five are actually
371 ; set) which control how long those revisions are kept in the
374 ; MAX_KEEP: If set, this specifies an absolute maximum for the
375 ; number of archived revisions of that class. This is
376 ; meant to be used as a safety cap when a non-zero
377 ; min_age is specified. It should be set relatively high,
378 ; and it's purpose is to prevent malicious or accidental
379 ; database overflow due to someone causing an
380 ; unreasonable number of edits in a short period of time.
382 ; MIN_AGE: Revisions younger than this (based upon the supplanted
383 ; date) will be kept unless max_keep is exceeded. The age
384 ; should be specified in days. It should be a
385 ; non-negative, real number,
387 ; MIN_KEEP: At least this many revisions will be kept.
389 ; KEEP: No more than this many revisions will be kept.
391 ; MAX_AGE: No revision older than this age will be kept.
393 ; Definitions of terms used above:
395 ; Supplanted date: Revisions are timestamped at the instant that they
396 ; cease being the current revision. Revision age is computed using
397 ; this timestamp, not the edit time of the page.
399 ; Merging: When a minor revision is deleted, if the preceding
400 ; revision is by the same author, the minor revision is merged with
401 ; the preceding revision before it is deleted. Essentially: this
402 ; replaces the content (and supplanted timestamp) of the previous
403 ; revision with the content after the merged minor edit, the rest of
404 ; the page metadata for the preceding version (summary, mtime, ...)
407 ; Keep up to 8 major edits, but keep them no longer than a month.
411 ; Keep up to 4 minor edits, but keep them no longer than a week.
415 ; Keep the latest contributions of the last 8 authors up to a year.
416 ; Additionally, (in the case of a particularly active page) try to
417 ; keep the latest contributions of all authors in the last week (even
418 ; if there are more than eight of them,) but in no case keep more
419 ; than twenty unique author revisions.
425 ;========================================================================
426 ; Part Three: User Authentication
427 ;========================================================================
429 ; New user authentication configuration:
430 ; We support three basic authentication methods and a stacked array
431 ; of advanced auth methods to get and check the passwords:
433 ; ALLOW_ANON_USER default true
434 ; ALLOW_ANON_EDIT default true
435 ; ALLOW_BOGO_LOGIN default true
436 ; ALLOW_USER_PASSWORDS default true
438 ; allow anon users to view existing pages
439 ALLOW_ANON_USER = true
440 ; allow anon users to edit pages
441 ALLOW_ANON_EDIT = true
443 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
444 ; any/no password) using any userid which:
445 ; 1) is not the ADMIN_USER, and
446 ; 2) is a valid WikiWord (matches $WikiNameRegexp.)
447 ; If true, users may be created by themselves. Otherwise we need seperate auth.
448 ; If such a user will create a so called HomePage with his userid, he will
449 ; be able to store his preferences and password there.
450 ALLOW_BOGO_LOGIN = true
452 ; True User Authentication:
453 ; To require user passwords:
454 ; ALLOW_ANON_USER = false
455 ; ALLOW_ANON_EDIT = false
456 ; ALLOW_BOGO_LOGIN = false,
457 ; ALLOW_USER_PASSWORDS = true.
458 ; Otherwise any anon or bogo user might login without any or a wrong password.
459 ALLOW_USER_PASSWORDS = true
461 ; Many different methods can be used to check user's passwords:
462 ; BogoLogin: WikiWord username, with no *actual* password checking,
463 ; although the user will still have to enter one.
464 ; PersonalPage: Store passwords in the users homepage metadata (simple)
465 ; Db: Use DBAUTH_AUTH_* (see below) with PearDB or
467 ; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN (experimental)
468 ; IMAP: Authenticate against IMAP_AUTH_HOST (email account)
469 ; POP3: Authenticate against POP3_AUTH_HOST (email account)
470 ; File: Store username:crypted-passwords in .htaccess like files.
471 ; Use Apache's htpasswd to manage this file.
472 ; HttpAuth: Use the protection by the webserver (.htaccess) or
473 ; enforce it (Still experimental)
475 ; Several of these methods can be used together, in the manner specified by
476 ; USER_AUTH_POLICY, below. To specify multiple authentication methods,
477 ; separate the name of each one with colons.
478 ;USER_AUTH_ORDER = "PersonalPage : Db"
479 ;USER_AUTH_ORDER = "BogoLogin : PersonalPage"
481 ; For "security" purposes, you can specify that a password be at least a
482 ; certain number of characters long. This applies even to the BogoLogin
483 ; method. Default: 0 (to allow immediate passwordless BogoLogin)
484 ;PASSWORD_LENGTH_MINIMUM = 6
486 ; The following policies are available for user authentication:
487 ; first-only: use only the first method in USER_AUTH_ORDER
488 ; old: ignore USER_AUTH_ORDER and try to use all available
489 ; methods as in the previous PhpWiki releases (slow)
490 ; strict: check if the user exists for all methods:
491 ; on the first existing user, try the password.
492 ; dont try the other methods on failure then
493 ; stacked: check the given user - password combination for all
494 ; methods and return true on the first success.
495 USER_AUTH_POLICY = stacked
497 ; LDAP authentication options:
499 ; The LDAP server to connect to. Can either be a hostname, or a complete
500 ; URL to the server (useful if you want to use ldaps or specify a different
502 ;LDAP_AUTH_HOST = "ldap://localhost:389"
504 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
506 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
507 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
508 ;LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
510 ; Some LDAP servers need some more options, such as the Windows Active
511 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
512 ; and their values as NAME=value pairs separated by colons.
513 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
515 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
516 ; allow anonymous queries. (Windows Active Directory Server)
517 ; LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com"
519 ; Password to use to initially bind to the LDAP server, as the DN
520 ; specified in the LDAP_AUTH_USER option (above).
521 ; LDAP_AUTH_PASSWORD = secret
523 ; If you want to match usernames against an attribute other than uid,
524 ; specify it here. Default: uid
525 ; LDAP_SEARCH_FIELD = sAMAccountName
527 ; If you have an organizational unit for all users, define it here.
528 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
530 ; LDAP_OU_USERS = ou=Users
532 ; If you have an organizational unit for all groups, define it here.
533 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
534 ; The entries in this ou must have a gidNumber and cn attribute.
536 ; LDAP_OU_GROUP = ou=Groups
539 ; IMAP authentication options:
541 ; The IMAP server to check usernames from. Defaults to localhost.
543 ; Some IMAP_AUTH_HOST samples:
544 ; "localhost", "localhost:143/imap/notls",
545 ; "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
546 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
548 ; POP3 authentication options:
550 ; Host to connect to.
551 ; POP3_AUTH_HOST = "localhost:110"
553 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
554 ; POP3_AUTH_PORT = 110
556 ; File authentication options:
558 ; File to read for authentication information.
559 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
560 ; AUTH_USER_FILE = /etc/shadow
562 ; Defines whether the user is able to change their own password via PHPWiki.
563 ; Note that this means that the webserver user must be able to write to the
564 ; file specified in AUTH_USER_FILE.
565 ; AUTH_USER_FILE_STORABLE = false
568 ; Name of the session variable which holds the already authenticated username.
569 ; Sample: "userid", "user[username]", "user->username"
570 ; AUTH_SESS_USER = userid
571 ; Which level will the user be? 1 = Bogo or 2 = Pass
572 ; AUTH_SESS_LEVEL = 2
574 ; Group membership. PhpWiki supports defining permissions for a group as
575 ; well as for individual users. This defines how group membership information
576 ; is obtained. Supported values are:
578 ; "NONE" Disable group membership (Fastest). Note the required quoting.
579 ; WIKIPAGE Define groups as list at "CategoryGroup". (Slowest, but easiest to maintain)
580 ; DB Stored in an SQL database. Optionally external. See USERS/GROUPS queries
581 ; FILE Flatfile. See AUTH_GROUP_FILE below.
582 ; LDAP LDAP groups. See "LDAP authentication options" above and
583 ; lib/WikiGroup.php. (experimental)
584 GROUP_METHOD = WIKIPAGE
586 ; Page where all groups are listed. Default: Translation of "CategoryGroup"
587 ; CATEGORY_GROUP_PAGE = CategoryGroup
589 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
590 ; group membership information. It should be in the same format as the
591 ; standard unix /etc/groups(5) file.
592 ; AUTH_GROUP_FILE = /etc/groups
594 ; External database authentication and authorization.
596 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
597 ; below define the SQL queries used to obtain the information out of the
598 ; database, and (in some cases) store the information back to the DB.
600 ; The options appropriate for each query are currently undocumented, and
601 ; you should not be surprised if things change mightily in the future.
603 ; A database DSN to connect to. Defaults to the DSN specified for the Wiki
605 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
607 ; USER/PASSWORD queries
609 ; For USER_AUTH_POLICY=strict and the Db method this is required:
610 ; DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
612 ; Check to see if the supplied username/password pair is OK
614 ; plaintext passwords:
615 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM user WHERE userid='$userid'"
617 ; database-hashed passwords (more secure):
618 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM user WHERE userid='$userid'"
619 DBAUTH_AUTH_CRYPT_METHOD = plain
621 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
622 ; to get the password out of the database with a simple SELECT query, and
623 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
624 ; DBAUTH_AUTH_CHECK = "SELECT passwd FROM user where userid='$userid'"
625 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
627 ; Update the user's authentication credential. If this is not defined but
628 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
631 ; Plaintext passwords:
632 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd='$password' WHERE userid='$userid'"
633 ; Database-hashed passwords:
634 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd=PASSWORD('$password') WHERE userid='$userid'"
636 ; Allow the user to create their own account.
637 ; DBAUTH_AUTH_CREATE = "INSERT INTO user SET passwd=PASSWORD('$password'),userid='$userid'"
639 ; USER/PREFERENCE queries
641 ; If you choose to store your preferences in an external database, enable
642 ; the following queries. Note that if you choose to store user preferences
643 ; in the 'user' table, only registered users get their prefs from the database,
644 ; self-created users do not. Better to use the special 'pref' table.
646 ; The prefs field stores the serialized form of the user's preferences array,
647 ; to ease the complication of storage.
648 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM user WHERE userid='$userid'"
649 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM pref WHERE userid='$userid'"
651 ; Update the user's preferences
652 ; DBAUTH_PREF_UPDATE = "UPDATE user SET prefs='$pref_blob' WHERE userid='$userid'"
653 ; Note that REPLACE works only with mysql and destroy all other columns!
654 ; DBAUTH_PREF_UPDATE = "REPLACE INTO pref SET prefs='$pref_blob',userid='$userid'"
656 ; USERS/GROUPS queries
658 ; You can define 1:n or n:m user<=>group relations, as you wish.
660 ; Sample configurations:
661 ; only one group per user (1:n):
662 ; DBAUTH_IS_MEMBER = "SELECT user FROM user WHERE user='$userid' AND group='$groupname'"
663 ; DBAUTH_GROUP_MEMBERS = "SELECT user FROM user WHERE group='$groupname'"
664 ; DBAUTH_USER_GROUPS = "SELECT group FROM user WHERE user='$userid'"
665 ; multiple groups per user (n:m):
666 ; DBAUTH_IS_MEMBER = "SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'"
667 ; DBAUTH_GROUP_MEMBERS = "SELECT DISTINCT userid FROM member WHERE groupname='$groupname'"
668 ; DBAUTH_USER_GROUPS = "SELECT groupname FROM member WHERE userid='$userid'"
670 ; A interim page which gets displayed on every edit attempt, if it exists.
671 ;EDITING_POLICY = EditingPolicy
673 ;========================================================================
674 ; Part Four: Page appearance and layout
675 ;========================================================================
679 ; Most of the page appearance is controlled by files in the theme
682 ; There are a number of pre-defined themes shipped with PhpWiki.
683 ; Or you may create your own (e.g. by copying and then modifying one of
686 ; The complete list of installed themes can be found by doing 'ls themes/'
687 ; from the root of your PHPWiki installation.
698 ; Select a valid charset name to be inserted into the xml/html pages,
699 ; and to reference links to the stylesheets (css). For more info see:
700 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
701 ; has been extensively tested only with the latin1 (iso-8859-1)
704 ; If you change the default from iso-8859-1 PhpWiki may not work
705 ; properly and will require modifications in all existing pages.
706 ; At the very least you will have to convert the files in pgsrc
707 ; or locale/xx/pgsrc to match!
708 ; Currently we support utf-8 for zh, euc-jp for ja and iso-8859-1
709 ; for all other langs. Changing languages (UserPreferences) from one
710 ; charset to another will not work!
712 ; Character sets similar to iso-8859-1 may work with little or no
713 ; modification depending on your setup. The database must also
714 ; support the same charset, and of course the same is true for the
715 ; web browser. (Some work is in progress hopefully to allow more
716 ; flexibility in this area in the future).
719 ; Select your language/locale - default language is "en" for English.
720 ; Other languages available:
721 ; English "en" (English - HomePage)
722 ; Dutch "nl" (Nederlands - ThuisPagina)
723 ; Spanish "es" (Español - PáginaPrincipal)
724 ; French "fr" (Français - PageAccueil))
725 ; German "de" (Deutsch - StartSeite)
726 ; Swedish "sv" (Svenska - Framsida)
727 ; Italian "it" (Italiano - PaginaPrincipale)
728 ; Japanese "ja" (Japanese - ¥Û¡¼¥à ¥Ú¡¼¥¸)
729 ; Chinese "zh" (Chinese - ?)
731 ; If you set DEFAULT_LANGUAGE to the empty string, your system's
732 ; default language (as determined by the applicable environment
733 ; variables) will be used.
734 ; Japanese requires euc-jp, Chinese utf-8
736 DEFAULT_LANGUAGE = en
738 ; WIKI_PGSRC -- specifies the source for the initial page contents of
739 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
740 ; accessed for the first time (or after clearing the database.)
741 ; WIKI_PGSRC can either name a directory or a zip file. In either case
742 ; WIKI_PGSRC is scanned for files -- one file per page.
745 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
746 ; default (English) and when reading from a directory: in that case
747 ; some English pages are inserted into the wiki as well.
748 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
749 ;DEFAULT_WIKI_PGSRC = pgsrc
750 ; These are ':'-seperated pages which will get loaded untranslated from DEFAULT_WIKI_PGSRC.
751 ;DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
753 ;=========================================================================
754 ; Part Five: Mark-up options.
755 ;=========================================================================
757 ; allowed protocols for links - be careful not to allow "javascript:"
758 ; URL of these types will be automatically linked.
759 ; within a named link [name|uri] one more protocol is defined: phpwiki
760 ; Separate each of the protocol names with a vertical pipe, and ensure there
761 ; is no extraneous whitespace.
762 ;ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
764 ; URLs ending with the following extension should be inlined as images.
765 ; Specify as per ALLOWED_PROTOCOLS
766 ;INLINE_IMAGES = "png|jpg|gif"
768 ; Perl regexp for WikiNames ("bumpy words")
769 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
770 ;WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
772 ; Defaults to '/', but '.' was also used.
773 ;SUBPAGE_SEPARATOR = /
775 ; InterWiki linking -- wiki-style links to other wikis on the web
777 ; The map will be taken from a page name InterWikiMap.
778 ; If that page is not found (or is not locked), or map
779 ; data can not be found in it, then the file specified
780 ; by INTERWIKI_MAP_FILE (if any) will be used.
781 ;INTERWIKI_MAP_FILE = lib/interwiki.map
783 ; Display a warning if the internal lib/interwiki.map is used, and
784 ; not the public InterWikiMap page. This file is not readable from outside.
785 ;WARN_NONPUBLIC_INTERWIKIMAP = false
787 ; Search term used for automatic page classification by keyword extraction.
789 ; Any links on a page to pages whose names match this search
790 ; will be used keywords in the keywords html meta tag. This is an aid to
791 ; classification by search engines. The value of the match is
792 ; used as the keyword.
794 ; The default behavior is to match Category* or Topic* links.
795 ;KEYWORDS = "Category* OR Topic*"
797 ; Author and Copyright Site Navigation Links
799 ; These will be inserted as <link rel> tags in the html header of
800 ; every page, for search engines and for browsers like Mozilla which
801 ; take advantage of link rel site navigation.
803 ; If you have your own copyright and contact information pages change
804 ; these as appropriate.
805 ;COPYRIGHTPAGE_TITLE = "GNU General Public License"
806 ;COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/gpl.html#SEC1"
807 ; Other useful alternatives to consider:
808 ; COPYRIGHTPAGE_TITLE = "GNU Free Documentation License"
809 ; COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/fdl.html"
810 ; COPYRIGHTPAGE_TITLE = "Creative Commons License 2.0"
811 ; COPYRIGHTPAGE_URL = "http://creativecommons.org/licenses/by/2.0/"
812 ; see http://creativecommons.org/learn/licenses/ for variations
813 ;AUTHORPAGE_TITLE = The PhpWiki Programming Team
814 ;AUTHORPAGE_URL = http://phpwiki.org/ThePhpWikiProgrammingTeam
816 ; Allow full markup in headers to be parsed by the CreateToc plugin.
818 ; If false you may not use WikiWords or [] links or any other markup in
819 ; headers in pages with the CreateToc plugin. But if false the parsing is
820 ; faster and more stable.
821 ;TOC_FULL_SYNTAX = true
823 ;==========================================================================
824 ; Part Six: URL options.
825 ;==========================================================================
827 ; You can probably skip this section.
829 ; The following section contains settings which you can use to tailor
830 ; the URLs which PhpWiki generates.
832 ; Any of these parameters which are left undefined will be deduced
833 ; automatically. You need only set them explicitly if the
834 ; auto-detected values prove to be incorrect.
836 ; In most cases the auto-detected values should work fine, so
837 ; hopefully you don't need to mess with this section.
839 ; In case of local overrides of short placeholders, which themselves
840 ; include index.php, we check for most constants. See '/wiki'.
841 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki
842 ; versions (for development), but most likely other values like
843 ; THEME, LANG and DbParams for a WikiFarm.
845 ; Canonical name and httpd port of the server on which this PhpWiki
848 ;SERVER_NAME = some.host.com
851 ; Relative URL (from the server root) of the PhpWiki
853 ;SCRIPT_NAME = /some/where/index.php
855 ; URL of the PhpWiki install directory. (You only need to set this
856 ; if you've moved index.php out of the install directory.) This can
857 ; be either a relative URL (from the directory where the top-level
858 ; PhpWiki script is) or an absolute one.
859 ;DATA_PATH = /home/user/phpwiki
861 ; Path to the PhpWiki install directory. This is the local
862 ; filesystem counterpart to DATA_PATH. (If you have to set
863 ; DATA_PATH, your probably have to set this as well.) This can be
864 ; either an absolute path, or a relative path interpreted from the
865 ; directory where the top-level PhpWiki script (normally index.php)
867 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
869 ; PhpWiki will try to use short urls to pages, eg
870 ; http://www.example.com/index.php/HomePage
871 ; If you want to use urls like
872 ; http://www.example.com/index.php?pagename=HomePage
873 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
874 ; NB: If you are using Apache >= 2.0.30, then you may need to to use
875 ; the directive "AcceptPathInfo On" in your Apache configuration file
876 ; (or in an appropriate <.htaccess> file) for the short urls to work:
877 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
879 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
880 ; on prettifying your urls.
882 ; Note that Google doesn't follow the default /index.php/PageName links.
883 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
885 ; Default: PhpWiki will try to divine whether use of PATH_INFO
886 ; is supported in by your webserver/PHP configuration, and will
887 ; use PATH_INFO if it thinks that is possible.
888 ;USE_PATH_INFO = false
890 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
891 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
892 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
893 ; something different.
895 ; If you do this, you should set VIRTUAL_PATH here.
897 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
898 ; but * you've made it accessible through eg. /wiki/HomePage.
900 ; One way to do this is to create a directory named 'wiki' in your
901 ; server root. The directory contains only one file: an .htaccess
902 ; file which reads something like:
904 ; Action x-phpwiki-page /scripts/phpwiki/index.php
905 ; SetHandler x-phpwiki-page
906 ; DirectoryIndex /scripts/phpwiki/index.php
908 ; In that case you should set VIRTUAL_PATH to '/wiki'.
910 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
912 ;VIRTUAL_PATH = /SomeWiki
914 ; In case your system has no idea about /tmp, TEMP or TMPDIR,
915 ; better provide it here. E.g. needed for zipdumps.
918 ;===========================================================================
919 ; Part Seven: Miscellaneous settings
920 ;===========================================================================
922 ; Disable HTTP redirects.
923 ; (You probably don't need to touch this.)
925 ; PhpWiki uses HTTP redirects for some of it's functionality.
926 ; (e.g. after saving changes, PhpWiki redirects your browser to
927 ; view the page you just saved.)
928 ; Some web service providers (notably free European Lycos) don't seem to
929 ; allow these redirects. (On Lycos the result in an "Internal Server Error"
930 ; report.) In that case you can set DISABLE_HTTP_REDIRECT to true.
931 ; (In which case, PhpWiki will revert to sneakier tricks to try to
932 ; redirect the browser...)
933 ;DISABLE_HTTP_REDIRECT = true
935 ; Enable random quotes from a fortune directory when adding a new page.
936 ; Usually at /usr/share/fortune or /usr/share/games/fortune
937 ; If empty no quotes are inserted.
938 ;FORTUNE_DIR = /usr/share/fortune
940 ; If you get a crash at loading LinkIcons you might want to disable
941 ; the getimagesize() function, which crashes on certain php versions and
942 ; and some external images (png's, ..).
943 ; getimagesize() is only needed for spam prevention.
944 ;DISABLE_GETIMAGESIZE = true
946 ; Experimental: For using the Google API
947 ;GOOGLE_LICENSE_KEY = "..."
949 ; Optional: administrative SQL DB access (for action=upgrade)
953 ; Optional: external PDF executable, %s is the xhtml filename
954 ;USE_EXTERNAL_HTML2PDF = "htmldoc --quiet --format pdf14 --no-toc --no-title %s"
956 ; Optional: SPAMASSASSIN wrapper. Only used if ENABLE_SPAMASSASSIN = true
957 BABYCART_PATH = /usr/local/bin/babycart
959 ;===========================================================================
960 ; Part Eight: PLUGINCACHED Pear/Cache Settings
961 ;===========================================================================
963 ; Cache_Container storage class: 'file' is the fastest. See pear/Cache/Container/
964 ;PLUGIN_CACHED_DATABASE = file
966 ; This is only used if database is set to file.
967 ; The webserver must have write access to this dir!
968 ;PLUGIN_CACHED_CACHE_DIR = /tmp/cache
969 ; Every file name in the cache begins with this prefix
970 ;PLUGIN_CACHED_FILENAME_PREFIX = phpwiki
972 ; The maximum total space in bytes of all files in the cache. When
973 ; highwater is exceeded, a garbage collection will start. It will
974 ; collect garbage till 'lowwater' is reached. Default: 4 * Megabyte
975 ;PLUGIN_CACHED_HIGHWATER = 4194304
976 ; Default: 3 * Megabyte
977 ;PLUGIN_CACHED_LOWWATER = 3145728
979 ; If an image has not been used for maxlifetime remove it from the
980 ; cache. (Since there is also the highwater/lowwater mechanism and an
981 ; image usually requires only 1kb you don't have to make it very
983 ; Default: 30 * Day (30 * 24*60*60)
984 ;PLUGIN_CACHED_MAXLIFETIME = 2592000
986 ; Number of characters allowed to be send as
987 ; parameters in the url before using sessions
989 ; Usually send plugin arguments as URL, but when they become
990 ; longer than maxarglen store them in session variables.
991 ; Setting it to 3000 worked fine for me, 30000 completely
992 ; crashed my linux, 1000 should be safe.
993 ;PLUGIN_CACHED_MAXARGLEN = 1000
995 ; Actually use the cache (should be always true unless you are
996 ; debugging). If you want to avoid the usage of a cache but need
997 ; WikiPlugins that nevertheless rely on a cache you might set
998 ; 'PLUGIN_CACHED_USECACHE' to false. You still need to set
999 ; 'PLUGIN_CACHED_CACHE_DIR' appropriately to allow image creation and
1000 ; you should set 'PLUGIN_CACHED_FORCE_SYNCMAP' to false.
1001 ;PLUGIN_CACHED_USECACHE = true
1003 ; Will prevent image creation for an image map 'on demand'. It is a
1004 ; good idea to set this to 'true' because it will also prevent the
1005 ; html part not to fit to the image of the map. If you don't use a
1006 ; cache, you have to set it to 'false', maps will not work otherwise
1007 ; but strange effects may happen if the output of an image map
1008 ; producing WikiPlugin is not completely determined by its parameters.
1009 ; (As it is the case for a graphical site map.)
1010 ;PLUGIN_CACHED_FORCE_SYNCMAP = true
1012 ; If ImageTypes() does not exist (PHP < 4.0.2) allow the
1013 ; following image formats (IMG_PNG | IMG_GIF | IMG_JPG | IMG_WBMP)
1014 ; In principal all image types which are compiled into php:
1015 ; libgd, libpng, libjpeg, libungif, libtiff, libgd2, ...
1016 ;PLUGIN_CACHED_IMGTYPES = "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm"