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