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 filename suffix used for XHTML page dumps.
119 ; If you don't want any suffix just comment this out.
120 HTML_DUMP_SUFFIX = .html
122 ; The maximum file upload size, in bytes.
123 ; The default, 16777216, is 16MB.
124 MAX_UPLOAD_SIZE = 16777216
126 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
127 ; default state for the "minor edit" checkbox on the edit page form
129 ; The default, 604800, is one week (7 days)
130 MINOR_EDIT_TIMEOUT = 604800
132 ; Actions listed in this array will not be allowed. The complete list
133 ; of actions can be found in lib/main.php with the function
134 ; getActionDescription.
135 ; DISABLED_ACTIONS = "dumpserial : loadfile"
137 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
138 ; for you. If you want one, define this to the name of the log
139 ; file. The server must have write access to the directory specified.
140 ;ACCESS_LOG = /var/tmp/wiki_access_log
142 ; By default PhpWiki will try to have PHP compress its output
143 ; before sending it to the browser (if you have a recent enough
144 ; version of PHP and the browser supports it.)
145 ; Define COMPRESS_OUTPUT to false to prevent output compression.
146 ; Define COMPRESS_OUTPUT to true to force output compression,
147 ; even if we think your version of PHP does this in a buggy
149 ; Leave it undefined to leave the choice up to PhpWiki.
151 ; WARNING: Compressing the output has been reported to cause serious problems
152 ; when PHP is running as a CGI or on MacOSX.
153 ;COMPRESS_OUTPUT = false
155 ; This controls how PhpWiki sets the HTTP cache control
156 ; headers (Expires: and Cache-Control:)
160 ; NONE: This is roughly the old (pre 1.3.4) behavior. PhpWiki will
161 ; instruct proxies and browsers never to cache PhpWiki output.
163 ; STRICT: Cached pages will be invalidated whenever the database global
164 ; timestamp changes. This should behave just like NONE (modulo
165 ; bugs in PhpWiki and your proxies and browsers), except that
166 ; things will be slightly more efficient.
168 ; LOOSE: Cached pages will be invalidated whenever they are edited,
169 ; or, if the pages include plugins, when the plugin output could
170 ; concievably have changed.
172 ; Behavior should be much like STRICT, except that sometimes
173 ; wikilinks will show up as undefined (with the question mark)
174 ; when in fact they refer to (recently) created pages.
175 ; (Hitting your browsers reload or perhaps shift-reload button
176 ; should fix the problem.)
178 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
179 ; (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
181 ; This setting will result in quirky behavior. When you edit a
182 ; page your changes may not show up until you shift-reload the
185 ; This setting is generally not advisable, however it may be useful
186 ; in certain cases (e.g. if your wiki gets lots of page views,
187 ; and few edits by knowledgable people who won't freak over the quirks.)
189 ; The recommended default is currently LOOSE.
191 CACHE_CONTROL = LOOSE
193 ; Maximum page staleness, in seconds.
195 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
196 CACHE_CONTROL_MAX_AGE = 600
198 ; PhpWiki normally caches a preparsed version (i.e. mostly
199 ; converted to HTML) of the most recent version of each page.
200 ; (Parsing the wiki-markup takes a fair amount of CPU.)
202 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
203 ; caching of marked-up page content.
205 ; Note that you can also disable markup caching on a per-page
206 ; temporary basis by addinging a query arg of '?nocache=1'
207 ; to the URL to the page. (Use '?nocache=purge' to completely
208 ; discard the cached version of the page.)
210 ; You can also purge the cached markup globally by using the
211 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
212 ;WIKIDB_NOCACHE_MARKUP = true
214 ;======================================================================
215 ; Part Two: Database Selection
216 ;======================================================================
218 ; Select the database type:
220 ; SQL: access one of several SQL databases using the PEAR DB library.
221 ; ADODB: uses the ADODB library for data access.
222 ; dba: use one of the standard UNIX dbm libraries.
223 ; file: use a flat file database.
224 ; cvs: use a CVS server to store everything.
227 ; prefix for filenames or table names
229 ; Currently you MUST EDIT THE SQL file too (in the schemas/
230 ; directory because we aren't doing on the fly sql generation
231 ; during the installation.
232 ; Note: This prefix is NOT prepended to the default DBAUTH_
233 ; tables user, pref and member!
234 ;DATABASE_PREFIX = phpwiki_
236 ; For SQL based backends, specify the database as a DSN (Data Source Name),
237 ; a kind of URL for databases.
239 ; The most general form of a DSN looks like:
241 ; dbtype(dbsyntax)://username:password@protocol+hostspec/database
243 ; For a MySQL database, the following should work:
245 ; mysql://user:password@host/databasename
247 ; To connect over a unix socket, use something like
249 ; mysql://user:password@unix(/path/to/socket)/databasename
251 ; Valid values for dbtype are mysql, pgsql, or sqlite.
253 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
255 ; A table to store session information. Only needed by SQL backends.
257 ; A word of warning - any prefix defined above will be prepended to whatever
259 DATABASE_SESSION_TABLE = session
261 ; For the file and dba backends, this specifies where the data files will be
262 ; located. Ensure that the user that the webserver runs as has write access
265 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
266 ; you'll lose your wiki data at some stage.
267 DATABASE_DIRECTORY = /tmp
269 ; For the dba backend, this defines which DBA variant you wish to use.
270 ; gdbm - commonly available
271 ; db2 - Berkeley DB v2; not supported by modern versions of PHP
272 ; db3 - Berkeley DB v3; as per db2. The best on Windows
273 ; db4 - Berkeley DB v4; current version, however PHP has some issues
274 ; with it's db4 support.
275 ; dbm - Older dba handler; suffers from limits on the size of data
277 DATABASE_DBA_HANDLER = gdbm
279 ; How long will the system wait for a database operation to complete?
280 ; Specified in seconds.
281 DATABASE_TIMEOUT = 20
283 ; The login code now uses PHP's session support. Usually, the default
284 ; configuration of PHP is to store the session state information in
285 ; /tmp. That probably will work fine, but fails e.g. on clustered
286 ; servers where each server has their own distinct /tmp (this is the
287 ; case on SourceForge's project web server.) You can specify an
288 ; alternate directory in which to store state information like so
289 ; (whatever user your httpd runs as must have read/write permission
290 ; in this directory):
291 ;SESSION_SAVE_PATH = some_other_directory
293 ;========================================================================
294 ; Section 3a: Page revisions
296 ; The next section controls how many old revisions of each page are
297 ; kept in the database.
298 ;========================================================================
300 ; There are two basic classes of revisions: major and minor. Which
301 ; class a revision belongs in is determined by whether the author
302 ; checked the "this is a minor revision" checkbox when they saved the
305 ; There is, additionally, a third class of revisions: author
306 ; revisions. The most recent non-mergable revision from each distinct
307 ; author is an author revision.
309 ; The expiry parameters for each of those three classes of revisions
310 ; can be adjusted seperately. For each class there are five
311 ; parameters (usually, only two or three of the five are actually
312 ; set) which control how long those revisions are kept in the
315 ; MAX_KEEP: If set, this specifies an absolute maximum for the
316 ; number of archived revisions of that class. This is
317 ; meant to be used as a safety cap when a non-zero
318 ; min_age is specified. It should be set relatively high,
319 ; and it's purpose is to prevent malicious or accidental
320 ; database overflow due to someone causing an
321 ; unreasonable number of edits in a short period of time.
323 ; MIN_AGE: Revisions younger than this (based upon the supplanted
324 ; date) will be kept unless max_keep is exceeded. The age
325 ; should be specified in days. It should be a
326 ; non-negative, real number,
328 ; MIN_KEEP: At least this many revisions will be kept.
330 ; KEEP: No more than this many revisions will be kept.
332 ; MAX_AGE: No revision older than this age will be kept.
334 ; Definitions of terms used above:
336 ; Supplanted date: Revisions are timestamped at the instant that they
337 ; cease being the current revision. Revision age is computed using
338 ; this timestamp, not the edit time of the page.
340 ; Merging: When a minor revision is deleted, if the preceding
341 ; revision is by the same author, the minor revision is merged with
342 ; the preceding revision before it is deleted. Essentially: this
343 ; replaces the content (and supplanted timestamp) of the previous
344 ; revision with the content after the merged minor edit, the rest of
345 ; the page metadata for the preceding version (summary, mtime, ...)
348 ; Keep up to 8 major edits, but keep them no longer than a month.
352 ; Keep up to 4 minor edits, but keep them no longer than a week.
356 ; Keep the latest contributions of the last 8 authors up to a year.
357 ; Additionally, (in the case of a particularly active page) try to
358 ; keep the latest contributions of all authors in the last week (even
359 ; if there are more than eight of them,) but in no case keep more
360 ; than twenty unique author revisions.
366 ;========================================================================
367 ; Part Three: User Authentication
368 ;========================================================================
370 ; New user authentication configuration:
371 ; We support three basic authentication methods and a stacked array
372 ; of advanced auth methods to get and check the passwords:
374 ; ALLOW_ANON_USER default true
375 ; ALLOW_ANON_EDIT default true
376 ; ALLOW_BOGO_LOGIN default true
377 ; ALLOW_USER_PASSWORDS default true
379 ; allow anon users to view existing pages
380 ALLOW_ANON_USER = true
381 ; allow anon users to edit pages
382 ALLOW_ANON_EDIT = true
384 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
385 ; any/no password) using any userid which:
386 ; 1) is not the ADMIN_USER, and
387 ; 2) is a valid WikiWord (matches $WikiNameRegexp.)
388 ; If true, users may be created by themselves. Otherwise we need seperate auth.
389 ; If such a user will create a so called HomePage with his userid, he will
390 ; be able to store his preferences and password there.
391 ALLOW_BOGO_LOGIN = true
393 ; True User Authentication:
394 ; To require user passwords:
395 ; ALLOW_ANON_USER = false
396 ; ALLOW_ANON_EDIT = false
397 ; ALLOW_BOGO_LOGIN = false,
398 ; ALLOW_USER_PASSWORDS = true.
399 ; Otherwise any anon or bogo user might login without any or a wrong password.
400 ALLOW_USER_PASSWORDS = true
402 ; Many different methods can be used to check user's passwords:
403 ; BogoLogin: WikiWord username, with no *actual* password checking,
404 ; although the user will still have to enter one.
405 ; PersonalPage: Store passwords in the users homepage metadata (simple)
406 ; Db: Use DBAUTH_AUTH_* (see below) with PearDB or
408 ; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN
409 ; IMAP: Authenticate against IMAP_AUTH_HOST (email account)
410 ; POP3: Authenticate against POP3_AUTH_HOST (email account)
411 ; File: Store username:crypted-passwords in .htaccess like files.
412 ; Use Apache's htpasswd to manage this file.
413 ; HttpAuth: Use the protection by the webserver (.htaccess) or
416 ; Several of these methods can be used together, in the manner specified by
417 ; USER_AUTH_POLICY, below. To specify multiple authentication methods,
418 ; separate the name of each one with colons.
419 USER_AUTH_ORDER = "PersonalPage : Db"
421 ; For "security" purposes, you can specify that a password be at least a
422 ; certain number of characters long. This applies even to the BogoLogin
424 PASSWORD_LENGTH_MINIMUM = 2
426 ; The following policies are available for user authentication:
427 ; first-only: use only the first method in USER_AUTH_ORDER
428 ; old: ignore USER_AUTH_ORDER and try to use all available
429 ; methods as in the previous PhpWiki releases (slow)
430 ; strict: check if the user exists for all methods:
431 ; on the first existing user, try the password.
432 ; dont try the other methods on failure then
433 ; stacked: check the given user - password combination for all
434 ; methods and return true on the first success.
435 USER_AUTH_POLICY = stacked
437 ; LDAP authentication options:
439 ; The LDAP server to connect to. Can either be a hostname, or a complete
440 ; URL to the server (useful if you want to use ldaps or specify a different
442 ;LDAP_AUTH_HOST = "ldap://localhost:389"
444 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
446 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
447 ;LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
449 ; Some LDAP servers need some more options, such as the Windows Active
450 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
451 ; and their values as NAME=value pairs separated by colons.
452 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
454 ; DN to bind to the LDAP server as.
455 ; LDAP_AUTH_USER = "CN=ldapuser,CN=Users,DC=uai,DC=int"
457 ; Password to use to bind to the LDAP server, as the DN specified in
458 ; the LDAP_AUTH_USER option (above).
459 ; LDAP_AUTH_PASSWORD = secret
461 ; If you want to match usernames against an attribute other than uid,
463 ; LDAP_SEARCH_FIELD = sAMAccountName
465 ; IMAP authentication options:
467 ; The IMAP server to check usernames from. Defaults to localhost.
469 ; Some IMAP_AUTH_HOST samples:
470 ; "localhost", "localhost:143/imap/notls",
471 ; "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
472 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
474 ; POP3 authentication options:
476 ; Host to connect to.
477 ; POP3_AUTH_HOST = "localhost:110"
479 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
480 ; POP3_AUTH_PORT = 110
482 ; File authentication options:
484 ; File to read for authentication information.
485 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
486 ; AUTH_USER_FILE = /etc/shadow
488 ; Defines whether the user is able to change their own password via PHPWiki.
489 ; Note that this means that the webserver user must be able to write to the
490 ; file specified in AUTH_USER_FILE.
491 ; AUTH_USER_FILE_STORABLE = false
494 ; Name of the session variable which holds the already authenticated username.
495 ; Sample: "userid", "user[username]", "user->username"
496 ; AUTH_SESS_USER = userid
497 ; Which level will the user be? 1 = Bogo or 2 = Pass
498 ; AUTH_SESS_LEVEL = 2
500 ; Group membership. PHPWiki supports defining permissions for a group as
501 ; well as for individual users. This defines how group membership information
502 ; is obtained. Supported values are:
504 ; NONE group membership is not supported.
505 ; WIKIPAGE Defined in the metadata of a wiki page.
506 ; DB Stored in an ADODB or PearDB database.
508 ; LDAP Query LDAP to find the information.
509 GROUP_METHOD = WIKIPAGE
511 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
512 ; group membership information. It should be in the same format as the
513 ; standard unix /etc/groups(5) file.
514 ; AUTH_GROUP_FILE = /etc/groups
516 ; External database authentication and authorization.
518 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
519 ; below define the SQL queries used to obtain the information out of the
520 ; database, and (in some cases) store the information back to the DB.
522 ; The options appropriate for each query are currently undocumented, and
523 ; you should not be surprised if things change mightily in the future.
525 ; A database DSN to connect to. Defaults to the DSN specified for the Wiki
527 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
529 ; USER/PASSWORD queries
531 ; Check to see if the supplied username/password pair is OK
533 ; plaintext passwords:
534 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM user WHERE userid='$userid'"
536 ; database-hashed passwords (more secure):
537 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM user WHERE userid='$userid'"
538 DBAUTH_AUTH_CRYPT_METHOD = plain
540 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
541 ; to get the password out of the database with a simple SELECT query, and
542 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
543 ; DBAUTH_AUTH_CHECK = "SELECT passwd FROM user where userid='$userid'"
544 ; DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
545 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
547 ; Update the user's authentication credential. If this is not defined but
548 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
551 ; Plaintext passwords:
552 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd='$password' WHERE userid='$userid'"
553 ; Database-hashed passwords:
554 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd=PASSWORD('$password') WHERE userid='$userid'"
556 ; Allow the user to create their own account.
557 ; DBAUTH_AUTH_CREATE = "INSERT INTO user SET passwd=PASSWORD('$password'),userid='$userid'"
559 ; USER/PREFERENCE queries
561 ; If you choose to store your preferences in an external database, enable
562 ; the following queries. Note that if you choose to store user preferences
563 ; in the 'user' table, only registered users get their prefs from the database,
564 ; self-created users do not. Better to use the special 'pref' table.
566 ; The prefs field stores the serialized form of the user's preferences array,
567 ; to ease the complication of storage.
568 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM user WHERE userid='$userid'"
569 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM pref WHERE userid='$userid'"
571 ; Update the user's preferences
572 ; DBAUTH_PREF_UPDATE = "UPDATE user SET prefs='$pref_blob' WHERE userid='$userid'"
573 ; Note that REPLACE works only with mysql and destroy all other columns!
574 ; DBAUTH_PREF_UPDATE = "REPLACE INTO pref SET prefs='$pref_blob',userid='$userid'"
576 ; USERS/GROUPS queries
578 ; You can define 1:n or n:m user<=>group relations, as you wish.
580 ; Sample configurations:
581 ; only one group per user (1:n):
582 ; DBAUTH_IS_MEMBER = "SELECT user FROM user WHERE user='$userid' AND group='$groupname'"
583 ; DBAUTH_GROUP_MEMBERS = "SELECT user FROM user WHERE group='$groupname'"
584 ; DBAUTH_USER_GROUPS = "SELECT group FROM user WHERE user='$userid'"
585 ; multiple groups per user (n:m):
586 ; DBAUTH_IS_MEMBER = "SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'"
587 ; DBAUTH_GROUP_MEMBERS = "SELECT DISTINCT userid FROM member WHERE groupname='$groupname'"
588 ; DBAUTH_USER_GROUPS = "SELECT groupname FROM member WHERE userid='$userid'"
590 ; A interim page which gets displayed on every edit attempt
591 EDITING_POLICY = EditingPolicy
593 ;========================================================================
594 ; Part Four: Page appearance and layout
595 ;========================================================================
599 ; Most of the page appearance is controlled by files in the theme
602 ; There are a number of pre-defined themes shipped with PhpWiki.
603 ; Or you may create your own (e.g. by copying and then modifying one of
606 ; The complete list of installed themes can be found by doing 'ls themes/'
607 ; from the root of your PHPWiki installation.
618 ; Select a valid charset name to be inserted into the xml/html pages,
619 ; and to reference links to the stylesheets (css). For more info see:
620 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
621 ; has been extensively tested only with the latin1 (iso-8859-1)
624 ; If you change the default from iso-8859-1 PhpWiki may not work
625 ; properly and will require modifications in all existing pages.
626 ; At the very least you will have to convert the files in pgsrc
627 ; or locale/xx/pgsrc to match!
628 ; Currently we support utf-8 for zh, euc-jp for ja and iso-8859-1
629 ; for all other langs. Changing languages (UserPreferences) from one
630 ; charset to another will not work!
632 ; Character sets similar to iso-8859-1 may work with little or no
633 ; modification depending on your setup. The database must also
634 ; support the same charset, and of course the same is true for the
635 ; web browser. (Some work is in progress hopefully to allow more
636 ; flexibility in this area in the future).
639 ; Select your language/locale - default language is "en" for English.
640 ; Other languages available:
641 ; English "en" (English - HomePage)
642 ; Dutch "nl" (Nederlands - ThuisPagina)
643 ; Spanish "es" (Español - PáginaPrincipal)
644 ; French "fr" (Français - PageAccueil))
645 ; German "de" (Deutsch - StartSeite)
646 ; Swedish "sv" (Svenska - Framsida)
647 ; Italian "it" (Italiano - PaginaPrincipale)
648 ; Japanese "ja" (Japanese - ¥Û¡¼¥à¥Ú¡¼¥¸)
649 ; Chinese "zh" (Chinese - ?)
651 ; If you set DEFAULT_LANGUAGE to the empty string, your system's
652 ; default language (as determined by the applicable environment
653 ; variables) will be used.
654 ; Japanese requires euc-jp, Chinese utf-8
656 DEFAULT_LANGUAGE = en
658 ; WIKI_PGSRC -- specifies the source for the initial page contents of
659 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
660 ; accessed for the first time (or after clearing the database.)
661 ; WIKI_PGSRC can either name a directory or a zip file. In either case
662 ; WIKI_PGSRC is scanned for files -- one file per page.
665 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
666 ; default (English) and when reading from a directory: in that case
667 ; some English pages are inserted into the wiki as well.
668 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
670 ; FIXME: is this really needed? Can't we just copy these pages into
671 ; the localized pgsrc?
672 DEFAULT_WIKI_PGSRC = pgsrc
673 ; These are the pages which will get loaded from DEFAULT_WIKI_PGSRC.
674 DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
676 ;=========================================================================
677 ; Part Five: Mark-up options.
678 ;=========================================================================
680 ; allowed protocols for links - be careful not to allow "javascript:"
681 ; URL of these types will be automatically linked.
682 ; within a named link [name|uri] one more protocol is defined: phpwiki
683 ; Separate each of the protocol names with a vertical pipe, and ensure there
684 ; is no extraneous whitespace.
685 ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
687 ; URLs ending with the following extension should be inlined as images.
688 ; Specify as per ALLOWED_PROTOCOLS
689 INLINE_IMAGES = "png|jpg|gif"
691 ; Perl regexp for WikiNames ("bumpy words")
692 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
693 WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
695 ; Defaults to '/', but '.' was also used.
696 SUBPAGE_SEPARATOR = /
698 ; InterWiki linking -- wiki-style links to other wikis on the web
700 ; The map will be taken from a page name InterWikiMap.
701 ; If that page is not found (or is not locked), or map
702 ; data can not be found in it, then the file specified
703 ; by INTERWIKI_MAP_FILE (if any) will be used.
704 INTERWIKI_MAP_FILE = lib/interwiki.map
706 ; Display a warning if the internal lib/interwiki.map is used, and
707 ; not the public InterWikiMap page. This file is not readable from outside.
708 WARN_NONPUBLIC_INTERWIKIMAP = false
710 ; Regexp used for automatic keyword extraction.
712 ; Any links on a page to pages whose names match this regexp will
713 ; be used keywords in the keywords meta tag. (This is an aid to
714 ; classification by search engines.) The value of the match is
715 ; used as the keyword.
717 ; The default behavior is to match Category* and Topic* links.
718 KEYWORDS = "Category:Topic"
719 ;KEYWORD_LINK_REGEXP = "(?<=^\'. join(\'|^\', $keywords) . \')[[:upper:]].*$"
721 ; Author and Copyright Site Navigation Links
723 ; These will be inserted as <link rel> tags in the html header of
724 ; every page, for search engines and for browsers like Mozilla which
725 ; take advantage of link rel site navigation.
727 ; If you have your own copyright and contact information pages change
728 ; these as appropriate.
729 COPYRIGHTPAGE_TITLE = GNU General Public License
730 COPYRIGHTPAGE_URL = http://www.gnu.org/copyleft/gpl.html#SEC1
731 AUTHORPAGE_TITLE = The PhpWiki Programming Team
732 AUTHORPAGE_URL = http://phpwiki.sourceforge.net/phpwiki/ThePhpWikiProgrammingTeam
734 ; Allow full markup in headers to be parsed by the CreateToc plugin.
736 ; If false you may not use WikiWords or [] links or any other markup in
737 ; headers in pages with the CreateToc plugin. But if false the parsing is
738 ; faster and more stable.
739 TOC_FULL_SYNTAX = true
741 ;==========================================================================
742 ; Part Six: URL options.
743 ;==========================================================================
745 ; You can probably skip this section.
747 ; The following section contains settings which you can use to tailor
748 ; the URLs which PhpWiki generates.
750 ; Any of these parameters which are left undefined will be deduced
751 ; automatically. You need only set them explicitly if the
752 ; auto-detected values prove to be incorrect.
754 ; In most cases the auto-detected values should work fine, so
755 ; hopefully you don't need to mess with this section.
757 ; In case of local overrides of short placeholders, which themselves
758 ; include index.php, we check for most constants. See '/wiki'.
759 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki
760 ; versions (for development), but most likely other values like
761 ; THEME, LANG and DbParams for a WikiFarm.
763 ; Canonical name and httpd port of the server on which this PhpWiki
766 ;SERVER_NAME = some.host.com
769 ; Relative URL (from the server root) of the PhpWiki
771 ;SCRIPT_NAME = /some/where/index.php
773 ; URL of the PhpWiki install directory. (You only need to set this
774 ; if you've moved index.php out of the install directory.) This can
775 ; be either a relative URL (from the directory where the top-level
776 ; PhpWiki script is) or an absolute one.
777 ;DATA_PATH = /home/user/phpwiki
779 ; Path to the PhpWiki install directory. This is the local
780 ; filesystem counterpart to DATA_PATH. (If you have to set
781 ; DATA_PATH, your probably have to set this as well.) This can be
782 ; either an absolute path, or a relative path interpreted from the
783 ; directory where the top-level PhpWiki script (normally index.php)
785 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
787 ; PhpWiki will try to use short urls to pages, eg
788 ; http://www.example.com/index.php/HomePage
789 ; If you want to use urls like
790 ; http://www.example.com/index.php?pagename=HomePage
791 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
792 ; NB: If you are using Apache >= 2.0.30, then you may need to to use
793 ; the directive "AcceptPathInfo On" in your Apache configuration file
794 ; (or in an appropriate <.htaccess> file) for the short urls to work:
795 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
797 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
798 ; on prettifying your urls.
800 ; Note that Google doesn't follow the default /index.php/PageName links.
801 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
803 ; Default: PhpWiki will try to divine whether use of PATH_INFO
804 ; is supported in by your webserver/PHP configuration, and will
805 ; use PATH_INFO if it thinks that is possible.
806 ;USE_PATH_INFO = false
808 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
809 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
810 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
811 ; something different.
813 ; If you do this, you should set VIRTUAL_PATH here.
815 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
816 ; but * you've made it accessible through eg. /wiki/HomePage.
818 ; One way to do this is to create a directory named 'wiki' in your
819 ; server root. The directory contains only one file: an .htaccess
820 ; file which reads something like:
822 ; Action x-phpwiki-page /scripts/phpwiki/index.php
823 ; SetHandler x-phpwiki-page
824 ; DirectoryIndex /scripts/phpwiki/index.php
826 ; In that case you should set VIRTUAL_PATH to '/wiki'.
828 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
830 ;VIRTUAL_PATH = /SomeWiki
832 ;===========================================================================
833 ; Part Seven: Miscellaneous settings
834 ;===========================================================================
836 ; Disable HTTP redirects.
838 ; (You probably don't need to touch this.)
840 ; PhpWiki uses HTTP redirects for some of it's functionality.
841 ; (e.g. after saving changes, PhpWiki redirects your browser to
842 ; view the page you just saved.)
844 ; Some web service providers (notably free European Lycos) don't seem to
845 ; allow these redirects. (On Lycos the result in an "Internal Server Error"
846 ; report.) In that case you can set DISABLE_HTTP_REDIRECT to true.
847 ; (In which case, PhpWiki will revert to sneakier tricks to try to
848 ; redirect the browser...)
849 ;DISABLE_HTTP_REDIRECT = true
851 ; Enable random quotes from a fortune directory
852 ; when adding a new page.
853 ; Usually at /usr/share/fortune or /usr/share/games/fortune
854 ;FORTUNE_DIR = /usr/share/fortune