1 ; This is the main configuration file for PhpWiki.
2 ; Note that certain characters are used as comment char and therefore
3 ; these entries must be in double-quotes. Such as ":", ";", "," and "|"
5 ; <?php die(); ?> for security
7 ; This file is divided into eight parts.
8 ; Each one has different configuration settings you can
9 ; change; in all cases the default should work on your system,
10 ; however, we recommend you tailor things to your particular setting.
11 ; Here undefined definitions get defined by config-default.ini settings.
13 ;=========================================================================
14 ; Part Zero: Latest Development and Tricky Options
15 ;=========================================================================
17 ; If PHP needs help in finding where you installed the rest of the PhpWiki
18 ; code, you can set the include_path here.
20 ; Override PHP's include path so that it can find some needed additional libraries.
21 ; You shouldn't need to do this unless your system include_path esp. your
22 ; system pear libs are broken or oudated. The PHPWIKI_DIR is automatically
23 ; put to the front and the local lib/pear path is automatically added to the end.
24 ; But if you define it, be sure to include either the system pear path or
25 ; the phpwiki/lib/pear path to override your Pear_DB.
26 ; Note that on Windows-based servers, you should use ; rather than :
27 ; as the path separator.
28 ;INCLUDE_PATH = ".:/usr/local/httpd/phpwiki:/usr/share/pear"
30 ; Set DEBUG to 1 to view the XHTML and CSS validator icons, page
31 ; processing timer, and possibly other debugging messages at the
32 ; bottom of each page. 2 for a more verbose level. See lib/config.php.
36 ; Enable the new method of handling WikiUsers. This is currently an
37 ; experimental feature, although it is considered fairly stable. It's best
38 ; to leave it on, and only disable it if you have problems with it.
39 ; Servers with memory-limit problems might want to turn it off. It costs ~300KB
41 ;ENABLE_USER_NEW = false
43 ; I suspect ACL page permissions to degrade speed by 10%. Default: true
44 ;ENABLE_PAGEPERM = false
46 ; Graphical buttons on edit. Default: true
47 ;ENABLE_EDIT_TOOLBAR = false
49 ; Adds two additional buttons in EDIT_TOOLBAR, Search&Replace and Undo
51 ;JS_SEARCHREPLACE = true
54 ;ENABLE_DOUBLECLICKEDIT = false
56 ; Needed for inlined SVG and MathM, but may conflict with document.write().
57 ; Experimental. Default: false
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 ; Needs babycart installed. See http://phpwiki.org/SpamAssassinIntegration
66 ; Optionally define BABYCART_PATH. Default: /usr/local/bin/babycart
67 ;ENABLE_SPAMASSASSIN = true
69 ; If GOOGLE_LINKS_NOFOLLOW is true, ref=nofollow is added to
70 ; all external links to discourage spam. You might want to turn it off,
71 ; if you want to improve pageranks on external links.
72 ;GOOGLE_LINKS_NOFOLLOW = false
74 ; LiveSearch enables immediate title search results via XMLHttpRequest.
75 ; Displays the results in a dropdown under the titlesearch inputbox
76 ; while typing. (experimental, only with certain themes)
77 ; You'll have to copy livesearch.js from http://blog.bitflux.ch/wiki/LiveSearch
78 ; to themes/default/ and define ENABLE_LIVESEARCH in config.ini to true.
79 ; See themes/blog/themeinfo.php.
80 ; Currently we use the bitflux.ch library, but we will change to
81 ; the russian acdropdown soon. http://momche.net/publish/article.php?page=acdropdown
82 ;ENABLE_LIVESEARCH = true
84 ;==========================================================================
85 ; Part One: Authentication and security settings.
87 ; See Part Three for more.
88 ;==========================================================================
90 ; The name of your wiki.
92 ; This is used to generate a keywords meta tag in the HTML templates,
93 ; in bookmark titles for any bookmarks made to pages in your wiki,
94 ; and during RSS generation for the <title> of the RSS channel.
96 ; To use your own logo and signature files, name them PhpWikiLogo.png
97 ; and PhpWikiSignature.png and put them into themes/default/images
98 ; (substituting "PhpWiki" in the filename with the name you define
101 ; It is recommended this be a relatively short WikiWord like the
102 ; InterWiki monikers found in the InterWikiMap. (For examples, see
103 ; lib/interwiki.map).
106 ; Visitor Hostname Lookup
108 ; If set, reverse dns lookups will be performed to attempt to convert
109 ; the user's IP number into a host name, in the case where the http
110 ; server does not do this.
111 ENABLE_REVERSE_DNS = true
113 ; Username and password of administrator.
115 ; Set these to your preferences. For heaven's sake pick a good
116 ; password and use the passencrypt.php tool to encrypt the password from
118 ; http://wolfram.org/writing/howto/password.html
120 ; Logging into the wiki with the admin user and password allows you to lock,
121 ; unlock, or remove pages and to perform other PhpWikiAdministration
122 ; functions. On all other occasions you should simply log in with your
124 ; If your password contains special chars like ";" or ":" better quote it in double-quotes.
126 ; ADMIN_PASSWD is ignored on HttpAuth
129 ; Encrypted passwords are the default. It is recommended that you use the
130 ; passencrypt.php or the configurator.php utility to encode the admin
131 ; password, which provides added security in the event that someone gains
132 ; ftp or shell access to the server and directory containing phpwiki. To
133 ; use plain text passwords, in particular for the ADMIN_PASSWD, set
134 ; ENCRYPTED_PASSWD to false.
135 ENCRYPTED_PASSWD = true
137 ; Private ZIP Dumps of All Wiki Pages
139 ; If true, only the admin user can make zip dumps. Otherwise anyone
140 ; may download all wiki pages as a single zip archive.
143 ; The RawHtml plugin allows page authors to embed real, raw HTML into Wiki
144 ; pages. This is a possible security threat, as much HTML (or, rather,
145 ; JavaScript) can be very risky. If you are in a controlled environment,
146 ; however, it could be of use.
147 ENABLE_RAW_HTML = true
148 ; If this is set, only pages locked by the Administrator may contain the
150 ENABLE_RAW_HTML_LOCKEDONLY = true
151 ; If this is set, all unsafe html code is stripped automatically (experimental!)
152 ; See http://chxo.com/scripts/safe_html-test.php
153 ENABLE_RAW_HTML_SAFE = true
155 ; If you define this to true, (MIME-type) page-dumps (either zip dumps,
156 ; or "dumps to directory" will be encoded using the quoted-printable
157 ; encoding. If you're actually thinking of mailing the raw page dumps,
158 ; then this might be useful, since (among other things,) it ensures
159 ; that all lines in the message body are under 80 characters in length.
161 ; Also, setting this will cause a few additional mail headers
162 ; to be generated, so that the resulting dumps are valid
163 ; RFC 2822 e-mail messages.
165 ; Probably you can just leave this set to false, in which case you get
166 ; raw ('binary' content-encoding) page dumps.
167 STRICT_MAILABLE_PAGEDUMPS = false
169 ; Here you can change the default dump directories.
170 ; (Can be overridden by the directory argument)
171 DEFAULT_DUMP_DIR = /tmp/wikidump
172 HTML_DUMP_DIR = /tmp/wikidumphtml
173 ; Filename suffix used for XHTML page dumps.
174 ; If you don't want any suffix just comment this out.
175 HTML_DUMP_SUFFIX = .html
177 ; The maximum file upload size, in bytes.
178 ; The default, 16777216, is 16MB.
179 MAX_UPLOAD_SIZE = 16777216
181 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
182 ; default state for the "minor edit" checkbox on the edit page form
184 ; The default, 604800, is one week (7 days)
185 MINOR_EDIT_TIMEOUT = 604800
187 ; Actions listed in this array will not be allowed. The complete list
188 ; of actions can be found in lib/main.php with the function
189 ; getActionDescription.
190 ; DISABLED_ACTIONS = "dumpserial : loadfile"
192 ; If you enable this option every page is moderated by the ModeratedPage
193 ; action page plugin. Changing a moderated page will be delayed to be
194 ; granted by a moderator by email.
195 ; ENABLE_MODERATEDPAGE_ALL = true
197 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
198 ; for you. If you want one, define this to the name of the log
199 ; file. The server must have write access to the directory specified.
200 ; Note that even you define ACCESS_LOG_SQL logs are written to this file also.
201 ;ACCESS_LOG = /var/tmp/wiki_access_log
203 ; PhpWiki can read and/or write mod_log_sql accesslog tables for faster
204 ; abuse detection and referer lists.
205 ; If defined (e.g. 1) read-access is done via SQL.
206 ; If flag 2 is set, phpwiki also writes. (Default on SQL or ADODB)
207 ; This must use DATABASE_TYPE = SQL or ADODB
208 ;ACCESS_LOG_SQL = 1 ; phpwiki reads, apache mod_log_sql writes
209 ;ACCESS_LOG_SQL = 2 ; read + write
211 ; By default PhpWiki will try to have PHP compress its output
212 ; before sending it to the browser, if you have a recent enough
213 ; version of PHP and the browser and action supports it.
214 ; Define COMPRESS_OUTPUT to false to prevent output compression.
215 ; Define COMPRESS_OUTPUT to true to force output compression,
216 ; even if we think your version of PHP does this in a buggy
218 ; Leave it undefined to leave the choice up to PhpWiki. (Recommended)
220 ; WARNING: Compressing the output has been reported to cause problems
221 ; when PHP is running on MacOSX or on redirected requests.
222 ; This setting should now be correctly determined automatically.
223 ;COMPRESS_OUTPUT = false
225 ; This controls how PhpWiki sets the HTTP cache control
226 ; headers (Expires: and Cache-Control:)
230 ; NO_CACHE: This is roughly the old (pre 1.3.4) behavior. PhpWiki will
231 ; instruct proxies and browsers never to cache PhpWiki output.
232 ; This was previously called 'NONE', but NONE was treated specially
233 ; by parse_ini_config().
235 ; STRICT: Cached pages will be invalidated whenever the database global
236 ; timestamp changes. This should behave just like NO_CACHE (modulo
237 ; bugs in PhpWiki and your proxies and browsers), except that
238 ; things will be slightly more efficient.
240 ; LOOSE: Cached pages will be invalidated whenever they are edited,
241 ; or, if the pages include plugins, when the plugin output could
242 ; concievably have changed.
244 ; Behavior should be much like STRICT, except that sometimes
245 ; wikilinks will show up as undefined (with the question mark)
246 ; when in fact they refer to (recently) created pages.
247 ; (Hitting your browsers reload or perhaps shift-reload button
248 ; should fix the problem.)
250 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
251 ; (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
253 ; This setting will result in quirky behavior. When you edit a
254 ; page your changes may not show up until you shift-reload the
257 ; This setting is generally not advisable, however it may be useful
258 ; in certain cases (e.g. if your wiki gets lots of page views,
259 ; and few edits by knowledgable people who won't freak over the quirks.)
261 ; The recommended default is currently LOOSE.
263 CACHE_CONTROL = LOOSE
265 ; Maximum page staleness, in seconds.
267 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
268 CACHE_CONTROL_MAX_AGE = 600
270 ; PhpWiki normally caches a preparsed version (i.e. mostly
271 ; converted to HTML) of the most recent version of each page.
272 ; (Parsing the wiki-markup takes a fair amount of CPU.)
273 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
274 ; caching of marked-up page content.
275 ; Note that you can also disable markup caching on a per-page
276 ; temporary basis by addinging a query arg of '?nocache=1'
277 ; to the URL to the page or by adding a NoCache plugin line.
278 ; Use '?nocache=purge' to completely discard the cached version of the page.
279 ; You can also purge the cached markup globally by using the
280 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
281 ; Enable only for old php's with low memory or memory_limit=8MB.
283 ;WIKIDB_NOCACHE_MARKUP = true
285 COOKIE_EXPIRATION_DAYS = 365
286 ; Default path for the wikiuser cookie. You need to specify this more explicitly
287 ; if you want to enable different users on different wikis on the same host.
290 ;======================================================================
291 ; Part Two: Database Selection
292 ;======================================================================
294 ; Select the database type:
296 ; SQL: access one of several SQL databases using the PEAR DB library.
297 ; ADODB: uses the ADODB library for data access. (most general)
298 ; dba: use one of the standard UNIX dbm libraries. (fastest)
299 ; file: use a flat file database. (easiest)
300 ; cvs: use a CVS server to store everything. (experimental, not recommended)
303 ; prefix for filenames or table names
305 ; Currently you MUST EDIT THE SQL file too (in the schemas/
306 ; directory because we aren't doing on the fly sql generation
307 ; during the installation.
308 ; Note: This prefix is NOT prepended to the default DBAUTH_
309 ; tables user, pref and member!
310 ;DATABASE_PREFIX = phpwiki_
312 ; For SQL based backends, specify the database as a DSN (Data Source Name),
313 ; a kind of URL for databases.
315 ; The most general form of a DSN looks like:
317 ; dbtype(dbsyntax)://username:password@protocol+hostspec/database?option=value&option2=value2
319 ; For a MySQL database, the following should work:
321 ; mysql://user:password@host/databasename
323 ; To connect over a unix socket, use something like
325 ; mysql://user:password@unix(/path/to/socket)/databasename
327 ; Valid values for dbtype are mysql, pgsql, or sqlite.
329 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
331 ; Keep persistent connections: (mysql_pconnect, ...)
332 ; Recommended is false for bigger servers, and true for small servers
333 ; with not so many connections. postgresql: Please leave it false. Default: false
334 ; Should really be set as database option in the DSN above.
335 DATABASE_PERSISTENT = false
337 ; A table to store session information. Only needed by SQL backends.
339 ; A word of warning - any prefix defined above will be prepended to whatever
341 DATABASE_SESSION_TABLE = session
343 ; For the file and dba backends, this specifies where the data files will be
344 ; located. Ensure that the user that the webserver runs as has write access
347 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
348 ; you'll lose your wiki data at some stage.
349 DATABASE_DIRECTORY = /tmp
351 ; For the dba backend, this defines which DBA variant you wish to use.
352 ; gdbm - commonly available, Fedora not
353 ; db2 - Berkeley DB v2; not supported by modern versions of PHP
354 ; db3 - Berkeley DB v3; as per db2. The best on Windows
355 ; db4 - Berkeley DB v4; current version, however PHP has some issues
356 ; with it's db4 support.
357 ; dbm - Older dba handler; suffers from limits on the size of data
359 DATABASE_DBA_HANDLER = gdbm
361 ; How long will the system wait for a database operation to complete?
362 ; Specified in seconds.
365 ; If action=upgrade detects mysql problems, but has no ALTER permissions,
366 ; give here a user which has the necessary ALTER or CREATE permissions.
367 ; Of course you can fix your database manually. See lib/upgrade.php for known issues.
369 ;DBADMIN_PASSWD = secret
371 ; The login code now uses PHP's session support. Usually, the default
372 ; configuration of PHP is to store the session state information in
373 ; /tmp. That probably will work fine, but fails e.g. on clustered
374 ; servers where each server has their own distinct /tmp (this is the
375 ; case on SourceForge's project web server.) You can specify an
376 ; alternate directory in which to store state information like so
377 ; (whatever user your httpd runs as must have read/write permission
378 ; in this directory):
379 ;SESSION_SAVE_PATH = some_other_directory
381 ;========================================================================
382 ; Section 3a: Page revisions
384 ; The next section controls how many old revisions of each page are
385 ; kept in the database.
386 ;========================================================================
388 ; There are two basic classes of revisions: major and minor. Which
389 ; class a revision belongs in is determined by whether the author
390 ; checked the "this is a minor revision" checkbox when they saved the
393 ; There is, additionally, a third class of revisions: author
394 ; revisions. The most recent non-mergable revision from each distinct
395 ; author is an author revision.
397 ; The expiry parameters for each of those three classes of revisions
398 ; can be adjusted seperately. For each class there are five
399 ; parameters (usually, only two or three of the five are actually
400 ; set) which control how long those revisions are kept in the
403 ; MAX_KEEP: If set, this specifies an absolute maximum for the
404 ; number of archived revisions of that class. This is
405 ; meant to be used as a safety cap when a non-zero
406 ; min_age is specified. It should be set relatively high,
407 ; and it's purpose is to prevent malicious or accidental
408 ; database overflow due to someone causing an
409 ; unreasonable number of edits in a short period of time.
411 ; MIN_AGE: Revisions younger than this (based upon the supplanted
412 ; date) will be kept unless max_keep is exceeded. The age
413 ; should be specified in days. It should be a
414 ; non-negative, real number,
416 ; MIN_KEEP: At least this many revisions will be kept.
418 ; KEEP: No more than this many revisions will be kept.
420 ; MAX_AGE: No revision older than this age will be kept.
422 ; Definitions of terms used above:
424 ; Supplanted date: Revisions are timestamped at the instant that they
425 ; cease being the current revision. Revision age is computed using
426 ; this timestamp, not the edit time of the page.
428 ; Merging: When a minor revision is deleted, if the preceding
429 ; revision is by the same author, the minor revision is merged with
430 ; the preceding revision before it is deleted. Essentially: this
431 ; replaces the content (and supplanted timestamp) of the previous
432 ; revision with the content after the merged minor edit, the rest of
433 ; the page metadata for the preceding version (summary, mtime, ...)
436 ; Keep up to 8 major edits, but keep them no longer than a month.
440 ; Keep up to 4 minor edits, but keep them no longer than a week.
444 ; Keep the latest contributions of the last 8 authors up to a year.
445 ; Additionally, (in the case of a particularly active page) try to
446 ; keep the latest contributions of all authors in the last week (even
447 ; if there are more than eight of them,) but in no case keep more
448 ; than twenty unique author revisions.
454 ;========================================================================
455 ; Part Three: User Authentication
456 ;========================================================================
458 ; New user authentication configuration:
459 ; We support three basic authentication methods and a stacked array
460 ; of advanced auth methods to get and check the passwords:
462 ; ALLOW_ANON_USER default true
463 ; ALLOW_ANON_EDIT default true
464 ; ALLOW_BOGO_LOGIN default true
465 ; ALLOW_USER_PASSWORDS default true
467 ; allow anon users to view existing pages
468 ALLOW_ANON_USER = true
469 ; allow anon users to edit pages
470 ALLOW_ANON_EDIT = true
472 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
473 ; any/no password) using any userid which:
474 ; 1) is not the ADMIN_USER, and
475 ; 2) is a valid WikiWord (matches $WikiNameRegexp.)
476 ; If true, users may be created by themselves. Otherwise we need seperate auth.
477 ; If such a user will create a so called HomePage with his userid, he will
478 ; be able to store his preferences and password there.
479 ALLOW_BOGO_LOGIN = true
481 ; True User Authentication:
482 ; To require user passwords:
483 ; ALLOW_ANON_USER = false
484 ; ALLOW_ANON_EDIT = false
485 ; ALLOW_BOGO_LOGIN = false,
486 ; ALLOW_USER_PASSWORDS = true.
487 ; Otherwise any anon or bogo user might login without any or a wrong password.
488 ALLOW_USER_PASSWORDS = true
490 ; Many different methods can be used to check user's passwords:
491 ; BogoLogin: WikiWord username, with no *actual* password checking,
492 ; although the user will still have to enter one.
493 ; PersonalPage: Store passwords in the users homepage metadata (simple)
494 ; Db: Use DBAUTH_AUTH_* (see below) with PearDB or
496 ; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN (experimental)
497 ; IMAP: Authenticate against IMAP_AUTH_HOST (email account)
498 ; POP3: Authenticate against POP3_AUTH_HOST (email account)
499 ; File: Store username:crypted-passwords in .htaccess like files.
500 ; Use Apache's htpasswd to manage this file.
501 ; HttpAuth: Use the protection by the webserver (.htaccess/.htpasswd)
502 ; Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also.
503 ; Using HttpAuth disables all other methods and no userauth sessions are used.
505 ; Several of these methods can be used together, in the manner specified by
506 ; USER_AUTH_POLICY, below. To specify multiple authentication methods,
507 ; separate the name of each one with colons.
508 ;USER_AUTH_ORDER = "PersonalPage : Db"
509 ;USER_AUTH_ORDER = "BogoLogin : PersonalPage"
511 ; For "security" purposes, you can specify that a password be at least a
512 ; certain number of characters long. This applies even to the BogoLogin
513 ; method. Default: 0 (to allow immediate passwordless BogoLogin)
514 ;PASSWORD_LENGTH_MINIMUM = 6
516 ; The following policies are available for user authentication:
517 ; first-only: use only the first method in USER_AUTH_ORDER
518 ; old: ignore USER_AUTH_ORDER and try to use all available
519 ; methods as in the previous PhpWiki releases (slow)
520 ; strict: check if the user exists for all methods:
521 ; on the first existing user, try the password.
522 ; dont try the other methods on failure then
523 ; stacked: check the given user - password combination for all
524 ; methods and return true on the first success.
525 USER_AUTH_POLICY = stacked
527 ; LDAP authentication options:
529 ; The LDAP server to connect to. Can either be a hostname, or a complete
530 ; URL to the server (useful if you want to use ldaps or specify a different
532 ;LDAP_AUTH_HOST = "ldap://localhost:389"
534 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
536 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
537 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
538 ;LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
540 ; Some LDAP servers need some more options, such as the Windows Active
541 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
542 ; and their values as NAME=value pairs separated by colons.
543 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
545 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
546 ; allow anonymous queries. (Windows Active Directory Server)
547 ; LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com"
549 ; Password to use to initially bind to the LDAP server, as the DN
550 ; specified in the LDAP_AUTH_USER option (above).
551 ; LDAP_AUTH_PASSWORD = secret
553 ; If you want to match usernames against an attribute other than uid,
554 ; specify it here. Default: uid
555 ; LDAP_SEARCH_FIELD = sAMAccountName
557 ; If you have an organizational unit for all users, define it here.
558 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
560 ; LDAP_OU_USERS = ou=Users
562 ; If you have an organizational unit for all groups, define it here.
563 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
564 ; The entries in this ou must have a gidNumber and cn attribute.
566 ; LDAP_OU_GROUP = ou=Groups
569 ; IMAP authentication options:
571 ; The IMAP server to check usernames from. Defaults to localhost.
573 ; Some IMAP_AUTH_HOST samples:
574 ; "localhost", "localhost:143/imap/notls",
575 ; "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
576 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
578 ; POP3 authentication options:
580 ; Host to connect to.
581 ; POP3_AUTH_HOST = "localhost:110"
583 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
584 ; POP3_AUTH_PORT = 110
586 ; File authentication options:
588 ; File to read for authentication information.
589 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
590 ; AUTH_USER_FILE = /etc/shadow
592 ; Defines whether the user is able to change their own password via PHPWiki.
593 ; Note that this means that the webserver user must be able to write to the
594 ; file specified in AUTH_USER_FILE.
595 ; AUTH_USER_FILE_STORABLE = false
598 ; Name of the session variable which holds the already authenticated username.
599 ; Sample: "userid", "user[username]", "user->username"
600 ; AUTH_SESS_USER = userid
601 ; Which level will the user be? 1 = Bogo or 2 = Pass
602 ; AUTH_SESS_LEVEL = 2
604 ; Group membership. PhpWiki supports defining permissions for a group as
605 ; well as for individual users. This defines how group membership information
606 ; is obtained. Supported values are:
608 ; "NONE" Disable group membership (Fastest). Note the required quoting.
609 ; WIKIPAGE Define groups as list at "CategoryGroup". (Slowest, but easiest to maintain)
610 ; DB Stored in an SQL database. Optionally external. See USERS/GROUPS queries
611 ; FILE Flatfile. See AUTH_GROUP_FILE below.
612 ; LDAP LDAP groups. See "LDAP authentication options" above and
613 ; lib/WikiGroup.php. (experimental)
614 GROUP_METHOD = WIKIPAGE
616 ; Page where all groups are listed. Default: Translation of "CategoryGroup"
617 ; CATEGORY_GROUP_PAGE = CategoryGroup
619 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
620 ; group membership information. It should be in the same format as the
621 ; standard unix /etc/groups(5) file.
622 ; AUTH_GROUP_FILE = /etc/groups
624 ; External database authentication and authorization.
626 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
627 ; below define the SQL queries used to obtain the information out of the
628 ; database, and (in some cases) store the information back to the DB.
630 ; The options appropriate for each query are currently undocumented, and
631 ; you should not be surprised if things change mightily in the future.
633 ; A database DSN to connect to. Defaults to the DSN specified for the Wiki
635 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
637 ; USER/PASSWORD queries
639 ; For USER_AUTH_POLICY=strict and the Db method this is required:
640 ; DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
642 ; Check to see if the supplied username/password pair is OK
644 ; plaintext passwords:
645 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM user WHERE userid='$userid'"
647 ; database-hashed passwords (more secure):
648 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM user WHERE userid='$userid'"
649 DBAUTH_AUTH_CRYPT_METHOD = plain
651 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
652 ; to get the password out of the database with a simple SELECT query, and
653 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
654 ; DBAUTH_AUTH_CHECK = "SELECT passwd FROM user where userid='$userid'"
655 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
657 ; Update the user's authentication credential. If this is not defined but
658 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
661 ; Plaintext passwords:
662 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd='$password' WHERE userid='$userid'"
663 ; Database-hashed passwords:
664 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd=PASSWORD('$password') WHERE userid='$userid'"
666 ; Allow the user to create their own account.
667 ; DBAUTH_AUTH_CREATE = "INSERT INTO user SET passwd=PASSWORD('$password'),userid='$userid'"
669 ; USER/PREFERENCE queries
671 ; If you choose to store your preferences in an external database, enable
672 ; the following queries. Note that if you choose to store user preferences
673 ; in the 'user' table, only registered users get their prefs from the database,
674 ; self-created users do not. Better to use the special 'pref' table.
676 ; The prefs field stores the serialized form of the user's preferences array,
677 ; to ease the complication of storage.
678 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM user WHERE userid='$userid'"
679 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM pref WHERE userid='$userid'"
681 ; Update the user's preferences
682 ; DBAUTH_PREF_UPDATE = "UPDATE user SET prefs='$pref_blob' WHERE userid='$userid'"
683 ; Note that REPLACE works only with mysql and destroy all other columns!
684 ; DBAUTH_PREF_UPDATE = "REPLACE INTO pref SET prefs='$pref_blob',userid='$userid'"
686 ; USERS/GROUPS queries
688 ; You can define 1:n or n:m user<=>group relations, as you wish.
690 ; Sample configurations:
691 ; only one group per user (1:n):
692 ; DBAUTH_IS_MEMBER = "SELECT user FROM user WHERE user='$userid' AND group='$groupname'"
693 ; DBAUTH_GROUP_MEMBERS = "SELECT user FROM user WHERE group='$groupname'"
694 ; DBAUTH_USER_GROUPS = "SELECT group FROM user WHERE user='$userid'"
695 ; multiple groups per user (n:m):
696 ; DBAUTH_IS_MEMBER = "SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'"
697 ; DBAUTH_GROUP_MEMBERS = "SELECT DISTINCT userid FROM member WHERE groupname='$groupname'"
698 ; DBAUTH_USER_GROUPS = "SELECT groupname FROM member WHERE userid='$userid'"
700 ; A interim page which gets displayed on every edit attempt, if it exists.
701 ;EDITING_POLICY = EditingPolicy
703 ;========================================================================
704 ; Part Four: Page appearance and layout
705 ;========================================================================
709 ; Most of the page appearance is controlled by files in the theme
712 ; There are a number of pre-defined themes shipped with PhpWiki.
713 ; Or you may create your own (e.g. by copying and then modifying one of
716 ; The complete list of installed themes can be found by doing 'ls themes/'
717 ; from the root of your PHPWiki installation.
718 ; white on yellow with fat blue links:
720 ; almost fully iconized classic grey MacOSX design:
722 ; as default, just some tricks to make the buttons smaller:
724 ; the popular Wordpress layout:
726 ; pure old-style c2wiki layout:
728 ; random heavy images:
730 ; example with some sidebar boxes:
732 ; mozilla friendly, with lots of icons instead of buttons (i18n friendly):
736 ; default + rateit navbar:
738 ; blogger style, rounded:
742 ; heavy space-y layout:
745 ; Select a valid charset name to be inserted into the xml/html pages,
746 ; and to reference links to the stylesheets (css). For more info see:
747 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
748 ; has been extensively tested only with the latin1 (iso-8859-1)
751 ; If you change the default from iso-8859-1 PhpWiki may not work
752 ; properly and will require modifications in all existing pages.
753 ; At the very least you will have to convert the files in pgsrc
754 ; or locale/xx/pgsrc to match!
755 ; Currently we support utf-8 for zh and ja, euc-jp for ja (not enabled)
756 ; and iso-8859-1 for all other langs. Changing languages (UserPreferences)
757 ; from one charset to another will not work!
759 ; Character sets similar to iso-8859-1 may work with little or no
760 ; modification depending on your setup. The database must also
761 ; support the same charset, and of course the same is true for the
762 ; web browser. (Some work is in progress hopefully to allow more
763 ; flexibility in this area in the future).
766 ; Select your language/locale - Default language is "" for auto-detected.
767 ; Available languages:
768 ; English "en" (English - HomePage)
769 ; Dutch "nl" (Nederlands - ThuisPagina)
770 ; Spanish "es" (Español - PáginaPrincipal)
771 ; French "fr" (Français - PageAccueil))
772 ; German "de" (Deutsch - StartSeite)
773 ; Swedish "sv" (Svenska - Framsida)
774 ; Italian "it" (Italiano - PaginaPrincipale)
775 ; Japanese "ja" (Japanese - ¥Û¡¼¥à ¥Ú¡¼¥¸)
776 ; Chinese "zh" (Chinese - ?)
778 ; If you set DEFAULT_LANGUAGE to the empty string, the users
779 ; preferred language as determined by the browser setting will be used.
780 ; Japanese requires CHARSET=euc-jp or utf-8 (not yet safe), Chinese CHARSET=utf-8
781 ;DEFAULT_LANGUAGE = en
783 ; WIKI_PGSRC -- specifies the source for the initial page contents of
784 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
785 ; accessed for the first time (or after clearing the database.)
786 ; WIKI_PGSRC can either name a directory or a zip file. In either case
787 ; WIKI_PGSRC is scanned for files -- one file per page.
790 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
791 ; default (English) and when reading from a directory: in that case
792 ; some English pages are inserted into the wiki as well.
793 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
794 ;DEFAULT_WIKI_PGSRC = pgsrc
795 ; These are ':'-seperated pages which will get loaded untranslated from DEFAULT_WIKI_PGSRC.
796 ;DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
798 ;=========================================================================
799 ; Part Five: Mark-up options.
800 ;=========================================================================
802 ; allowed protocols for links - be careful not to allow "javascript:"
803 ; URL of these types will be automatically linked.
804 ; within a named link [name|uri] one more protocol is defined: phpwiki
805 ; Separate each of the protocol names with a vertical pipe, and ensure there
806 ; is no extraneous whitespace.
807 ;ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
809 ; URLs ending with the following extension should be inlined as images.
810 ; Specify as per ALLOWED_PROTOCOLS
811 ;INLINE_IMAGES = "png|jpg|gif"
813 ; Perl regexp for WikiNames ("bumpy words")
814 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
815 ;WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
817 ; Defaults to '/', but '.' was also used.
818 ;SUBPAGE_SEPARATOR = /
820 ; InterWiki linking -- wiki-style links to other wikis on the web
822 ; The map will be taken from a page name InterWikiMap.
823 ; If that page is not found (or is not locked), or map
824 ; data can not be found in it, then the file specified
825 ; by INTERWIKI_MAP_FILE (if any) will be used.
826 ;INTERWIKI_MAP_FILE = lib/interwiki.map
828 ; Display a warning if the internal lib/interwiki.map is used, and
829 ; not the public InterWikiMap page. This file is not readable from outside.
830 ;WARN_NONPUBLIC_INTERWIKIMAP = false
832 ; Search term used for automatic page classification by keyword extraction.
834 ; Any links on a page to pages whose names match this search
835 ; will be used keywords in the keywords html meta tag. This is an aid to
836 ; classification by search engines. The value of the match is
837 ; used as the keyword.
839 ; The default behavior is to match Category* or Topic* links.
840 ;KEYWORDS = "Category* OR Topic*"
842 ; Author and Copyright Site Navigation Links
844 ; These will be inserted as <link rel> tags in the html header of
845 ; every page, for search engines and for browsers like Mozilla which
846 ; take advantage of link rel site navigation.
848 ; If you have your own copyright and contact information pages change
849 ; these as appropriate.
850 ;COPYRIGHTPAGE_TITLE = "GNU General Public License"
851 ;COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/gpl.html#SEC1"
852 ; Other useful alternatives to consider:
853 ; COPYRIGHTPAGE_TITLE = "GNU Free Documentation License"
854 ; COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/fdl.html"
855 ; COPYRIGHTPAGE_TITLE = "Creative Commons License 2.0"
856 ; COPYRIGHTPAGE_URL = "http://creativecommons.org/licenses/by/2.0/"
857 ; see http://creativecommons.org/learn/licenses/ for variations
858 ;AUTHORPAGE_TITLE = The PhpWiki Programming Team
859 ;AUTHORPAGE_URL = http://phpwiki.org/ThePhpWikiProgrammingTeam
861 ; Allow full markup in headers to be parsed by the CreateToc plugin.
863 ; If false you may not use WikiWords or [] links or any other markup in
864 ; headers in pages with the CreateToc plugin. But if false the parsing is
865 ; faster and more stable.
866 ;TOC_FULL_SYNTAX = true
868 ;==========================================================================
869 ; Part Six: URL options.
870 ;==========================================================================
872 ; You can probably skip this section.
874 ; The following section contains settings which you can use to tailor
875 ; the URLs which PhpWiki generates.
877 ; Any of these parameters which are left undefined will be deduced
878 ; automatically. You need only set them explicitly if the
879 ; auto-detected values prove to be incorrect.
881 ; In most cases the auto-detected values should work fine, so
882 ; hopefully you don't need to mess with this section.
884 ; In case of local overrides of short placeholders, which themselves
885 ; include index.php, we check for most constants. See '/wiki'.
886 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki
887 ; versions (for development), but most likely other values like
888 ; THEME, LANG and DbParams for a WikiFarm.
890 ; Canonical name and httpd port of the server on which this PhpWiki
893 ;SERVER_NAME = some.host.com
896 ; Relative URL (from the server root) of the PhpWiki
898 ;SCRIPT_NAME = /some/where/index.php
900 ; URL of the PhpWiki install directory. (You only need to set this
901 ; if you've moved index.php out of the install directory.) This can
902 ; be either a relative URL (from the directory where the top-level
903 ; PhpWiki script is) or an absolute one.
904 ;DATA_PATH = /home/user/phpwiki
906 ; Path to the PhpWiki install directory. This is the local
907 ; filesystem counterpart to DATA_PATH. (If you have to set
908 ; DATA_PATH, your probably have to set this as well.) This can be
909 ; either an absolute path, or a relative path interpreted from the
910 ; directory where the top-level PhpWiki script (normally index.php)
912 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
914 ; PhpWiki will try to use short urls to pages, eg
915 ; http://www.example.com/index.php/HomePage
916 ; If you want to use urls like
917 ; http://www.example.com/index.php?pagename=HomePage
918 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
919 ; NB: If you are using Apache >= 2.0.30, then you may need to to use
920 ; the directive "AcceptPathInfo On" in your Apache configuration file
921 ; (or in an appropriate <.htaccess> file) for the short urls to work:
922 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
924 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
925 ; on prettifying your urls.
927 ; Note that Google doesn't follow the default /index.php/PageName links.
928 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
930 ; Default: PhpWiki will try to divine whether use of PATH_INFO
931 ; is supported in by your webserver/PHP configuration, and will
932 ; use PATH_INFO if it thinks that is possible.
933 ;USE_PATH_INFO = false
935 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
936 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
937 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
938 ; something different.
940 ; If you do this, you should set VIRTUAL_PATH here.
942 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
943 ; but * you've made it accessible through eg. /wiki/HomePage.
945 ; One way to do this is to create a directory named 'wiki' in your
946 ; server root. The directory contains only one file: an .htaccess
947 ; file which reads something like:
949 ; Action x-phpwiki-page /scripts/phpwiki/index.php
950 ; SetHandler x-phpwiki-page
951 ; DirectoryIndex /scripts/phpwiki/index.php
953 ; In that case you should set VIRTUAL_PATH to '/wiki'.
955 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
957 ;VIRTUAL_PATH = /SomeWiki
959 ; In case your system has no idea about /tmp, TEMP or TMPDIR,
960 ; better provide it here. E.g. needed for zipdumps.
963 ;===========================================================================
964 ; Part Seven: Miscellaneous settings
965 ;===========================================================================
967 ; Disable HTTP redirects.
968 ; (You probably don't need to touch this.)
970 ; PhpWiki uses HTTP redirects for some of it's functionality.
971 ; (e.g. after saving changes, PhpWiki redirects your browser to
972 ; view the page you just saved.)
973 ; Some web service providers (notably free European Lycos) don't seem to
974 ; allow these redirects. (On Lycos the result in an "Internal Server Error"
975 ; report.) In that case you can set DISABLE_HTTP_REDIRECT to true.
976 ; (In which case, PhpWiki will revert to sneakier tricks to try to
977 ; redirect the browser...)
978 ;DISABLE_HTTP_REDIRECT = true
980 ; Enable random quotes from a fortune directory when adding a new page.
981 ; Usually at /usr/share/fortune or /usr/share/games/fortune
982 ; If empty no quotes are inserted.
983 ;FORTUNE_DIR = /usr/share/fortune
985 ; If you get a crash at loading LinkIcons you might want to disable
986 ; the getimagesize() function, which crashes on certain php versions and
987 ; and some external images (png's, ..).
988 ; getimagesize() is only needed for spam prevention.
989 ;DISABLE_GETIMAGESIZE = true
991 ; Experimental: For using the Google API
992 ;GOOGLE_LICENSE_KEY = "..."
994 ; Optional: administrative SQL DB access (for action=upgrade)
998 ; Optional: external PDF executable, %s is the xhtml filename
999 ;USE_EXTERNAL_HTML2PDF = "htmldoc --quiet --format pdf14 --no-toc --no-title %s"
1001 ; Optional: SPAMASSASSIN wrapper. Only used if ENABLE_SPAMASSASSIN = true
1002 BABYCART_PATH = /usr/local/bin/babycart
1004 ; If true don't use UserName/Blog/day/time pagenames for the ADMIN_USER, but
1005 ; Blog/day/time only. Convenience for a single-user blog theme.
1006 ;BLOG_DEFAULT_EMPTY_PREFIX = true
1008 ;===========================================================================
1009 ; Part Eight: PLUGINCACHED Pear/Cache Settings
1010 ;===========================================================================
1012 ; Cache_Container storage class: 'file' is the fastest. See pear/Cache/Container/
1013 ;PLUGIN_CACHED_DATABASE = file
1015 ; This is only used if database is set to file.
1016 ; The webserver must have write access to this dir!
1017 ;PLUGIN_CACHED_CACHE_DIR = /tmp/cache
1018 ; Every file name in the cache begins with this prefix
1019 ;PLUGIN_CACHED_FILENAME_PREFIX = phpwiki
1021 ; The maximum total space in bytes of all files in the cache. When
1022 ; highwater is exceeded, a garbage collection will start. It will
1023 ; collect garbage till 'lowwater' is reached. Default: 4 * Megabyte
1024 ;PLUGIN_CACHED_HIGHWATER = 4194304
1025 ; Default: 3 * Megabyte
1026 ;PLUGIN_CACHED_LOWWATER = 3145728
1028 ; If an image has not been used for maxlifetime remove it from the
1029 ; cache. (Since there is also the highwater/lowwater mechanism and an
1030 ; image usually requires only 1kb you don't have to make it very
1032 ; Default: 30 * Day (30 * 24*60*60)
1033 ;PLUGIN_CACHED_MAXLIFETIME = 2592000
1035 ; Number of characters allowed to be send as
1036 ; parameters in the url before using sessions
1038 ; Usually send plugin arguments as URL, but when they become
1039 ; longer than maxarglen store them in session variables.
1040 ; Setting it to 3000 worked fine for me, 30000 completely
1041 ; crashed my linux, 1000 should be safe.
1042 ;PLUGIN_CACHED_MAXARGLEN = 1000
1044 ; Actually use the cache (should be always true unless you are
1045 ; debugging). If you want to avoid the usage of a cache but need
1046 ; WikiPlugins that nevertheless rely on a cache you might set
1047 ; 'PLUGIN_CACHED_USECACHE' to false. You still need to set
1048 ; 'PLUGIN_CACHED_CACHE_DIR' appropriately to allow image creation and
1049 ; you should set 'PLUGIN_CACHED_FORCE_SYNCMAP' to false.
1050 ;PLUGIN_CACHED_USECACHE = true
1052 ; Will prevent image creation for an image map 'on demand'. It is a
1053 ; good idea to set this to 'true' because it will also prevent the
1054 ; html part not to fit to the image of the map. If you don't use a
1055 ; cache, you have to set it to 'false', maps will not work otherwise
1056 ; but strange effects may happen if the output of an image map
1057 ; producing WikiPlugin is not completely determined by its parameters.
1058 ; (As it is the case for a graphical site map.)
1059 ;PLUGIN_CACHED_FORCE_SYNCMAP = true
1061 ; If ImageTypes() does not exist (PHP < 4.0.2) allow the
1062 ; following image formats (IMG_PNG | IMG_GIF | IMG_JPG | IMG_WBMP)
1063 ; In principal all image types which are compiled into php:
1064 ; libgd, libpng, libjpeg, libungif, libtiff, libgd2, ...
1065 ;PLUGIN_CACHED_IMGTYPES = "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm"