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 seven parts: Parts Zero, One, Two, Three,
6 ; Four, Five and Six. 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.
10 ;=========================================================================
11 ; Part Zero: Tricky Options
12 ;=========================================================================
14 ; If PHP needs help in finding where you installed the rest of the PhpWiki
15 ; code, you can set the include_path here.
17 ; Define PHP's include path so that it can find the PHP source code
19 ; You shouldn't need to do this unless you've moved index.php out
20 ; of the PhpWiki install directory. But if you define it, be sure to include either
21 ; the system pear path or the phpwiki/lib/pear path.
22 ; Note that on Windows-based servers, you should use ; rather than :
23 ; as the path separator.
24 ;INCLUDE_PATH = ".:/usr/local/httpd/phpwiki:/usr/share/pear"
26 ; Set DEBUG to 1 to view the XHTML and CSS validator icons, page
27 ; processing timer, and possibly other debugging messages at the
28 ; bottom of each page. 2 for a more verbose level. Default: 0
31 ; Enable the new method of handling WikiUsers. This is currently an
32 ; experimental feature, although it is considered fairly stable. It's best
33 ; to leave it on, and only disable it if you have problems with it.
35 ;ENABLE_USER_NEW = false
37 ; Experimental new edit feature. Default: true
38 ;ENABLE_EDIT_TOOLBAR = false
39 ; Adds two additional buttons in EDIT_TOOLBAR, Search&Replace and Undo
40 ; Currently broken. Default: false
41 ;JS_SEARCHREPLACE = true
43 ;==========================================================================
44 ; Part One: Authentication and security settings.
46 ; See Part Three for more.
47 ;==========================================================================
49 ; The name of your wiki.
51 ; This is used to generate a keywords meta tag in the HTML templates,
52 ; in bookmark titles for any bookmarks made to pages in your wiki,
53 ; and during RSS generation for the <title> of the RSS channel.
55 ; To use your own logo and signature files, name them PhpWikiLogo.png
56 ; and PhpWikiSignature.png and put them into themes/default/images
57 ; (substituting "PhpWiki" in the filename with the name you define
60 ; It is recommended this be a relatively short WikiWord like the
61 ; InterWiki monikers found in the InterWikiMap. (For examples, see
65 ; Visitor Hostname Lookup
67 ; If set, reverse dns lookups will be performed to attempt to convert
68 ; the user's IP number into a host name, in the case where the http
69 ; server does not do this.
70 ENABLE_REVERSE_DNS = true
72 ; Username and password of administrator.
74 ; Set these to your preferences. For heaven's sake pick a good
75 ; password and use the passencrypt.php tool to encrypt the password from
77 ; http://wolfram.org/writing/howto/password.html
79 ; Logging into the wiki with the admin user and password allows you to lock,
80 ; unlock, or remove pages and to perform other PhpWikiAdministration
81 ; functions. On all other occasions you should simply log in with your
86 ; It is recommended that you use the passencrypt.php utility to encode the
87 ; admin password, in the event that someone gains ftp or ssh access to the
88 ; server and directory containing phpwiki. Once you have pasted the
89 ; encrypted password into ADMIN_PASSWD, uncomment this next line.
90 ENCRYPTED_PASSWD = true
92 ; Private ZIP Dumps of All Wiki Pages
94 ; If true, only the admin user can make zip dumps. Otherwise anyone
95 ; may download all wiki pages as a single zip archive.
98 ; The RawHtml plugin allows page authors to embed real, raw HTML into Wiki
99 ; pages. This is a possible security threat, as much HTML (or, rather,
100 ; JavaScript) can be very risky. If you are in a controlled environment,
101 ; however, it could be of use.
102 ENABLE_RAW_HTML = false;
104 ; If you define this to true, (MIME-type) page-dumps (either zip dumps,
105 ; or "dumps to directory" will be encoded using the quoted-printable
106 ; encoding. If you're actually thinking of mailing the raw page dumps,
107 ; then this might be useful, since (among other things,) it ensures
108 ; that all lines in the message body are under 80 characters in length.
110 ; Also, setting this will cause a few additional mail headers
111 ; to be generated, so that the resulting dumps are valid
112 ; RFC 2822 e-mail messages.
114 ; Probably you can just leave this set to false, in which case you get
115 ; raw ('binary' content-encoding) page dumps.
116 STRICT_MAILABLE_PAGEDUMPS = false
118 ; Here you can change the default dump directories.
119 ; (Can be overridden by the directory argument)
120 DEFAULT_DUMP_DIR = /tmp/wikidump
121 HTML_DUMP_DIR = /tmp/wikidumphtml
122 ; Filename suffix used for XHTML page dumps.
123 ; If you don't want any suffix just comment this out.
124 HTML_DUMP_SUFFIX = .html
126 ; The maximum file upload size, in bytes.
127 ; The default, 16777216, is 16MB.
128 MAX_UPLOAD_SIZE = 16777216
130 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
131 ; default state for the "minor edit" checkbox on the edit page form
133 ; The default, 604800, is one week (7 days)
134 MINOR_EDIT_TIMEOUT = 604800
136 ; Actions listed in this array will not be allowed. The complete list
137 ; of actions can be found in lib/main.php with the function
138 ; getActionDescription.
139 ; DISABLED_ACTIONS = "dumpserial : loadfile"
141 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
142 ; for you. If you want one, define this to the name of the log
143 ; file. The server must have write access to the directory specified.
144 ;ACCESS_LOG = /var/tmp/wiki_access_log
146 ; By default PhpWiki will try to have PHP compress its output
147 ; before sending it to the browser (if you have a recent enough
148 ; version of PHP and the browser supports it.)
149 ; Define COMPRESS_OUTPUT to false to prevent output compression.
150 ; Define COMPRESS_OUTPUT to true to force output compression,
151 ; even if we think your version of PHP does this in a buggy
153 ; Leave it undefined to leave the choice up to PhpWiki.
155 ; WARNING: Compressing the output has been reported to cause serious problems
156 ; when PHP is running as a CGI or on MacOSX.
157 ;COMPRESS_OUTPUT = false
159 ; This controls how PhpWiki sets the HTTP cache control
160 ; headers (Expires: and Cache-Control:)
164 ; NO_CACHE: This is roughly the old (pre 1.3.4) behavior. PhpWiki will
165 ; instruct proxies and browsers never to cache PhpWiki output.
166 ; This was previously called 'NONE', but NONE was treated specially
167 ; by parse_ini_config().
169 ; STRICT: Cached pages will be invalidated whenever the database global
170 ; timestamp changes. This should behave just like NONE (modulo
171 ; bugs in PhpWiki and your proxies and browsers), except that
172 ; things will be slightly more efficient.
174 ; LOOSE: Cached pages will be invalidated whenever they are edited,
175 ; or, if the pages include plugins, when the plugin output could
176 ; concievably have changed.
178 ; Behavior should be much like STRICT, except that sometimes
179 ; wikilinks will show up as undefined (with the question mark)
180 ; when in fact they refer to (recently) created pages.
181 ; (Hitting your browsers reload or perhaps shift-reload button
182 ; should fix the problem.)
184 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
185 ; (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
187 ; This setting will result in quirky behavior. When you edit a
188 ; page your changes may not show up until you shift-reload the
191 ; This setting is generally not advisable, however it may be useful
192 ; in certain cases (e.g. if your wiki gets lots of page views,
193 ; and few edits by knowledgable people who won't freak over the quirks.)
195 ; The recommended default is currently LOOSE.
197 CACHE_CONTROL = LOOSE
199 ; Maximum page staleness, in seconds.
201 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
202 CACHE_CONTROL_MAX_AGE = 600
204 ; PhpWiki normally caches a preparsed version (i.e. mostly
205 ; converted to HTML) of the most recent version of each page.
206 ; (Parsing the wiki-markup takes a fair amount of CPU.)
208 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
209 ; caching of marked-up page content.
211 ; Note that you can also disable markup caching on a per-page
212 ; temporary basis by addinging a query arg of '?nocache=1'
213 ; to the URL to the page. (Use '?nocache=purge' to completely
214 ; discard the cached version of the page.)
216 ; You can also purge the cached markup globally by using the
217 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
218 ;WIKIDB_NOCACHE_MARKUP = true
220 ;======================================================================
221 ; Part Two: Database Selection
222 ;======================================================================
224 ; Select the database type:
226 ; SQL: access one of several SQL databases using the PEAR DB library.
227 ; ADODB: uses the ADODB library for data access.
228 ; dba: use one of the standard UNIX dbm libraries.
229 ; file: use a flat file database.
230 ; cvs: use a CVS server to store everything.
233 ; prefix for filenames or table names
235 ; Currently you MUST EDIT THE SQL file too (in the schemas/
236 ; directory because we aren't doing on the fly sql generation
237 ; during the installation.
238 ; Note: This prefix is NOT prepended to the default DBAUTH_
239 ; tables user, pref and member!
240 ;DATABASE_PREFIX = phpwiki_
242 ; For SQL based backends, specify the database as a DSN (Data Source Name),
243 ; a kind of URL for databases.
245 ; The most general form of a DSN looks like:
247 ; dbtype(dbsyntax)://username:password@protocol+hostspec/database
249 ; For a MySQL database, the following should work:
251 ; mysql://user:password@host/databasename
253 ; To connect over a unix socket, use something like
255 ; mysql://user:password@unix(/path/to/socket)/databasename
257 ; Valid values for dbtype are mysql, pgsql, or sqlite.
259 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
261 ; A table to store session information. Only needed by SQL backends.
263 ; A word of warning - any prefix defined above will be prepended to whatever
265 DATABASE_SESSION_TABLE = session
267 ; For the file and dba backends, this specifies where the data files will be
268 ; located. Ensure that the user that the webserver runs as has write access
271 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
272 ; you'll lose your wiki data at some stage.
273 DATABASE_DIRECTORY = /tmp
275 ; For the dba backend, this defines which DBA variant you wish to use.
276 ; gdbm - commonly available
277 ; db2 - Berkeley DB v2; not supported by modern versions of PHP
278 ; db3 - Berkeley DB v3; as per db2. The best on Windows
279 ; db4 - Berkeley DB v4; current version, however PHP has some issues
280 ; with it's db4 support.
281 ; dbm - Older dba handler; suffers from limits on the size of data
283 DATABASE_DBA_HANDLER = gdbm
285 ; How long will the system wait for a database operation to complete?
286 ; Specified in seconds.
287 DATABASE_TIMEOUT = 20
289 ; If action=upgrade detects mysql problems, but has no ALTER permissions,
290 ; give here a user which has the necessary ALTER or CREATE permissions.
291 ; Of course you can fix your database manually. See lib/upgrade.php for known issues.
293 ;DBADMIN_PASSWD = secret
295 ; The login code now uses PHP's session support. Usually, the default
296 ; configuration of PHP is to store the session state information in
297 ; /tmp. That probably will work fine, but fails e.g. on clustered
298 ; servers where each server has their own distinct /tmp (this is the
299 ; case on SourceForge's project web server.) You can specify an
300 ; alternate directory in which to store state information like so
301 ; (whatever user your httpd runs as must have read/write permission
302 ; in this directory):
303 ;SESSION_SAVE_PATH = some_other_directory
305 ;========================================================================
306 ; Section 3a: Page revisions
308 ; The next section controls how many old revisions of each page are
309 ; kept in the database.
310 ;========================================================================
312 ; There are two basic classes of revisions: major and minor. Which
313 ; class a revision belongs in is determined by whether the author
314 ; checked the "this is a minor revision" checkbox when they saved the
317 ; There is, additionally, a third class of revisions: author
318 ; revisions. The most recent non-mergable revision from each distinct
319 ; author is an author revision.
321 ; The expiry parameters for each of those three classes of revisions
322 ; can be adjusted seperately. For each class there are five
323 ; parameters (usually, only two or three of the five are actually
324 ; set) which control how long those revisions are kept in the
327 ; MAX_KEEP: If set, this specifies an absolute maximum for the
328 ; number of archived revisions of that class. This is
329 ; meant to be used as a safety cap when a non-zero
330 ; min_age is specified. It should be set relatively high,
331 ; and it's purpose is to prevent malicious or accidental
332 ; database overflow due to someone causing an
333 ; unreasonable number of edits in a short period of time.
335 ; MIN_AGE: Revisions younger than this (based upon the supplanted
336 ; date) will be kept unless max_keep is exceeded. The age
337 ; should be specified in days. It should be a
338 ; non-negative, real number,
340 ; MIN_KEEP: At least this many revisions will be kept.
342 ; KEEP: No more than this many revisions will be kept.
344 ; MAX_AGE: No revision older than this age will be kept.
346 ; Definitions of terms used above:
348 ; Supplanted date: Revisions are timestamped at the instant that they
349 ; cease being the current revision. Revision age is computed using
350 ; this timestamp, not the edit time of the page.
352 ; Merging: When a minor revision is deleted, if the preceding
353 ; revision is by the same author, the minor revision is merged with
354 ; the preceding revision before it is deleted. Essentially: this
355 ; replaces the content (and supplanted timestamp) of the previous
356 ; revision with the content after the merged minor edit, the rest of
357 ; the page metadata for the preceding version (summary, mtime, ...)
360 ; Keep up to 8 major edits, but keep them no longer than a month.
364 ; Keep up to 4 minor edits, but keep them no longer than a week.
368 ; Keep the latest contributions of the last 8 authors up to a year.
369 ; Additionally, (in the case of a particularly active page) try to
370 ; keep the latest contributions of all authors in the last week (even
371 ; if there are more than eight of them,) but in no case keep more
372 ; than twenty unique author revisions.
378 ;========================================================================
379 ; Part Three: User Authentication
380 ;========================================================================
382 ; New user authentication configuration:
383 ; We support three basic authentication methods and a stacked array
384 ; of advanced auth methods to get and check the passwords:
386 ; ALLOW_ANON_USER default true
387 ; ALLOW_ANON_EDIT default true
388 ; ALLOW_BOGO_LOGIN default true
389 ; ALLOW_USER_PASSWORDS default true
391 ; allow anon users to view existing pages
392 ALLOW_ANON_USER = true
393 ; allow anon users to edit pages
394 ALLOW_ANON_EDIT = true
396 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
397 ; any/no password) using any userid which:
398 ; 1) is not the ADMIN_USER, and
399 ; 2) is a valid WikiWord (matches $WikiNameRegexp.)
400 ; If true, users may be created by themselves. Otherwise we need seperate auth.
401 ; If such a user will create a so called HomePage with his userid, he will
402 ; be able to store his preferences and password there.
403 ALLOW_BOGO_LOGIN = true
405 ; True User Authentication:
406 ; To require user passwords:
407 ; ALLOW_ANON_USER = false
408 ; ALLOW_ANON_EDIT = false
409 ; ALLOW_BOGO_LOGIN = false,
410 ; ALLOW_USER_PASSWORDS = true.
411 ; Otherwise any anon or bogo user might login without any or a wrong password.
412 ALLOW_USER_PASSWORDS = true
414 ; Many different methods can be used to check user's passwords:
415 ; BogoLogin: WikiWord username, with no *actual* password checking,
416 ; although the user will still have to enter one.
417 ; PersonalPage: Store passwords in the users homepage metadata (simple)
418 ; Db: Use DBAUTH_AUTH_* (see below) with PearDB or
420 ; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN
421 ; IMAP: Authenticate against IMAP_AUTH_HOST (email account)
422 ; POP3: Authenticate against POP3_AUTH_HOST (email account)
423 ; File: Store username:crypted-passwords in .htaccess like files.
424 ; Use Apache's htpasswd to manage this file.
425 ; HttpAuth: Use the protection by the webserver (.htaccess) or
428 ; Several of these methods can be used together, in the manner specified by
429 ; USER_AUTH_POLICY, below. To specify multiple authentication methods,
430 ; separate the name of each one with colons.
431 USER_AUTH_ORDER = "PersonalPage : Db"
433 ; For "security" purposes, you can specify that a password be at least a
434 ; certain number of characters long. This applies even to the BogoLogin
436 PASSWORD_LENGTH_MINIMUM = 2
438 ; The following policies are available for user authentication:
439 ; first-only: use only the first method in USER_AUTH_ORDER
440 ; old: ignore USER_AUTH_ORDER and try to use all available
441 ; methods as in the previous PhpWiki releases (slow)
442 ; strict: check if the user exists for all methods:
443 ; on the first existing user, try the password.
444 ; dont try the other methods on failure then
445 ; stacked: check the given user - password combination for all
446 ; methods and return true on the first success.
447 USER_AUTH_POLICY = stacked
449 ; LDAP authentication options:
451 ; The LDAP server to connect to. Can either be a hostname, or a complete
452 ; URL to the server (useful if you want to use ldaps or specify a different
454 ;LDAP_AUTH_HOST = "ldap://localhost:389"
456 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
458 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
459 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
460 ;LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
462 ; Some LDAP servers need some more options, such as the Windows Active
463 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
464 ; and their values as NAME=value pairs separated by colons.
465 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
467 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
468 ; allow anonymous queries. (Windows Active Directory Server)
469 ; LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com"
471 ; Password to use to initially bind to the LDAP server, as the DN
472 ; specified in the LDAP_AUTH_USER option (above).
473 ; LDAP_AUTH_PASSWORD = secret
475 ; If you want to match usernames against an attribute other than uid,
476 ; specify it here. Default: uid
477 ; LDAP_SEARCH_FIELD = sAMAccountName
479 ; If you have an organizational unit for all users, define it here.
480 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
482 ; LDAP_OU_USERS = ou=Users
484 ; If you have an organizational unit for all groups, define it here.
485 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
486 ; The entries in this ou must have a gidNumber and cn attribute.
488 ; LDAP_OU_GROUP = ou=Groups
491 ; IMAP authentication options:
493 ; The IMAP server to check usernames from. Defaults to localhost.
495 ; Some IMAP_AUTH_HOST samples:
496 ; "localhost", "localhost:143/imap/notls",
497 ; "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
498 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
500 ; POP3 authentication options:
502 ; Host to connect to.
503 ; POP3_AUTH_HOST = "localhost:110"
505 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
506 ; POP3_AUTH_PORT = 110
508 ; File authentication options:
510 ; File to read for authentication information.
511 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
512 ; AUTH_USER_FILE = /etc/shadow
514 ; Defines whether the user is able to change their own password via PHPWiki.
515 ; Note that this means that the webserver user must be able to write to the
516 ; file specified in AUTH_USER_FILE.
517 ; AUTH_USER_FILE_STORABLE = false
520 ; Name of the session variable which holds the already authenticated username.
521 ; Sample: "userid", "user[username]", "user->username"
522 ; AUTH_SESS_USER = userid
523 ; Which level will the user be? 1 = Bogo or 2 = Pass
524 ; AUTH_SESS_LEVEL = 2
526 ; Group membership. PHPWiki supports defining permissions for a group as
527 ; well as for individual users. This defines how group membership information
528 ; is obtained. Supported values are:
530 ; NONE group membership is not supported.
531 ; WIKIPAGE Defined in the metadata of a wiki page.
532 ; DB Stored in an ADODB or PearDB database.
534 ; LDAP Query LDAP to find the information.
535 GROUP_METHOD = WIKIPAGE
537 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
538 ; group membership information. It should be in the same format as the
539 ; standard unix /etc/groups(5) file.
540 ; AUTH_GROUP_FILE = /etc/groups
542 ; External database authentication and authorization.
544 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
545 ; below define the SQL queries used to obtain the information out of the
546 ; database, and (in some cases) store the information back to the DB.
548 ; The options appropriate for each query are currently undocumented, and
549 ; you should not be surprised if things change mightily in the future.
551 ; A database DSN to connect to. Defaults to the DSN specified for the Wiki
553 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
555 ; USER/PASSWORD queries
557 ; Check to see if the supplied username/password pair is OK
559 ; plaintext passwords:
560 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM user WHERE userid='$userid'"
562 ; database-hashed passwords (more secure):
563 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM user WHERE userid='$userid'"
564 DBAUTH_AUTH_CRYPT_METHOD = plain
566 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
567 ; to get the password out of the database with a simple SELECT query, and
568 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
569 ; DBAUTH_AUTH_CHECK = "SELECT passwd FROM user where userid='$userid'"
570 ; DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
571 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
573 ; Update the user's authentication credential. If this is not defined but
574 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
577 ; Plaintext passwords:
578 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd='$password' WHERE userid='$userid'"
579 ; Database-hashed passwords:
580 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd=PASSWORD('$password') WHERE userid='$userid'"
582 ; Allow the user to create their own account.
583 ; DBAUTH_AUTH_CREATE = "INSERT INTO user SET passwd=PASSWORD('$password'),userid='$userid'"
585 ; USER/PREFERENCE queries
587 ; If you choose to store your preferences in an external database, enable
588 ; the following queries. Note that if you choose to store user preferences
589 ; in the 'user' table, only registered users get their prefs from the database,
590 ; self-created users do not. Better to use the special 'pref' table.
592 ; The prefs field stores the serialized form of the user's preferences array,
593 ; to ease the complication of storage.
594 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM user WHERE userid='$userid'"
595 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM pref WHERE userid='$userid'"
597 ; Update the user's preferences
598 ; DBAUTH_PREF_UPDATE = "UPDATE user SET prefs='$pref_blob' WHERE userid='$userid'"
599 ; Note that REPLACE works only with mysql and destroy all other columns!
600 ; DBAUTH_PREF_UPDATE = "REPLACE INTO pref SET prefs='$pref_blob',userid='$userid'"
602 ; USERS/GROUPS queries
604 ; You can define 1:n or n:m user<=>group relations, as you wish.
606 ; Sample configurations:
607 ; only one group per user (1:n):
608 ; DBAUTH_IS_MEMBER = "SELECT user FROM user WHERE user='$userid' AND group='$groupname'"
609 ; DBAUTH_GROUP_MEMBERS = "SELECT user FROM user WHERE group='$groupname'"
610 ; DBAUTH_USER_GROUPS = "SELECT group FROM user WHERE user='$userid'"
611 ; multiple groups per user (n:m):
612 ; DBAUTH_IS_MEMBER = "SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'"
613 ; DBAUTH_GROUP_MEMBERS = "SELECT DISTINCT userid FROM member WHERE groupname='$groupname'"
614 ; DBAUTH_USER_GROUPS = "SELECT groupname FROM member WHERE userid='$userid'"
616 ; A interim page which gets displayed on every edit attempt
617 EDITING_POLICY = EditingPolicy
619 ;========================================================================
620 ; Part Four: Page appearance and layout
621 ;========================================================================
625 ; Most of the page appearance is controlled by files in the theme
628 ; There are a number of pre-defined themes shipped with PhpWiki.
629 ; Or you may create your own (e.g. by copying and then modifying one of
632 ; The complete list of installed themes can be found by doing 'ls themes/'
633 ; from the root of your PHPWiki installation.
644 ; Select a valid charset name to be inserted into the xml/html pages,
645 ; and to reference links to the stylesheets (css). For more info see:
646 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
647 ; has been extensively tested only with the latin1 (iso-8859-1)
650 ; If you change the default from iso-8859-1 PhpWiki may not work
651 ; properly and will require modifications in all existing pages.
652 ; At the very least you will have to convert the files in pgsrc
653 ; or locale/xx/pgsrc to match!
654 ; Currently we support utf-8 for zh, euc-jp for ja and iso-8859-1
655 ; for all other langs. Changing languages (UserPreferences) from one
656 ; charset to another will not work!
658 ; Character sets similar to iso-8859-1 may work with little or no
659 ; modification depending on your setup. The database must also
660 ; support the same charset, and of course the same is true for the
661 ; web browser. (Some work is in progress hopefully to allow more
662 ; flexibility in this area in the future).
665 ; Select your language/locale - default language is "en" for English.
666 ; Other languages available:
667 ; English "en" (English - HomePage)
668 ; Dutch "nl" (Nederlands - ThuisPagina)
669 ; Spanish "es" (Español - PáginaPrincipal)
670 ; French "fr" (Français - PageAccueil))
671 ; German "de" (Deutsch - StartSeite)
672 ; Swedish "sv" (Svenska - Framsida)
673 ; Italian "it" (Italiano - PaginaPrincipale)
674 ; Japanese "ja" (Japanese - ¥Û¡¼¥à ¥Ú¡¼¥¸)
675 ; Chinese "zh" (Chinese - ?)
677 ; If you set DEFAULT_LANGUAGE to the empty string, your system's
678 ; default language (as determined by the applicable environment
679 ; variables) will be used.
680 ; Japanese requires euc-jp, Chinese utf-8
682 DEFAULT_LANGUAGE = en
684 ; WIKI_PGSRC -- specifies the source for the initial page contents of
685 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
686 ; accessed for the first time (or after clearing the database.)
687 ; WIKI_PGSRC can either name a directory or a zip file. In either case
688 ; WIKI_PGSRC is scanned for files -- one file per page.
691 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
692 ; default (English) and when reading from a directory: in that case
693 ; some English pages are inserted into the wiki as well.
694 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
695 DEFAULT_WIKI_PGSRC = pgsrc
696 ; These are the pages which will get loaded from DEFAULT_WIKI_PGSRC.
697 DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
699 ;=========================================================================
700 ; Part Five: Mark-up options.
701 ;=========================================================================
703 ; allowed protocols for links - be careful not to allow "javascript:"
704 ; URL of these types will be automatically linked.
705 ; within a named link [name|uri] one more protocol is defined: phpwiki
706 ; Separate each of the protocol names with a vertical pipe, and ensure there
707 ; is no extraneous whitespace.
708 ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
710 ; URLs ending with the following extension should be inlined as images.
711 ; Specify as per ALLOWED_PROTOCOLS
712 INLINE_IMAGES = "png|jpg|gif"
714 ; Perl regexp for WikiNames ("bumpy words")
715 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
716 WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
718 ; Defaults to '/', but '.' was also used.
719 SUBPAGE_SEPARATOR = /
721 ; InterWiki linking -- wiki-style links to other wikis on the web
723 ; The map will be taken from a page name InterWikiMap.
724 ; If that page is not found (or is not locked), or map
725 ; data can not be found in it, then the file specified
726 ; by INTERWIKI_MAP_FILE (if any) will be used.
727 INTERWIKI_MAP_FILE = lib/interwiki.map
729 ; Display a warning if the internal lib/interwiki.map is used, and
730 ; not the public InterWikiMap page. This file is not readable from outside.
731 WARN_NONPUBLIC_INTERWIKIMAP = false
733 ; Regexp used for automatic keyword extraction.
735 ; Any links on a page to pages whose names match this regexp will
736 ; be used keywords in the keywords meta tag. (This is an aid to
737 ; classification by search engines.) The value of the match is
738 ; used as the keyword.
740 ; The default behavior is to match Category* and Topic* links.
741 KEYWORDS = "Category:Topic"
742 ; KEYWORD_LINK_REGEXP = "(?<=^\'. join(\'|^\', $keywords) . \')[[:upper:]].*$"
744 ; Author and Copyright Site Navigation Links
746 ; These will be inserted as <link rel> tags in the html header of
747 ; every page, for search engines and for browsers like Mozilla which
748 ; take advantage of link rel site navigation.
750 ; If you have your own copyright and contact information pages change
751 ; these as appropriate.
752 COPYRIGHTPAGE_TITLE = "GNU General Public License"
753 COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/gpl.html#SEC1"
754 ; Other useful alternatives to consider:
755 ; COPYRIGHTPAGE_TITLE = "GNU Free Documentation License"
756 ; COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/fdl.html"
757 ; COPYRIGHTPAGE_TITLE = "Creative Commons License 2.0"
758 ; COPYRIGHTPAGE_URL = "http://creativecommons.org/licenses/by/2.0/"
759 ; see http://creativecommons.org/learn/licenses/ for variations
760 AUTHORPAGE_TITLE = The PhpWiki Programming Team
761 AUTHORPAGE_URL = http://phpwiki.sourceforge.net/phpwiki/ThePhpWikiProgrammingTeam
763 ; Allow full markup in headers to be parsed by the CreateToc plugin.
765 ; If false you may not use WikiWords or [] links or any other markup in
766 ; headers in pages with the CreateToc plugin. But if false the parsing is
767 ; faster and more stable.
768 TOC_FULL_SYNTAX = true
770 ;==========================================================================
771 ; Part Six: URL options.
772 ;==========================================================================
774 ; You can probably skip this section.
776 ; The following section contains settings which you can use to tailor
777 ; the URLs which PhpWiki generates.
779 ; Any of these parameters which are left undefined will be deduced
780 ; automatically. You need only set them explicitly if the
781 ; auto-detected values prove to be incorrect.
783 ; In most cases the auto-detected values should work fine, so
784 ; hopefully you don't need to mess with this section.
786 ; In case of local overrides of short placeholders, which themselves
787 ; include index.php, we check for most constants. See '/wiki'.
788 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki
789 ; versions (for development), but most likely other values like
790 ; THEME, LANG and DbParams for a WikiFarm.
792 ; Canonical name and httpd port of the server on which this PhpWiki
795 ;SERVER_NAME = some.host.com
798 ; Relative URL (from the server root) of the PhpWiki
800 ;SCRIPT_NAME = /some/where/index.php
802 ; URL of the PhpWiki install directory. (You only need to set this
803 ; if you've moved index.php out of the install directory.) This can
804 ; be either a relative URL (from the directory where the top-level
805 ; PhpWiki script is) or an absolute one.
806 ;DATA_PATH = /home/user/phpwiki
808 ; Path to the PhpWiki install directory. This is the local
809 ; filesystem counterpart to DATA_PATH. (If you have to set
810 ; DATA_PATH, your probably have to set this as well.) This can be
811 ; either an absolute path, or a relative path interpreted from the
812 ; directory where the top-level PhpWiki script (normally index.php)
814 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
816 ; PhpWiki will try to use short urls to pages, eg
817 ; http://www.example.com/index.php/HomePage
818 ; If you want to use urls like
819 ; http://www.example.com/index.php?pagename=HomePage
820 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
821 ; NB: If you are using Apache >= 2.0.30, then you may need to to use
822 ; the directive "AcceptPathInfo On" in your Apache configuration file
823 ; (or in an appropriate <.htaccess> file) for the short urls to work:
824 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
826 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
827 ; on prettifying your urls.
829 ; Note that Google doesn't follow the default /index.php/PageName links.
830 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
832 ; Default: PhpWiki will try to divine whether use of PATH_INFO
833 ; is supported in by your webserver/PHP configuration, and will
834 ; use PATH_INFO if it thinks that is possible.
835 ;USE_PATH_INFO = false
837 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
838 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
839 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
840 ; something different.
842 ; If you do this, you should set VIRTUAL_PATH here.
844 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
845 ; but * you've made it accessible through eg. /wiki/HomePage.
847 ; One way to do this is to create a directory named 'wiki' in your
848 ; server root. The directory contains only one file: an .htaccess
849 ; file which reads something like:
851 ; Action x-phpwiki-page /scripts/phpwiki/index.php
852 ; SetHandler x-phpwiki-page
853 ; DirectoryIndex /scripts/phpwiki/index.php
855 ; In that case you should set VIRTUAL_PATH to '/wiki'.
857 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
859 ;VIRTUAL_PATH = /SomeWiki
861 ; In case your system has no idea about /tmp, TEMP or TMPDIR,
862 ; better provide it here. E.g. needed for zipdumps.
865 ;===========================================================================
866 ; Part Seven: Miscellaneous settings
867 ;===========================================================================
869 ; Disable HTTP redirects.
871 ; (You probably don't need to touch this.)
873 ; PhpWiki uses HTTP redirects for some of it's functionality.
874 ; (e.g. after saving changes, PhpWiki redirects your browser to
875 ; view the page you just saved.)
877 ; Some web service providers (notably free European Lycos) don't seem to
878 ; allow these redirects. (On Lycos the result in an "Internal Server Error"
879 ; report.) In that case you can set DISABLE_HTTP_REDIRECT to true.
880 ; (In which case, PhpWiki will revert to sneakier tricks to try to
881 ; redirect the browser...)
882 ;DISABLE_HTTP_REDIRECT = true
884 ; Enable random quotes from a fortune directory when adding a new page.
885 ; Usually at /usr/share/fortune or /usr/share/games/fortune
886 ; If empty no quotes are inserted.
887 ;FORTUNE_DIR = /usr/share/fortune
889 ; If you get a crash at loading LinkIcons you might want to disable
890 ; the getimagesize() function, which crashes on certain php versions and
891 ; and some external images (png's, ..).
892 ; getimagesize() is only needed for spam prevention.
893 ;DISABLE_GETIMAGESIZE = 1
895 ;===========================================================================
896 ; PLUGINCACHED Pear/Cache Settings: (moved from lib/plugincache-config.php)
897 ;===========================================================================
899 ; Cache_Container storage class: 'file' is the fastest. See pear/Cache/Container/
900 PLUGIN_CACHED_DATABASE = file
902 ; This is only used if database is set to file.
903 ; The webserver must have write access to this dir!
904 PLUGIN_CACHED_CACHE_DIR = /tmp/cache
905 ; Every file name in the cache begins with this prefix
906 PLUGIN_CACHED_FILENAME_PREFIX = phpwiki
908 ; The maximum total space in bytes of all files in the cache. When
909 ; highwater is exceeded, a garbage collection will start. It will
910 ; collect garbage till 'lowwater' is reached. Default: 4 * Megabyte
911 PLUGIN_CACHED_HIGHWATER = 4194304
912 ; Default: 3 * Megabyte
913 PLUGIN_CACHED_LOWWATER = 3145728
915 ; If an image has not been used for maxlifetime remove it from the
916 ; cache. (Since there is also the highwater/lowwater mechanism and an
917 ; image usually requires only 1kb you don't have to make it very
919 ; Default: 30 * Day (30 * 24*60*60)
920 PLUGIN_CACHED_MAXLIFETIME = 2592000
922 ; Number of characters allowed to be send as
923 ; parameters in the url before using sessions
925 ; Usually send plugin arguments as URL, but when they become
926 ; longer than maxarglen store them in session variables.
927 ; Setting it to 3000 worked fine for me, 30000 completely
928 ; crashed my linux, 1000 should be safe.
929 PLUGIN_CACHED_MAXARGLEN = 1000
931 ; Actually use the cache (should be always true unless you are
932 ; debugging). If you want to avoid the usage of a cache but need
933 ; WikiPlugins that nevertheless rely on a cache you might set
934 ; 'PLUGIN_CACHED_USECACHE' to false. You still need to set
935 ; 'PLUGIN_CACHED_CACHE_DIR' appropriately to allow image creation and
936 ; you should set 'PLUGIN_CACHED_FORCE_SYNCMAP' to false.
937 PLUGIN_CACHED_USECACHE = true
939 ; Will prevent image creation for an image map 'on demand'. It is a
940 ; good idea to set this to 'true' because it will also prevent the
941 ; html part not to fit to the image of the map. If you don't use a
942 ; cache, you have to set it to 'false', maps will not work otherwise
943 ; but strange effects may happen if the output of an image map
944 ; producing WikiPlugin is not completely determined by its parameters.
945 ; (As it is the case for a graphical site map.)
946 PLUGIN_CACHED_FORCE_SYNCMAP = true
948 ; If ImageTypes() does not exist (PHP < 4.0.2) allow the
949 ; following image formats (IMG_PNG | IMG_GIF | IMG_JPG | IMG_WBMP)
950 ; In principal all image types which are compiled into php:
951 ; libgd, libpng, libjpeg, libungif, libtiff, libgd2, ...
952 ; Todo: swf, pdf, ...
953 PLUGIN_CACHED_IMGTYPES = "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm"