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
53 ; Note: Enable it for all users. Otherwise as per-user setting in UserPreferences.
55 ;ENABLE_DOUBLECLICKEDIT = false
57 ; Needed for inlined SVG and MathM, but conflicts with document.write().
58 ; Experimental. Default: false. Problematic with MSIE6
59 ; See http://hixie.ch/advocacy/xhtml
60 ;ENABLE_XHTML_XML = true
62 ; Store DB query results in memory to avoid duplicate queries.
63 ; Disable only for old php's with low memory or memory_limit=8MB.
67 ; Needs babycart installed. See http://phpwiki.org/SpamAssassinIntegration
68 ; Optionally define BABYCART_PATH. Default: /usr/local/bin/babycart
69 ;ENABLE_SPAMASSASSIN = true
71 ; If GOOGLE_LINKS_NOFOLLOW is true, ref=nofollow is added to
72 ; all external links to discourage spam. You might want to turn it off,
73 ; if you want to improve pageranks on external links.
74 ;GOOGLE_LINKS_NOFOLLOW = false
76 ; LiveSearch enables immediate title search results via XMLHttpRequest.
77 ; Displays the results in a dropdown under the titlesearch inputbox
78 ; while typing. (experimental, only with certain themes)
79 ; You'll have to copy livesearch.js from http://blog.bitflux.ch/wiki/LiveSearch
80 ; to themes/default/ and define ENABLE_LIVESEARCH in config.ini to true.
81 ; See themes/blog/themeinfo.php.
82 ; Currently we use the bitflux.ch library, but we will change to
83 ; the russian acdropdown soon.
84 ;ENABLE_LIVESEARCH = true
85 ; ENABLE_ACDROPDOWN replaces ENABLE_LIVESEARCH
86 ; http://momche.net/publish/article.php?page=acdropdown
87 ;ENABLE_ACDROPDOWN = true
89 ; Experimental WikiPedia feature: Force Discussion/Article link at the topnavbar.
90 ; This does not work yet.
91 ;ENABLE_DISCUSSION_LINK = true
93 ; If set to true, add some anti-spam countermeasures based on captcha
94 ; tests. See http://www.captcha.net/ for more information on captcha.
95 ;ENABLE_CAPTCHA = true
97 ;==========================================================================
98 ; Part One: Authentication and security settings.
100 ; See Part Three for more.
101 ;==========================================================================
103 ; The name of your wiki.
105 ; This is used to generate a keywords meta tag in the HTML templates,
106 ; in bookmark titles for any bookmarks made to pages in your wiki,
107 ; and during RSS generation for the <title> of the RSS channel.
109 ; To use your own logo and signature files, name them PhpWikiLogo.png
110 ; and PhpWikiSignature.png and put them into themes/default/images
111 ; (substituting "PhpWiki" in the filename with the name you define
114 ; It is recommended this be a relatively short WikiWord like the
115 ; InterWiki monikers found in the InterWikiMap. (For examples, see
116 ; lib/interwiki.map).
119 ; Visitor Hostname Lookup
121 ; If set, reverse dns lookups will be performed to attempt to convert
122 ; the user's IP number into a host name, in the case where the http
123 ; server does not do this.
124 ENABLE_REVERSE_DNS = true
126 ; Username and password of administrator.
128 ; Set these to your preferences. For heaven's sake pick a good
129 ; password and use the passencrypt.php tool to encrypt the password from
131 ; http://wolfram.org/writing/howto/password.html
133 ; Logging into the wiki with the admin user and password allows you to lock,
134 ; unlock, or remove pages and to perform other PhpWikiAdministration
135 ; functions. On all other occasions you should simply log in with your
137 ; If your password contains special chars like ";" or ":" better quote it in double-quotes.
139 ; ADMIN_PASSWD is ignored on HttpAuth
142 ; Encrypted passwords are the default. It is recommended that you use the
143 ; passencrypt.php or the configurator.php utility to encode the admin
144 ; password, which provides added security in the event that someone gains
145 ; ftp or shell access to the server and directory containing phpwiki. To
146 ; use plain text passwords, in particular for the ADMIN_PASSWD, set
147 ; ENCRYPTED_PASSWD to false.
148 ENCRYPTED_PASSWD = true
150 ; Private ZIP Dumps of All Wiki Pages
152 ; If true, only the admin user can make zip dumps. Otherwise anyone
153 ; may download all wiki pages as a single zip archive.
156 ; The RawHtml plugin allows page authors to embed real, raw HTML into Wiki
157 ; pages. This is a possible security threat, as much HTML (or, rather,
158 ; JavaScript) can be very risky. If you are in a controlled environment,
159 ; however, it could be of use.
160 ENABLE_RAW_HTML = true
161 ; If this is set, only pages locked by the Administrator may contain the
163 ENABLE_RAW_HTML_LOCKEDONLY = true
164 ; If this is set, all unsafe html code is stripped automatically (experimental!)
165 ; See http://chxo.com/scripts/safe_html-test.php
166 ENABLE_RAW_HTML_SAFE = true
168 ; If you define this to true, (MIME-type) page-dumps (either zip dumps,
169 ; or "dumps to directory" will be encoded using the quoted-printable
170 ; encoding. If you're actually thinking of mailing the raw page dumps,
171 ; then this might be useful, since (among other things,) it ensures
172 ; that all lines in the message body are under 80 characters in length.
174 ; Also, setting this will cause a few additional mail headers
175 ; to be generated, so that the resulting dumps are valid
176 ; RFC 2822 e-mail messages.
178 ; Probably you can just leave this set to false, in which case you get
179 ; raw ('binary' content-encoding) page dumps.
180 STRICT_MAILABLE_PAGEDUMPS = false
182 ; Here you can change the default dump directories.
183 ; (Can be overridden by the directory argument)
184 DEFAULT_DUMP_DIR = /tmp/wikidump
185 HTML_DUMP_DIR = /tmp/wikidumphtml
186 ; Filename suffix used for XHTML page dumps.
187 ; If you don't want any suffix just comment this out.
188 HTML_DUMP_SUFFIX = .html
190 ; The maximum file upload size, in bytes.
191 ; The default, 16777216, is 16MB.
192 MAX_UPLOAD_SIZE = 16777216
194 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
195 ; default state for the "minor edit" checkbox on the edit page form
197 ; The default, 604800, is one week (7 days)
198 MINOR_EDIT_TIMEOUT = 604800
200 ; Actions listed in this array will not be allowed. The complete list
201 ; of actions can be found in lib/main.php with the function
202 ; getActionDescription.
203 ; DISABLED_ACTIONS = "dumpserial : loadfile"
205 ; If you enable this option every page is moderated by the ModeratedPage
206 ; action page plugin. Changing a moderated page will be delayed to be
207 ; granted by a moderator by email.
208 ; ENABLE_MODERATEDPAGE_ALL = true
210 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
211 ; for you. If you want one, define this to the name of the log
212 ; file. The server must have write access to the directory specified.
213 ; Note that even you define ACCESS_LOG_SQL logs are written to this file also.
214 ;ACCESS_LOG = /var/tmp/wiki_access_log
216 ; PhpWiki can read and/or write mod_log_sql accesslog tables for faster
217 ; abuse detection and referer lists.
218 ; If defined (e.g. 1) read-access is done via SQL.
219 ; If flag 2 is set, phpwiki also writes. Default on SQL database.
220 ; This must use DATABASE_TYPE = SQL or ADODB or PDO.
221 ;ACCESS_LOG_SQL = 0 ; disable SQL access logging
222 ;ACCESS_LOG_SQL = 1 ; phpwiki reads, apache mod_log_sql writes
223 ;ACCESS_LOG_SQL = 2 ; read + write
225 ; By default PhpWiki will try to have PHP compress its output
226 ; before sending it to the browser, if you have a recent enough
227 ; version of PHP and the browser and action supports it.
228 ; Define COMPRESS_OUTPUT to false to prevent output compression.
229 ; Define COMPRESS_OUTPUT to true to force output compression,
230 ; even if we think your version of PHP does this in a buggy
232 ; Leave it undefined to leave the choice up to PhpWiki. (Recommended)
234 ; WARNING: Compressing the output has been reported to cause problems
235 ; when PHP is running on MacOSX or on redirected requests.
236 ; This setting should now be correctly determined automatically.
237 ;COMPRESS_OUTPUT = false
239 ; This controls how PhpWiki sets the HTTP cache control
240 ; headers (Expires: and Cache-Control:)
244 ; NO_CACHE: This is roughly the old (pre 1.3.4) behavior. PhpWiki will
245 ; instruct proxies and browsers never to cache PhpWiki output.
246 ; This was previously called 'NONE', but NONE was treated specially
247 ; by parse_ini_config().
249 ; STRICT: Cached pages will be invalidated whenever the database global
250 ; timestamp changes. This should behave just like NO_CACHE (modulo
251 ; bugs in PhpWiki and your proxies and browsers), except that
252 ; things will be slightly more efficient.
254 ; LOOSE: Cached pages will be invalidated whenever they are edited,
255 ; or, if the pages include plugins, when the plugin output could
256 ; concievably have changed.
258 ; Behavior should be much like STRICT, except that sometimes
259 ; wikilinks will show up as undefined (with the question mark)
260 ; when in fact they refer to (recently) created pages.
261 ; (Hitting your browsers reload or perhaps shift-reload button
262 ; should fix the problem.)
264 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
265 ; (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
267 ; This setting will result in quirky behavior. When you edit a
268 ; page your changes may not show up until you shift-reload the
271 ; This setting is generally not advisable, however it may be useful
272 ; in certain cases (e.g. if your wiki gets lots of page views,
273 ; and few edits by knowledgable people who won't freak over the quirks.)
275 ; The recommended default is currently LOOSE.
277 CACHE_CONTROL = LOOSE
279 ; Maximum page staleness, in seconds.
281 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
282 CACHE_CONTROL_MAX_AGE = 600
284 ; PhpWiki normally caches a preparsed version (i.e. mostly
285 ; converted to HTML) of the most recent version of each page.
286 ; (Parsing the wiki-markup takes a fair amount of CPU.)
287 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
288 ; caching of marked-up page content.
289 ; Note that you can also disable markup caching on a per-page
290 ; temporary basis by addinging a query arg of '?nocache=1'
291 ; to the URL to the page or by adding a NoCache plugin line.
292 ; Use '?nocache=purge' to completely discard the cached version of the page.
293 ; You can also purge the cached markup globally by using the
294 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
295 ; Enable only for old php's with low memory or memory_limit=8MB.
297 ;WIKIDB_NOCACHE_MARKUP = true
299 COOKIE_EXPIRATION_DAYS = 365
300 ; Default path for the wikiuser cookie. You need to specify this more explicitly
301 ; if you want to enable different users on different wikis on the same host.
304 ;======================================================================
305 ; Part Two: Database Selection
306 ;======================================================================
308 ; Select the database type:
310 ; SQL: access one of several SQL databases using the PEAR DB library.
311 ; ADODB: uses the ADODB library for data access. (most general)
312 ; dba: use one of the standard UNIX dbm libraries. (fastest)
313 ; file: use a flat file database. (easiest)
314 ; cvs: use a CVS server to store everything. (experimental, not recommended)
317 ; prefix for filenames or table names
319 ; Currently you MUST EDIT THE SQL file too (in the schemas/
320 ; directory because we aren't doing on the fly sql generation
321 ; during the installation.
322 ; Note: This prefix is NOT prepended to the default DBAUTH_
323 ; tables user, pref and member!
324 ;DATABASE_PREFIX = phpwiki_
326 ; For SQL based backends, specify the database as a DSN (Data Source Name),
327 ; a kind of URL for databases.
329 ; The most general form of a DSN looks like:
331 ; dbtype(dbsyntax)://username:password@protocol+hostspec/database?option=value&option2=value2
333 ; For a MySQL database, the following should work:
335 ; mysql://user:password@host/databasename
337 ; To connect over a unix socket, use something like
339 ; mysql://user:password@unix(/path/to/socket)/databasename
341 ; Valid values for dbtype are mysql, pgsql, or sqlite.
343 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
345 ; Keep persistent connections: (mysql_pconnect, ...)
346 ; Recommended is false for bigger servers, and true for small servers
347 ; with not so many connections. postgresql: Please leave it false. Default: false
348 ; Should really be set as database option in the DSN above.
349 DATABASE_PERSISTENT = false
351 ; A table to store session information. Only needed by SQL backends.
353 ; A word of warning - any prefix defined above will be prepended to whatever
355 DATABASE_SESSION_TABLE = session
357 ; For the file and dba backends, this specifies where the data files will be
358 ; located. Ensure that the user that the webserver runs as has write access
361 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
362 ; you'll lose your wiki data at some stage.
363 DATABASE_DIRECTORY = /tmp
365 ; For the dba backend, this defines which DBA variant you wish to use.
366 ; gdbm - commonly available, Fedora not
367 ; db2 - Berkeley DB v2; not supported by modern versions of PHP
368 ; db3 - Berkeley DB v3; as per db2. The best on Windows
369 ; db4 - Berkeley DB v4; current version, however PHP has some issues
370 ; with it's db4 support.
371 ; dbm - Older dba handler; suffers from limits on the size of data
373 DATABASE_DBA_HANDLER = gdbm
375 ; How long will the system wait for a database operation to complete?
376 ; Specified in seconds.
379 ; If action=upgrade detects mysql problems, but has no ALTER permissions,
380 ; give here a user which has the necessary ALTER or CREATE permissions.
381 ; Of course you can fix your database manually. See lib/upgrade.php for known issues.
383 ;DBADMIN_PASSWD = secret
385 ; The login code now uses PHP's session support. Usually, the default
386 ; configuration of PHP is to store the session state information in
387 ; /tmp. That probably will work fine, but fails e.g. on clustered
388 ; servers where each server has their own distinct /tmp (this is the
389 ; case on SourceForge's project web server.) You can specify an
390 ; alternate directory in which to store state information like so
391 ; (whatever user your httpd runs as must have read/write permission
392 ; in this directory):
393 ;SESSION_SAVE_PATH = some_other_directory
395 ;========================================================================
396 ; Section 3a: Page revisions
398 ; The next section controls how many old revisions of each page are
399 ; kept in the database.
400 ;========================================================================
402 ; There are two basic classes of revisions: major and minor. Which
403 ; class a revision belongs in is determined by whether the author
404 ; checked the "this is a minor revision" checkbox when they saved the
407 ; There is, additionally, a third class of revisions: author
408 ; revisions. The most recent non-mergable revision from each distinct
409 ; author is an author revision.
411 ; The expiry parameters for each of those three classes of revisions
412 ; can be adjusted seperately. For each class there are five
413 ; parameters (usually, only two or three of the five are actually
414 ; set) which control how long those revisions are kept in the
417 ; MAX_KEEP: If set, this specifies an absolute maximum for the
418 ; number of archived revisions of that class. This is
419 ; meant to be used as a safety cap when a non-zero
420 ; min_age is specified. It should be set relatively high,
421 ; and it's purpose is to prevent malicious or accidental
422 ; database overflow due to someone causing an
423 ; unreasonable number of edits in a short period of time.
425 ; MIN_AGE: Revisions younger than this (based upon the supplanted
426 ; date) will be kept unless max_keep is exceeded. The age
427 ; should be specified in days. It should be a
428 ; non-negative, real number,
430 ; MIN_KEEP: At least this many revisions will be kept.
432 ; KEEP: No more than this many revisions will be kept.
434 ; MAX_AGE: No revision older than this age will be kept.
436 ; Definitions of terms used above:
438 ; Supplanted date: Revisions are timestamped at the instant that they
439 ; cease being the current revision. Revision age is computed using
440 ; this timestamp, not the edit time of the page.
442 ; Merging: When a minor revision is deleted, if the preceding
443 ; revision is by the same author, the minor revision is merged with
444 ; the preceding revision before it is deleted. Essentially: this
445 ; replaces the content (and supplanted timestamp) of the previous
446 ; revision with the content after the merged minor edit, the rest of
447 ; the page metadata for the preceding version (summary, mtime, ...)
450 ; Let all revisions be stored. Default since 1.3.11
451 ;MAJOR_MIN_KEEP = 2147483647
452 ;MINOR_MIN_KEEP = 2147483647
454 ; Keep up to 8 major edits, but keep them no longer than a month.
458 ; Keep up to 4 minor edits, but keep them no longer than a week.
462 ; Keep the latest contributions of the last 8 authors up to a year.
463 ; Additionally, (in the case of a particularly active page) try to
464 ; keep the latest contributions of all authors in the last week (even
465 ; if there are more than eight of them,) but in no case keep more
466 ; than twenty unique author revisions.
472 ;========================================================================
473 ; Part Three: User Authentication
474 ;========================================================================
476 ; New user authentication configuration:
477 ; We support three basic authentication methods and a stacked array
478 ; of advanced auth methods to get and check the passwords:
480 ; ALLOW_ANON_USER default true
481 ; ALLOW_ANON_EDIT default true
482 ; ALLOW_BOGO_LOGIN default true
483 ; ALLOW_USER_PASSWORDS default true
485 ; allow anon users to view existing pages
486 ALLOW_ANON_USER = true
487 ; allow anon users to edit pages
488 ALLOW_ANON_EDIT = true
490 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
491 ; any/no password) using any userid which:
492 ; 1) is not the ADMIN_USER, and
493 ; 2) is a valid WikiWord (matches $WikiNameRegexp.)
494 ; If true, users may be created by themselves. Otherwise we need seperate auth.
495 ; If such a user will create a so called HomePage with his userid, he will
496 ; be able to store his preferences and password there.
497 ALLOW_BOGO_LOGIN = true
499 ; True User Authentication:
500 ; To require user passwords:
501 ; ALLOW_ANON_USER = false
502 ; ALLOW_ANON_EDIT = false
503 ; ALLOW_BOGO_LOGIN = false,
504 ; ALLOW_USER_PASSWORDS = true.
505 ; Otherwise any anon or bogo user might login without any or a wrong password.
506 ALLOW_USER_PASSWORDS = true
508 ; Many different methods can be used to check user's passwords:
509 ; BogoLogin: WikiWord username, with no *actual* password checking,
510 ; although the user will still have to enter one.
511 ; PersonalPage: Store passwords in the users homepage metadata (simple)
512 ; Db: Use DBAUTH_AUTH_* (see below) with PearDB or
514 ; LDAP: Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN (experimental)
515 ; IMAP: Authenticate against IMAP_AUTH_HOST (email account)
516 ; POP3: Authenticate against POP3_AUTH_HOST (email account)
517 ; File: Store username:crypted-passwords in .htaccess like files.
518 ; Use Apache's htpasswd to manage this file.
519 ; HttpAuth: Use the protection by the webserver (.htaccess/.htpasswd)
520 ; Enforcing HTTP Auth not yet. Note that the ADMIN_USER should exist also.
521 ; Using HttpAuth disables all other methods and no userauth sessions are used.
523 ; Several of these methods can be used together, in the manner specified by
524 ; USER_AUTH_POLICY, below. To specify multiple authentication methods,
525 ; separate the name of each one with colons.
526 ;USER_AUTH_ORDER = "PersonalPage : Db"
527 ;USER_AUTH_ORDER = "BogoLogin : PersonalPage"
529 ; For "security" purposes, you can specify that a password be at least a
530 ; certain number of characters long. This applies even to the BogoLogin
531 ; method. Default: 0 (to allow immediate passwordless BogoLogin)
532 ;PASSWORD_LENGTH_MINIMUM = 6
534 ; The following policies are available for user authentication:
535 ; first-only: use only the first method in USER_AUTH_ORDER
536 ; old: ignore USER_AUTH_ORDER and try to use all available
537 ; methods as in the previous PhpWiki releases (slow)
538 ; strict: check if the user exists for all methods:
539 ; on the first existing user, try the password.
540 ; dont try the other methods on failure then
541 ; stacked: check the given user - password combination for all
542 ; methods and return true on the first success.
543 USER_AUTH_POLICY = stacked
545 ; LDAP authentication options:
547 ; The LDAP server to connect to. Can either be a hostname, or a complete
548 ; URL to the server (useful if you want to use ldaps or specify a different
550 ;LDAP_AUTH_HOST = "ldap://localhost:389"
552 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
554 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
555 ; Better use LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP.
556 ;LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
558 ; Some LDAP servers need some more options, such as the Windows Active
559 ; Directory Server. Specify the options (as allowed by the PHP LDAP module)
560 ; and their values as NAME=value pairs separated by colons.
561 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
563 ; DN to initially bind to the LDAP server as. This is needed if the server doesn't
564 ; allow anonymous queries. (Windows Active Directory Server)
565 ; LDAP_AUTH_USER = "CN=ldapuser,ou=Users,o=Development,dc=mycompany.com"
567 ; Password to use to initially bind to the LDAP server, as the DN
568 ; specified in the LDAP_AUTH_USER option (above).
569 ; LDAP_AUTH_PASSWORD = secret
571 ; If you want to match usernames against an attribute other than uid,
572 ; specify it here. Default: uid
573 ; LDAP_SEARCH_FIELD = sAMAccountName
575 ; If you have an organizational unit for all users, define it here.
576 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
578 ; LDAP_OU_USERS = ou=Users
580 ; If you have an organizational unit for all groups, define it here.
581 ; This narrows the search, and is needed for LDAP group membership (if GROUP_METHOD=LDAP)
582 ; The entries in this ou must have a gidNumber and cn attribute.
584 ; LDAP_OU_GROUP = ou=Groups
587 ; IMAP authentication options:
589 ; The IMAP server to check usernames from. Defaults to localhost.
591 ; Some IMAP_AUTH_HOST samples:
592 ; "localhost", "localhost:143/imap/notls",
593 ; "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
594 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
596 ; POP3 authentication options:
598 ; Host to connect to.
599 ; POP3_AUTH_HOST = "localhost:110"
601 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
602 ; POP3_AUTH_PORT = 110
604 ; File authentication options:
606 ; File to read for authentication information.
607 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
608 ; AUTH_USER_FILE = /etc/shadow
610 ; Defines whether the user is able to change their own password via PHPWiki.
611 ; Note that this means that the webserver user must be able to write to the
612 ; file specified in AUTH_USER_FILE.
613 ; AUTH_USER_FILE_STORABLE = false
616 ; Name of the session variable which holds the already authenticated username.
617 ; Sample: "userid", "user[username]", "user->username"
618 ; AUTH_SESS_USER = userid
619 ; Which level will the user be? 1 = Bogo or 2 = Pass
620 ; AUTH_SESS_LEVEL = 2
622 ; Group membership. PhpWiki supports defining permissions for a group as
623 ; well as for individual users. This defines how group membership information
624 ; is obtained. Supported values are:
626 ; "NONE" Disable group membership (Fastest). Note the required quoting.
627 ; WIKIPAGE Define groups as list at "CategoryGroup". (Slowest, but easiest to maintain)
628 ; DB Stored in an SQL database. Optionally external. See USERS/GROUPS queries
629 ; FILE Flatfile. See AUTH_GROUP_FILE below.
630 ; LDAP LDAP groups. See "LDAP authentication options" above and
631 ; lib/WikiGroup.php. (experimental)
632 GROUP_METHOD = WIKIPAGE
634 ; Page where all groups are listed. Default: Translation of "CategoryGroup"
635 ; CATEGORY_GROUP_PAGE = CategoryGroup
637 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
638 ; group membership information. It should be in the same format as the
639 ; standard unix /etc/groups(5) file.
640 ; AUTH_GROUP_FILE = /etc/groups
642 ; External database authentication and authorization.
644 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
645 ; below define the SQL queries used to obtain the information out of the
646 ; database, and (in some cases) store the information back to the DB.
648 ; The options appropriate for each query are currently undocumented, and
649 ; you should not be surprised if things change mightily in the future.
651 ; A database DSN to connect to. Defaults to the DSN specified for the Wiki
653 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
655 ; USER/PASSWORD queries
657 ; For USER_AUTH_POLICY=strict and the Db method this is required:
658 ; DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
660 ; Check to see if the supplied username/password pair is OK
662 ; plaintext passwords:
663 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) AS ok FROM user WHERE userid='$userid'"
665 ; database-hashed passwords (more secure):
666 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) AS ok FROM user WHERE userid='$userid'"
667 DBAUTH_AUTH_CRYPT_METHOD = plain
669 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
670 ; to get the password out of the database with a simple SELECT query, and
671 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
672 ; DBAUTH_AUTH_CHECK = "SELECT passwd FROM user where userid='$userid'"
673 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
675 ; Update the user's authentication credential. If this is not defined but
676 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
679 ; Plaintext passwords:
680 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd='$password' WHERE userid='$userid'"
681 ; Database-hashed passwords:
682 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd=PASSWORD('$password') WHERE userid='$userid'"
684 ; Allow the user to create their own account.
685 ; DBAUTH_AUTH_CREATE = "INSERT INTO user SET passwd=PASSWORD('$password'),userid='$userid'"
687 ; USER/PREFERENCE queries
689 ; If you choose to store your preferences in an external database, enable
690 ; the following queries. Note that if you choose to store user preferences
691 ; in the 'user' table, only registered users get their prefs from the database,
692 ; self-created users do not. Better to use the special 'pref' table.
694 ; The prefs field stores the serialized form of the user's preferences array,
695 ; to ease the complication of storage.
696 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM user WHERE userid='$userid'"
697 ; DBAUTH_PREF_SELECT = "SELECT prefs FROM pref WHERE userid='$userid'"
699 ; Update the user's preferences
700 ; DBAUTH_PREF_UPDATE = "UPDATE user SET prefs='$pref_blob' WHERE userid='$userid'"
701 ; Note that REPLACE works only with mysql and destroy all other columns!
702 ; DBAUTH_PREF_UPDATE = "REPLACE INTO pref SET prefs='$pref_blob',userid='$userid'"
704 ; USERS/GROUPS queries
706 ; You can define 1:n or n:m user<=>group relations, as you wish.
708 ; Sample configurations:
709 ; only one group per user (1:n):
710 ; DBAUTH_IS_MEMBER = "SELECT user FROM user WHERE user='$userid' AND group='$groupname'"
711 ; DBAUTH_GROUP_MEMBERS = "SELECT user FROM user WHERE group='$groupname'"
712 ; DBAUTH_USER_GROUPS = "SELECT group FROM user WHERE user='$userid'"
713 ; multiple groups per user (n:m):
714 ; DBAUTH_IS_MEMBER = "SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'"
715 ; DBAUTH_GROUP_MEMBERS = "SELECT DISTINCT userid FROM member WHERE groupname='$groupname'"
716 ; DBAUTH_USER_GROUPS = "SELECT groupname FROM member WHERE userid='$userid'"
718 ; A interim page which gets displayed on every edit attempt, if it exists.
719 ;EDITING_POLICY = EditingPolicy
721 ;========================================================================
722 ; Part Four: Page appearance and layout
723 ;========================================================================
727 ; Most of the page appearance is controlled by files in the theme
730 ; There are a number of pre-defined themes shipped with PhpWiki.
731 ; Or you may create your own (e.g. by copying and then modifying one of
734 ; The complete list of installed themes can be found by doing 'ls themes/'
735 ; from the root of your PHPWiki installation.
736 ; white on yellow with fat blue links:
738 ; almost fully iconized classic grey MacOSX design:
740 ; as default, just some tricks to make the buttons smaller:
742 ; the popular Wordpress layout:
744 ; pure old-style c2wiki layout:
746 ; example with some sidebar boxes:
748 ; mozilla friendly, with lots of icons instead of buttons (i18n friendly):
752 ; default + rateit navbar:
754 ; blogger style, rounded (experimental):
758 ; heavy space-y layout:
760 ; random heavy images:
763 ; Select a valid charset name to be inserted into the xml/html pages,
764 ; and to reference links to the stylesheets (css). For more info see:
765 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
766 ; has been extensively tested only with the latin1 (iso-8859-1)
769 ; If you change the default from iso-8859-1 PhpWiki may not work
770 ; properly and will require modifications in all existing pages.
771 ; At the very least you will have to convert the files in pgsrc
772 ; or locale/xx/pgsrc to match!
773 ; Currently we support utf-8 for zh and ja, euc-jp for ja (not enabled)
774 ; and iso-8859-1 for all other langs. Changing languages (UserPreferences)
775 ; from one charset to another will not work!
777 ; Character sets similar to iso-8859-1 may work with little or no
778 ; modification depending on your setup. The database must also
779 ; support the same charset, and of course the same is true for the
780 ; web browser. (Some work is in progress hopefully to allow more
781 ; flexibility in this area in the future).
784 ; Select your language/locale - Default language is "" for auto-detection.
785 ; Available languages:
786 ; English "en" (English - HomePage)
787 ; Dutch "nl" (Nederlands - ThuisPagina)
788 ; Spanish "es" (Español - PáginaPrincipal)
789 ; French "fr" (Français - PageAccueil))
790 ; German "de" (Deutsch - StartSeite)
791 ; Swedish "sv" (Svenska - Framsida)
792 ; Italian "it" (Italiano - PaginaPrincipale)
793 ; Japanese "ja" (Japanese - ¥Û¡¼¥à ¥Ú¡¼¥¸)
794 ; Chinese "zh" (Chinese - ?)
796 ; If you set DEFAULT_LANGUAGE to the empty string, the users
797 ; preferred language as determined by the browser setting will be used.
798 ; Japanese requires CHARSET=euc-jp or utf-8 (not yet safe), Chinese CHARSET=utf-8
799 ;DEFAULT_LANGUAGE = en
801 ; WIKI_PGSRC -- specifies the source for the initial page contents of
802 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
803 ; accessed for the first time (or after clearing the database.)
804 ; WIKI_PGSRC can either name a directory or a zip file. In either case
805 ; WIKI_PGSRC is scanned for files -- one file per page.
808 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
809 ; default (English) and when reading from a directory: in that case
810 ; some English pages are inserted into the wiki as well.
811 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
812 ;DEFAULT_WIKI_PGSRC = pgsrc
813 ; These are ':'-seperated pages which will get loaded untranslated from DEFAULT_WIKI_PGSRC.
814 ;DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
816 ;=========================================================================
817 ; Part Five: Mark-up options.
818 ;=========================================================================
820 ; Allowed protocols for links - be careful not to allow "javascript:"
821 ; URL of these types will be automatically linked.
822 ; within a named link [name|uri] one more protocol is defined: phpwiki
823 ; Separate each of the protocol names with a vertical pipe, and ensure there
824 ; is no extraneous whitespace.
825 ;ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
827 ; URLs ending with the following extension should be inlined as images.
828 ; Specify as per ALLOWED_PROTOCOLS.
829 ; Note that you can now also allow class|svg|svgz|vrml|swf ...,
830 ; which will create embedded <object> instead of <img>.
831 ; Typical CGI extensions as pl or cgi maybe allowed too, but those two will be enforced to <img>
832 ;INLINE_IMAGES = "png|jpg|gif"
834 ; Perl regexp for WikiNames ("bumpy words")
835 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
836 ;WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
838 ; Defaults to '/', but '.' was also used.
839 ;SUBPAGE_SEPARATOR = /
841 ; InterWiki linking -- wiki-style links to other wikis on the web
843 ; The map will be taken from a page name InterWikiMap.
844 ; If that page is not found (or is not locked), or map
845 ; data can not be found in it, then the file specified
846 ; by INTERWIKI_MAP_FILE (if any) will be used.
847 ;INTERWIKI_MAP_FILE = lib/interwiki.map
849 ; Display a warning if the internal lib/interwiki.map is used, and
850 ; not the public InterWikiMap page. This file is not readable from outside.
851 ;WARN_NONPUBLIC_INTERWIKIMAP = false
853 ; Search term used for automatic page classification by keyword extraction.
855 ; Any links on a page to pages whose names match this search
856 ; will be used keywords in the keywords html meta tag. This is an aid to
857 ; classification by search engines. The value of the match is
858 ; used as the keyword.
860 ; The default behavior is to match Category* or Topic* links.
861 ;KEYWORDS = "Category* OR Topic*"
863 ; Author and Copyright Site Navigation Links
865 ; These will be inserted as <link rel> tags in the html header of
866 ; every page, for search engines and for browsers like Mozilla which
867 ; take advantage of link rel site navigation.
869 ; If you have your own copyright and contact information pages change
870 ; these as appropriate.
871 ;COPYRIGHTPAGE_TITLE = "GNU General Public License"
872 ;COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/gpl.html#SEC1"
873 ; Other useful alternatives to consider:
874 ; COPYRIGHTPAGE_TITLE = "GNU Free Documentation License"
875 ; COPYRIGHTPAGE_URL = "http://www.gnu.org/copyleft/fdl.html"
876 ; COPYRIGHTPAGE_TITLE = "Creative Commons License 2.0"
877 ; COPYRIGHTPAGE_URL = "http://creativecommons.org/licenses/by/2.0/"
878 ; see http://creativecommons.org/learn/licenses/ for variations
879 ;AUTHORPAGE_TITLE = The PhpWiki Programming Team
880 ;AUTHORPAGE_URL = http://phpwiki.org/ThePhpWikiProgrammingTeam
882 ; Allow full markup in headers to be parsed by the CreateToc plugin.
884 ; If false you may not use WikiWords or [] links or any other markup in
885 ; headers in pages with the CreateToc plugin. But if false the parsing is
886 ; faster and more stable.
887 ;TOC_FULL_SYNTAX = true
889 ; If false the %color=... %% syntax will be disabled. Since 1.3.11
891 ;ENABLE_MARKUP_COLOR = false
893 ; Enable mediawiki-style {{TemplatePage|vars=value|...}} syntax. Since 1.3.11
894 ; Default: undefined. true on the MonoBook theme
895 ;ENABLE_MARKUP_TEMPLATE = true
897 ;==========================================================================
898 ; Part Six: URL options.
899 ;==========================================================================
901 ; You can probably skip this section.
903 ; The following section contains settings which you can use to tailor
904 ; the URLs which PhpWiki generates.
906 ; Any of these parameters which are left undefined will be deduced
907 ; automatically. You need only set them explicitly if the
908 ; auto-detected values prove to be incorrect.
910 ; In most cases the auto-detected values should work fine, so
911 ; hopefully you don't need to mess with this section.
913 ; In case of local overrides of short placeholders, which themselves
914 ; include index.php, we check for most constants. See '/wiki'.
915 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki
916 ; versions (for development), but most likely other values like
917 ; THEME, LANG and DbParams for a WikiFarm.
919 ; Canonical name and httpd port of the server on which this PhpWiki
922 ;SERVER_NAME = some.host.com
925 ; Relative URL (from the server root) of the PhpWiki
927 ;SCRIPT_NAME = /some/where/index.php
929 ; URL of the PhpWiki install directory. (You only need to set this
930 ; if you've moved index.php out of the install directory.) This can
931 ; be either a relative URL (from the directory where the top-level
932 ; PhpWiki script is) or an absolute one.
933 ;DATA_PATH = /home/user/phpwiki
935 ; Path to the PhpWiki install directory. This is the local
936 ; filesystem counterpart to DATA_PATH. (If you have to set
937 ; DATA_PATH, your probably have to set this as well.) This can be
938 ; either an absolute path, or a relative path interpreted from the
939 ; directory where the top-level PhpWiki script (normally index.php)
941 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
943 ; PhpWiki will try to use short urls to pages, eg
944 ; http://www.example.com/index.php/HomePage
945 ; If you want to use urls like
946 ; http://www.example.com/index.php?pagename=HomePage
947 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
948 ; NB: If you are using Apache >= 2.0.30, then you may need to to use
949 ; the directive "AcceptPathInfo On" in your Apache configuration file
950 ; (or in an appropriate <.htaccess> file) for the short urls to work:
951 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
953 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
954 ; on prettifying your urls.
956 ; Note that Google doesn't follow the default /index.php/PageName links.
957 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
959 ; Default: PhpWiki will try to divine whether use of PATH_INFO
960 ; is supported in by your webserver/PHP configuration, and will
961 ; use PATH_INFO if it thinks that is possible.
962 ;USE_PATH_INFO = false
964 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
965 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
966 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
967 ; something different.
969 ; If you do this, you should set VIRTUAL_PATH here.
971 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
972 ; but * you've made it accessible through eg. /wiki/HomePage.
974 ; One way to do this is to create a directory named 'wiki' in your
975 ; server root. The directory contains only one file: an .htaccess
976 ; file which reads something like:
978 ; Action x-phpwiki-page /scripts/phpwiki/index.php
979 ; SetHandler x-phpwiki-page
980 ; DirectoryIndex /scripts/phpwiki/index.php
982 ; In that case you should set VIRTUAL_PATH to '/wiki'.
984 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
986 ;VIRTUAL_PATH = /SomeWiki
988 ; In case your system has no idea about /tmp, TEMP or TMPDIR,
989 ; better provide it here. E.g. needed for zipdumps.
992 ;===========================================================================
993 ; Part Seven: Miscellaneous settings
994 ;===========================================================================
996 ; Disable HTTP redirects.
997 ; (You probably don't need to touch this.)
999 ; PhpWiki uses HTTP redirects for some of it's functionality.
1000 ; (e.g. after saving changes, PhpWiki redirects your browser to
1001 ; view the page you just saved.)
1002 ; Some web service providers (notably free European Lycos) don't seem to
1003 ; allow these redirects. (On Lycos the result in an "Internal Server Error"
1004 ; report.) In that case you can set DISABLE_HTTP_REDIRECT to true.
1005 ; (In which case, PhpWiki will revert to sneakier tricks to try to
1006 ; redirect the browser...)
1007 ;DISABLE_HTTP_REDIRECT = true
1009 ; Enable random quotes from a fortune directory when adding a new page.
1010 ; Usually at /usr/share/fortune or /usr/share/games/fortune
1011 ; If empty no quotes are inserted.
1012 ;FORTUNE_DIR = /usr/share/fortune
1014 ; If you get a crash at loading LinkIcons you might want to disable
1015 ; the getimagesize() function, which crashes on certain php versions and
1016 ; and some external images (png's, ..).
1017 ; getimagesize() is only needed for spam prevention.
1018 ;DISABLE_GETIMAGESIZE = true
1020 ; Experimental: For using the Google API
1021 ;GOOGLE_LICENSE_KEY = "..."
1023 ; Optional: administrative SQL DB access (for action=upgrade)
1027 ; Optional: external PDF executable, %s is the xhtml filename
1028 ;USE_EXTERNAL_HTML2PDF = "htmldoc --quiet --format pdf14 --no-toc --no-title %s"
1030 ; Optional: SPAMASSASSIN wrapper. Only used if ENABLE_SPAMASSASSIN = true
1031 BABYCART_PATH = /usr/local/bin/babycart
1033 ; If true don't use UserName/Blog/day/time pagenames for the ADMIN_USER, but
1034 ; Blog/day/time only. Convenience for a single-user blog theme.
1035 ;BLOG_DEFAULT_EMPTY_PREFIX = true
1037 ; Add additional EDIT_TOOLBAR buttons if defined:
1038 ; Insert a pagelink from this list:
1039 ;TOOLBAR_PAGELINK_PULLDOWN = *
1040 ; Insert a template from this list:
1041 ;TOOLBAR_TEMPLATE_PULLDOWN = Template*
1043 ;===========================================================================
1044 ; Part Eight: PLUGINCACHED Pear/Cache Settings
1045 ;===========================================================================
1047 ; Cache_Container storage class: 'file' is the fastest. See pear/Cache/Container/
1048 ;PLUGIN_CACHED_DATABASE = file
1050 ; This is only used if database is set to file.
1051 ; The webserver must have write access to this dir!
1052 ;PLUGIN_CACHED_CACHE_DIR = /tmp/cache
1053 ; Every file name in the cache begins with this prefix
1054 ;PLUGIN_CACHED_FILENAME_PREFIX = phpwiki
1056 ; The maximum total space in bytes of all files in the cache. When
1057 ; highwater is exceeded, a garbage collection will start. It will
1058 ; collect garbage till 'lowwater' is reached. Default: 4 * Megabyte
1059 ;PLUGIN_CACHED_HIGHWATER = 4194304
1060 ; Default: 3 * Megabyte
1061 ;PLUGIN_CACHED_LOWWATER = 3145728
1063 ; If an image has not been used for maxlifetime remove it from the
1064 ; cache. (Since there is also the highwater/lowwater mechanism and an
1065 ; image usually requires only 1kb you don't have to make it very
1067 ; Default: 30 * Day (30 * 24*60*60)
1068 ;PLUGIN_CACHED_MAXLIFETIME = 2592000
1070 ; Number of characters allowed to be send as
1071 ; parameters in the url before using sessions
1073 ; Usually send plugin arguments as URL, but when they become
1074 ; longer than maxarglen store them in session variables.
1075 ; Setting it to 3000 worked fine for me, 30000 completely
1076 ; crashed my linux, 1000 should be safe.
1077 ;PLUGIN_CACHED_MAXARGLEN = 1000
1079 ; Actually use the cache (should be always true unless you are
1080 ; debugging). If you want to avoid the usage of a cache but need
1081 ; WikiPlugins that nevertheless rely on a cache you might set
1082 ; 'PLUGIN_CACHED_USECACHE' to false. You still need to set
1083 ; 'PLUGIN_CACHED_CACHE_DIR' appropriately to allow image creation and
1084 ; you should set 'PLUGIN_CACHED_FORCE_SYNCMAP' to false.
1085 ;PLUGIN_CACHED_USECACHE = true
1087 ; Will prevent image creation for an image map 'on demand'. It is a
1088 ; good idea to set this to 'true' because it will also prevent the
1089 ; html part not to fit to the image of the map. If you don't use a
1090 ; cache, you have to set it to 'false', maps will not work otherwise
1091 ; but strange effects may happen if the output of an image map
1092 ; producing WikiPlugin is not completely determined by its parameters.
1093 ; (As it is the case for a graphical site map.)
1094 ;PLUGIN_CACHED_FORCE_SYNCMAP = true
1096 ; If ImageTypes() does not exist (PHP < 4.0.2) allow the
1097 ; following image formats (IMG_PNG | IMG_GIF | IMG_JPG | IMG_WBMP)
1098 ; In principal all image types which are compiled into php:
1099 ; libgd, libpng, libjpeg, libungif, libtiff, libgd2, ...
1100 ;PLUGIN_CACHED_IMGTYPES = "png|gif|gd|gd2|jpeg|wbmp|xbm|xpm"