]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - config/config-dist.ini
require_once fix for those libs which are loaded before FileFinder and
[SourceForge/phpwiki.git] / config / config-dist.ini
1 ; This is the main configuration file for PhpWiki.
2 ; Note that seartain characters are used as comment char and therefore 
3 ; these entries must be in double-quotes. Such as ":", ";", "," and "|"
4 ;
5 ; This file is divided into seven parts: Parts Zero, One, Two, Three,
6 ; Four, Five and Six. Each one has different configuration settings you can
7 ; change; in all cases the default should work on your system,
8 ; however, we recommend you tailor things to your particular setting.
9
10 ;=========================================================================
11 ; Part Zero: Tricky Options
12 ;=========================================================================
13 ;
14 ; If PHP needs help in finding where you installed the rest of the PhpWiki
15 ; code, you can set the include_path here.
16 ;
17 ; Define PHP's include path so that it can find the PHP source code
18 ; for this PhpWiki.
19
20 ; You shouldn't need to do this unless you've moved index.php out
21 ; of the PhpWiki install directory.
22 ;
23 ; Note that on Windows-based servers, you should use ; rather than :
24 ; as the path separator.
25 ;INCLUDE_PATH = ".:/usr/local/httpd/phpwiki"
26
27 ; Set DEBUG to 1 to view the XHTML and CSS validator icons, page
28 ; processing timer, and possibly other debugging messages at the
29 ; bottom of each page.
30 ;DEBUG = 1
31
32 ; Enable the new method of handling WikiUsers.  This is currently an
33 ; experimental feature, although it is considered fairly stable.  It's best
34 ; to leave it on, and only disable it if you have problems with it.
35 ENABLE_USER_NEW = true
36
37 ; Experimental edit feature
38 ;JS_SEARCHREPLACE = true
39
40 ;==========================================================================
41 ; Part One: Authentication and security settings.
42 ;
43 ; See Part Three for more.
44 ;==========================================================================
45 ;
46 ; The name of your wiki.
47 ;
48 ; This is used to generate a keywords meta tag in the HTML templates,
49 ; in bookmark titles for any bookmarks made to pages in your wiki,
50 ; and during RSS generation for the <title> of the RSS channel.
51 ;
52 ; To use your own logo and signature files, name them PhpWikiLogo.png
53 ; and PhpWikiSignature.png and put them into themes/default/images
54 ; (substituting "PhpWiki" in the filename with the name you define
55 ; here).
56 ;
57 ; It is recommended this be a relatively short WikiWord like the
58 ; InterWiki monikers found in the InterWikiMap. (For examples, see
59 ; lib/interwiki.map).
60 WIKI_NAME = PhpWiki
61
62 ; Visitor Hostname Lookup
63 ;
64 ; If set, reverse dns lookups will be performed to attempt to convert
65 ; the user's IP number into a host name, in the case where the http
66 ; server does not do this.
67 ENABLE_REVERSE_DNS = true
68
69 ; Username and password of administrator.
70 ;
71 ; Set these to your preferences. For heaven's sake pick a good
72 ; password and use the passencrypt.php tool to encrypt the password from
73 ; prying eyes.
74 ; http://wolfram.org/writing/howto/password.html
75
76 ; Logging into the wiki with the admin user and password allows you to lock,
77 ; unlock, or remove pages and to perform other PhpWikiAdministration
78 ; functions. On all other occasions you should simply log in with your
79 ; regular WikiName.
80 ;ADMIN_USER = 
81 ;ADMIN_PASSWD =
82
83 ; It is recommended that you use the passencrypt.php utility to encode the
84 ; admin password, in the event that someone gains ftp or ssh access to the
85 ; server and directory containing phpwiki. Once you have pasted the
86 ; encrypted password into ADMIN_PASSWD, uncomment this next line.
87 ENCRYPTED_PASSWD = true
88
89 ; Private ZIP Dumps of All Wiki Pages
90 ;
91 ; If true, only the admin user can make zip dumps. Otherwise anyone
92 ; may download all wiki pages as a single zip archive.
93 ZIPDUMP_AUTH = false
94
95 ; The RawHtml plugin allows page authors to embed real, raw HTML into Wiki
96 ; pages.  This is a possible security threat, as much HTML (or, rather,
97 ; JavaScript) can be very risky.  If you are in a controlled environment,
98 ; however, it could be of use.
99 ENABLE_RAW_HTML = false;
100
101 ; If you define this to true, (MIME-type) page-dumps (either zip dumps,
102 ; or "dumps to directory" will be encoded using the quoted-printable
103 ; encoding.  If you're actually thinking of mailing the raw page dumps,
104 ; then this might be useful, since (among other things,) it ensures
105 ; that all lines in the message body are under 80 characters in length.
106 ;
107 ; Also, setting this will cause a few additional mail headers
108 ; to be generated, so that the resulting dumps are valid
109 ; RFC 2822 e-mail messages.
110 ;
111 ; Probably you can just leave this set to false, in which case you get
112 ; raw ('binary' content-encoding) page dumps.
113 STRICT_MAILABLE_PAGEDUMPS = false
114
115 ; Here you can change the filename suffix used for XHTML page dumps.
116 ; If you don't want any suffix just comment this out.
117 HTML_DUMP_SUFFIX = .html
118
119 ; The maximum file upload size, in bytes.
120 ; The default, 16777216, is 16MB.
121 MAX_UPLOAD_SIZE = 16777216
122
123 ; If the last edit is older than MINOR_EDIT_TIMEOUT seconds, the
124 ; default state for the "minor edit" checkbox on the edit page form
125 ; will be off.
126 ; The default, 604800, is one week (7 days)
127 MINOR_EDIT_TIMEOUT = 604800
128
129 ; Actions listed in this array will not be allowed.  The complete list
130 ; of actions can be found in lib/main.php with the function
131 ; getActionDescription.
132 ; DISABLED_ACTIONS = "dumpserial : loadfile"
133
134 ; PhpWiki can generate an access_log (in "NCSA combined log" format)
135 ; for you. If you want one, define this to the name of the log
136 ; file. The server must have write access to the directory specified.
137 ;ACCESS_LOG = /var/tmp/wiki_access_log
138
139 ; By default PhpWiki will try to have PHP compress its output
140 ; before sending it to the browser (if you have a recent enough
141 ; version of PHP and the browser supports it.)
142 ; Define COMPRESS_OUTPUT to false to prevent output compression.
143 ; Define COMPRESS_OUTPUT to true to force output compression,
144 ; even if we think your version of PHP does this in a buggy
145 ; fashion.
146 ; Leave it undefined to leave the choice up to PhpWiki.
147 ;
148 ; WARNING: Compressing the output has been reported to cause serious problems
149 ; when PHP is running as a CGI.
150 ;COMPRESS_OUTPUT = false
151
152 ; This controls how PhpWiki sets the HTTP cache control
153 ; headers (Expires: and Cache-Control:) 
154 ;
155 ; Choose one of:
156 ;
157 ; NONE: This is roughly the old (pre 1.3.4) behavior.  PhpWiki will
158 ;       instruct proxies and browsers never to cache PhpWiki output.
159 ;
160 ; STRICT: Cached pages will be invalidated whenever the database global
161 ;       timestamp changes.  This should behave just like NONE (modulo
162 ;       bugs in PhpWiki and your proxies and browsers), except that
163 ;       things will be slightly more efficient.
164 ;
165 ; LOOSE: Cached pages will be invalidated whenever they are edited,
166 ;       or, if the pages include plugins, when the plugin output could
167 ;       concievably have changed.
168 ;
169 ;       Behavior should be much like STRICT, except that sometimes
170 ;       wikilinks will show up as undefined (with the question mark)
171 ;       when in fact they refer to (recently) created pages.
172 ;       (Hitting your browsers reload or perhaps shift-reload button
173 ;       should fix the problem.)
174 ;
175 ; ALLOW_STALE: Proxies and browsers will be allowed to used stale pages.
176 ;       (The timeout for stale pages is controlled by CACHE_CONTROL_MAX_AGE.)
177 ;
178 ;       This setting will result in quirky behavior.  When you edit a
179 ;       page your changes may not show up until you shift-reload the
180 ;       page, etc...
181 ;
182 ;       This setting is generally not advisable, however it may be useful
183 ;       in certain cases (e.g. if your wiki gets lots of page views,
184 ;       and few edits by knowledgable people who won't freak over the quirks.)
185 ;
186 ; The recommended default is currently LOOSE.
187 ;
188 CACHE_CONTROL = LOOSE
189
190 ; Maximum page staleness, in seconds.
191 ;
192 ; This only has effect if CACHE_CONTROL is set to ALLOW_STALE.
193 CACHE_CONTROL_MAX_AGE = 600
194
195 ; PhpWiki normally caches a preparsed version (i.e. mostly
196 ; converted to HTML) of the most recent version of each page.
197 ; (Parsing the wiki-markup takes a fair amount of CPU.)
198 ;
199 ; Define WIKIDB_NOCACHE_MARKUP to true to disable the
200 ; caching of marked-up page content.
201 ;
202 ; Note that you can also disable markup caching on a per-page
203 ; temporary basis by addinging a query arg of '?nocache=1'
204 ; to the URL to the page.  (Use '?nocache=purge' to completely
205 ; discard the cached version of the page.)
206 ;
207 ; You can also purge the cached markup globally by using the
208 ; "Purge Markup Cache" button on the PhpWikiAdministration page.
209 ;WIKIDB_NOCACHE_MARKUP = true
210
211 ;======================================================================
212 ; Part Two: Database Selection
213 ;======================================================================
214
215 ; Select the database type:
216 ;
217 ;       SQL:   access one of several SQL databases using the PEAR DB library.
218 ;       ADODB: uses the ADODB library for data access.
219 ;       dba: use one of the standard UNIX dbm libraries.
220 ;       file: use a flat file database.
221 ;       cvs: use a CVS server to store everything.
222 DATABASE_TYPE = dba
223    
224 ; prefix for filenames or table names
225 ;
226 ; Currently you MUST EDIT THE SQL file too (in the schemas/
227 ; directory because we aren't doing on the fly sql generation
228 ; during the installation.
229 ; Note: This prefix is NOT prepended to the default DBAUTH_
230 ;       tables user, pref and member!
231 ;DATABASE_PREFIX = phpwiki_
232
233 ; For SQL based backends, specify the database as a DSN (Data Source Name),
234 ; a kind of URL for databases.
235 ;
236 ; The most general form of a DSN looks like:
237 ;
238 ;       dbtype(dbsyntax)://username:password@protocol+hostspec/database
239 ;
240 ; For a MySQL database, the following should work:
241 ;
242 ;       mysql://user:password@host/databasename
243 ;
244 ; To connect over a unix socket, use something like
245 ;
246 ;       mysql://user:password@unix(/path/to/socket)/databasename
247 ;
248 ; Valid values for dbtype are mysql, pgsql, or sqlite.
249 ;
250 DATABASE_DSN = "mysql://guest@unix(/var/lib/mysql/mysql.sock)/test"
251
252 ; A table to store session information.  Only needed by SQL backends.
253 ;
254 ; A word of warning - any prefix defined above will be prepended to whatever
255 ; is given here.
256 DATABASE_SESSION_TABLE = session
257
258 ; For the file and dba backends, this specifies where the data files will be
259 ; located.  Ensure that the user that the webserver runs as has write access
260 ; to this directory.
261 ;
262 ; WARNING: leaving this as the default of '/tmp' will almost guarantee that
263 ; you'll lose your wiki data at some stage.
264 DATABASE_DIRECTORY = /tmp
265
266 ; For the dba backend, this defines which DBA variant you wish to use.
267 ;       gdbm - commonly available
268 ;       db2 - Berkeley DB v2; not supported by modern versions of PHP
269 ;       db3 - Berkeley DB v3; as per db2. The best on Windows
270 ;       db4 - Berkeley DB v4; current version, however PHP has some issues
271 ;               with it's db4 support.
272 ;       dbm - Older dba handler; suffers from limits on the size of data
273 ;               items
274 DATABASE_DBA_HANDLER = gdbm
275
276 ; How long will the system wait for a database operation to complete?
277 ; Specified in seconds.
278 DATABASE_TIMEOUT = 20
279
280 ; The login code now uses PHP's session support. Usually, the default
281 ; configuration of PHP is to store the session state information in
282 ; /tmp. That probably will work fine, but fails e.g. on clustered
283 ; servers where each server has their own distinct /tmp (this is the
284 ; case on SourceForge's project web server.) You can specify an
285 ; alternate directory in which to store state information like so
286 ; (whatever user your httpd runs as must have read/write permission
287 ; in this directory):
288 ;SESSION_SAVE_PATH = some_other_directory
289
290 ;========================================================================
291 ; Section 3a: Page revisions
292 ;
293 ; The next section controls how many old revisions of each page are
294 ; kept in the database.
295 ;========================================================================
296 ;
297 ; There are two basic classes of revisions: major and minor. Which
298 ; class a revision belongs in is determined by whether the author
299 ; checked the "this is a minor revision" checkbox when they saved the
300 ; page.
301
302 ; There is, additionally, a third class of revisions: author
303 ; revisions. The most recent non-mergable revision from each distinct
304 ; author is an author revision.
305 ;
306 ; The expiry parameters for each of those three classes of revisions
307 ; can be adjusted seperately. For each class there are five
308 ; parameters (usually, only two or three of the five are actually
309 ; set) which control how long those revisions are kept in the
310 ; database.
311 ;
312 ;   MAX_KEEP: If set, this specifies an absolute maximum for the
313 ;             number of archived revisions of that class. This is
314 ;             meant to be used as a safety cap when a non-zero
315 ;             min_age is specified. It should be set relatively high,
316 ;             and it's purpose is to prevent malicious or accidental
317 ;             database overflow due to someone causing an
318 ;             unreasonable number of edits in a short period of time.
319 ;
320 ;   MIN_AGE:  Revisions younger than this (based upon the supplanted
321 ;             date) will be kept unless max_keep is exceeded. The age
322 ;             should be specified in days. It should be a
323 ;             non-negative, real number,
324 ;
325 ;   MIN_KEEP: At least this many revisions will be kept.
326 ;
327 ;   KEEP: No more than this many revisions will be kept.
328 ;
329 ;   MAX_AGE:  No revision older than this age will be kept.
330 ;
331 ; Definitions of terms used above:
332 ;
333 ; Supplanted date: Revisions are timestamped at the instant that they
334 ; cease being the current revision. Revision age is computed using
335 ; this timestamp, not the edit time of the page.
336 ;
337 ; Merging: When a minor revision is deleted, if the preceding
338 ; revision is by the same author, the minor revision is merged with
339 ; the preceding revision before it is deleted. Essentially: this
340 ; replaces the content (and supplanted timestamp) of the previous
341 ; revision with the content after the merged minor edit, the rest of
342 ; the page metadata for the preceding version (summary, mtime, ...)
343 ; is not changed.
344 ;
345 ; Keep up to 8 major edits, but keep them no longer than a month.
346 MAJOR_MAX_AGE = 32
347 MAJOR_KEEP = 8
348
349 ; Keep up to 4 minor edits, but keep them no longer than a week.
350 MINOR_MAX_AGE = 7
351 MINOR_KEEP = 4
352
353 ; Keep the latest contributions of the last 8 authors up to a year.
354 ; Additionally, (in the case of a particularly active page) try to
355 ; keep the latest contributions of all authors in the last week (even
356 ; if there are more than eight of them,) but in no case keep more
357 ; than twenty unique author revisions.
358 AUTHOR_MAX_AGE = 365
359 AUTHOR_KEEP = 8
360 AUTHOR_MIN_AGE = 7
361 AUTHOR_MAX_KEEP = 20
362
363 ;========================================================================
364 ; Part Three: User Authentication
365 ;========================================================================
366 ;
367 ; New user authentication configuration:
368 ; We support three basic authentication methods and a stacked array 
369 ; of advanced auth methods to get and check the passwords:
370 ;
371 ; ALLOW_ANON_USER         default true
372 ; ALLOW_ANON_EDIT         default true
373 ; ALLOW_BOGO_LOGIN        default true
374 ; ALLOW_USER_PASSWORDS    default true
375
376 ; allow anon users to view existing pages
377 ALLOW_ANON_USER = true
378 ; allow anon users to edit pages
379 ALLOW_ANON_EDIT = true
380
381 ; If ALLOW_BOGO_LOGIN is true, users are allowed to login (with
382 ; any/no password) using any userid which: 
383 ;  1) is not the ADMIN_USER, and
384 ;  2) is a valid WikiWord (matches $WikiNameRegexp.)
385 ; If true, users may be created by themselves. Otherwise we need seperate auth. 
386 ; If such a user will create a so called HomePage with his userid, he will 
387 ; be able to store his preferences and password there.
388 ALLOW_BOGO_LOGIN = true
389
390 ; True User Authentication:
391 ; To require user passwords:
392 ;   ALLOW_ANON_USER = false
393 ;   ALLOW_ANON_EDIT = false
394 ;   ALLOW_BOGO_LOGIN = false,
395 ;   ALLOW_USER_PASSWORDS = true.
396 ; Otherwise any anon or bogo user might login without any or a wrong password.
397 ALLOW_USER_PASSWORDS = true
398
399 ; Many different methods can be used to check user's passwords:
400 ;   BogoLogin:     WikiWord username, with no *actual* password checking,
401 ;                   although the user will still have to enter one.
402 ;   PersonalPage:  Store passwords in the users homepage metadata (simple)
403 ;   Db:            Use $DBAuthParams[] (see below) with the PearDB or 
404 ;                   ADODB only.
405 ;   LDAP:          Authenticate against LDAP_AUTH_HOST with LDAP_BASE_DN
406 ;   IMAP:          Authenticate against IMAP_AUTH_HOST (email account)
407 ;   POP3:          Authenticate against POP3_AUTH_HOST (email account)
408 ;   File:          Store username:crypted-passwords in .htaccess like files. 
409 ;                  Use Apache's htpasswd to manage this file.
410 ;   HttpAuth:      Use the protection by the webserver (.htaccess) or 
411 ;                  enforce it
412 ;
413 ; Several of these methods can be used together, in the manner specified by
414 ; USER_AUTH_POLICY, below.  To specify multiple authentication methods,
415 ; separate the name of each one with colons.
416 USER_AUTH_ORDER = "PersonalPage : Db"
417
418 ; For "security" purposes, you can specify that a password be at least a
419 ; certain number of characters long.  This applies even to the BogoLogin
420 ; method.
421 PASSWORD_LENGTH_MINIMUM = 2
422     
423 ; The following policies are available for user authentication:
424 ;       first-only: use only the first method in USER_AUTH_ORDER
425 ;       old:        ignore USER_AUTH_ORDER and try to use all available 
426 ;                       methods as in the previous PhpWiki releases (slow)
427 ;       strict:     check if the user exists for all methods: 
428 ;                       on the first existing user, try the password. 
429 ;                       dont try the other methods on failure then
430 ;       stacked:    check the given user - password combination for all
431 ;                       methods and return true on the first success.
432 USER_AUTH_POLICY = old
433
434 ; LDAP authentication options:
435 ;
436 ; The LDAP server to connect to.  Can either be a hostname, or a complete
437 ; URL to the server (useful if you want to use ldaps or specify a different
438 ; port number).
439 LDAP_AUTH_HOST = "ldap://localhost:389"
440
441 ; The organizational or domain BASE DN: e.g. "dc=mydomain,dc=com".
442 ;
443 ; Note: ou=Users and ou=Groups are used for GroupLdap Membership
444 LDAP_BASE_DN = "ou=Users,o=Development,dc=mycompany.com"
445
446 ; Some LDAP servers need some more options, such as the Windows Active
447 ; Directory Server.  Specify the options (as allowed by the PHP LDAP module)
448 ; and their values as NAME=value pairs separated by colons.
449 ; LDAP_SET_OPTION = "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
450
451 ; DN to bind to the LDAP server as.
452 ; LDAP_AUTH_USER = "CN=ldapuser,CN=Users,DC=uai,DC=int"
453
454 ; Password to use to bind to the LDAP server, as the DN specified in
455 ; the LDAP_AUTH_USER option (above).
456 ; LDAP_AUTH_PASSWORD = s3kr1t
457
458 ; If you want to match usernames against an attribute other than uid,
459 ; specify it here.
460 ; LDAP_SEARCH_FIELD = sAMAccountName
461
462 ; IMAP authentication options:
463 ;
464 ; The IMAP server to check usernames from.  Defaults to localhost.
465 ;
466 ; Some IMAP_AUTH_HOST samples:
467 ;   "localhost", "localhost:143/imap/notls", 
468 ;   "localhost:993/imap/ssl/novalidate-cert" (SuSE refuses non-SSL conections)
469 ; IMAP_AUTH_HOST = "localhost:143/imap/notls"
470
471 ; POP3 authentication options:
472 ;
473 ; Host to connect to.
474 ; POP3_AUTH_HOST = "localhost:110"
475
476 ; Port to connect. Deprecated: Use POP3_AUTH_HOST:<port> instead
477 ; POP3_AUTH_PORT = 110
478
479 ; File authentication options:
480 ;
481 ; File to read for authentication information.
482 ; Popular choices are /etc/shadow and /etc/httpd/.htpasswd
483 ; AUTH_USER_FILE = /etc/shadow
484
485 ; Defines whether the user is able to change their own password via PHPWiki.
486 ; Note that this means that the webserver user must be able to write to the
487 ; file specified in AUTH_USER_FILE.
488 ; AUTH_USER_FILE_STORABLE = false
489
490 ; Session Auth:
491 ; Name of the session variable which holds the already authenticated username
492 ; AUTH_SESS_USER = userid
493 ; Which level will the user be? 1 = Bogo or 2 = Pass
494 ; AUTH_SESS_LEVEL = 2
495
496 ; Group membership.  PHPWiki supports defining permissions for a group as
497 ; well as for individual users.  This defines how group membership information
498 ; is obtained.  Supported values are:
499 ;
500 ;       NONE            group membership is not supported.
501 ;       WIKIPAGE        Defined in the metadata of a wiki page.
502 ;       DB              Stored in an ADODB or PearDB database.
503 ;       FILE            Flatfile.
504 ;       LDAP            Query LDAP to find the information.
505 GROUP_METHOD = WIKIPAGE
506
507 ; For GROUP_METHOD = FILE, the file given below is referenced to obtain
508 ; group membership information.  It should be in the same format as the
509 ; standard unix /etc/groups(5) file.
510 ; AUTH_GROUP_FILE = /etc/groups
511
512 ; External database authentication and authorization.
513 ;
514 ; If USER_AUTH_ORDER includes Db, or GROUP_METHOD = DB, the options listed
515 ; below define the SQL queries used to obtain the information out of the
516 ; database, and (in some cases) store the information back to the DB.
517 ;
518 ; The options appropriate for each query are currently undocumented, and
519 ; you should not be surprised if things change mightily in the future.
520 ;
521 ; A database DSN to connect to.  Defaults to the DSN specified for the Wiki
522 ; as a whole.
523 ; DBAUTH_AUTH_DSN = "mysql://wikiuser:@localhost/phpwiki"
524 ;
525 ; USER/PASSWORD queries
526 ;
527 ; Check to see if the supplied username/password pair is OK
528 ;
529 ; plaintext passwords:
530 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd='$password',1,0) FROM user WHERE userid='$userid'"
531 ;
532 ; database-hashed passwords (more secure):
533 ; DBAUTH_AUTH_CHECK = "SELECT IF(passwd=PASSWORD('$password'),1,0) FROM user WHERE userid='$userid'"
534 DBAUTH_AUTH_CRYPT_METHOD = plain
535
536 ; If you want to use Unix crypt()ed passwords, you can use DBAUTH_AUTH_CHECK
537 ; to get the password out of the database with a simple SELECT query, and
538 ; specify DBAUTH_AUTH_USER_EXISTS and DBAUTH_AUTH_CRYPT_METHOD:
539 ; DBAUTH_AUTH_CHECK = "SELECT password FROM user where userid='$userid'"
540 ; DBAUTH_AUTH_USER_EXISTS = "SELECT userid FROM user WHERE userid='$userid'"
541 ; DBAUTH_AUTH_CRYPT_METHOD = crypt
542 ;
543 ; Update the user's authentication credential.  If this is not defined but
544 ; DBAUTH_AUTH_CHECK is, then the user will be unable to update their
545 ; password.
546 ;
547 ; Plaintext passwords:
548 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd='$password' WHERE userid='$userid'"
549 ; Database-hashed passwords:
550 ; DBAUTH_AUTH_UPDATE = "UPDATE user SET passwd=PASSWORD('$password') WHERE userid='$userid'"
551 ;
552 ; Allow the user to create their own account.
553 ; DBAUTH_AUTH_CREATE = "INSERT INTO user SET passwd=PASSWORD('$password'),userid='$userid'"
554
555 ; USER/PREFERENCE queries
556 ;
557 ; If you choose to store your preferences in an external database, enable
558 ; the following queries.  Note that if you choose to store user preferences
559 ; in the 'user' table, only registered users get their prefs from the database,
560 ; self-created users do not.  Better to use the special 'pref' table.
561 ;
562 ; The prefs field stores the serialized form of the user's preferences array,
563 ; to ease the complication of storage.
564 ; DBAUTH_PREF_SELECT = SELECT prefs FROM user WHERE userid='$userid'
565 ; DBAUTH_PREF_SELECT = SELECT prefs FROM pref WHERE userid='$userid'
566
567 ; Update the user's preferences
568 ; DBAUTH_PREF_UPDATE = UPDATE user SET prefs='$pref_blob' WHERE userid='$userid'
569 ; DBAUTH_PREF_UPDATE = "REPLACE INTO pref SET prefs='$pref_blob',userid='$userid'"
570
571 ; USERS/GROUPS queries
572 ;
573 ; You can define 1:n or n:m user<=>group relations, as you wish.
574 ;
575 ; Sample configurations:
576 ;  only one group per user (1:n):
577 ;   DBAUTH_IS_MEMBER = SELECT user FROM user WHERE user='$userid' AND group='$groupname'
578 ;   DBAUTH_GROUP_MEMBERS = SELECT user FROM user WHERE group='$groupname'
579 ;   DBAUTH_USER_GROUPS = SELECT group FROM user WHERE user='$userid'
580 ;  multiple groups per user (n:m):
581 ;   DBAUTH_IS_MEMBER = SELECT userid FROM member WHERE userid='$userid' AND groupname='$groupname'
582 ;   DBAUTH_GROUP_MEMBERS = SELECT DISTINCT userid FROM member WHERE groupname='$groupname'
583 ;   DBAUTH_USER_GROUPS = SELECT groupname FROM member WHERE userid='$userid'
584
585 ; A interim page which gets displayed on every edit attempt
586 EDITING_POLICY = EditingPolicy
587
588 ;========================================================================
589 ; Part Four: Page appearance and layout
590 ;========================================================================
591
592 ; THEMES
593 ;
594 ; Most of the page appearance is controlled by files in the theme
595 ; subdirectory.
596 ;
597 ; There are a number of pre-defined themes shipped with PhpWiki.
598 ; Or you may create your own (e.g. by copying and then modifying one of
599 ; stock themes.)
600 ;
601 ; The complete list of installed themes can be found by doing 'ls themes/'
602 ; from the root of your PHPWiki installation.
603 THEME = default
604 ; THEME = MacOSX
605 ; THEME = smaller
606 ; THEME = Wordpress
607 ; THEME = Portland
608 ; THEME = Hawaiian
609 ; THEME = Sidebar
610 ; THEME = Crao
611 ; THEME = wikilens
612
613 ; Select a valid charset name to be inserted into the xml/html pages,
614 ; and to reference links to the stylesheets (css). For more info see:
615 ; <http://www.iana.org/assignments/character-sets>. Note that PhpWiki
616 ; has been extensively tested only with the latin1 (iso-8859-1)
617 ; character set.
618 ;
619 ; If you change the default from iso-8859-1 PhpWiki may not work
620 ; properly and will require code modifications, at the very least you
621 ; will have to convert the files in pgsrc or locale/xx/pgsrc to
622 ; match!
623 ;
624 ; Character sets similar to iso-8859-1 may work with little or no
625 ; modification depending on your setup. The database must also
626 ; support the same charset, and of course the same is true for the
627 ; web browser. (Some work is in progress hopefully to allow more
628 ; flexibility in this area in the future).
629 CHARSET = iso-8859-1
630
631 ; Select your language/locale - default language is "en" for English.
632 ; Other languages available:
633 ; English "en"  (English    - HomePage)
634 ; Dutch   "nl" (Nederlands - ThuisPagina)
635 ; Spanish "es" (Español    - PáginaPrincipal)
636 ; French  "fr" (Français   - Accueil)
637 ; German  "de" (Deutsch    - StartSeite)
638 ; Swedish "sv" (Svenska    - Framsida)
639 ; Italian "it" (Italiano   - PaginaPrincipale)
640 ; Japanese "ja" (Japanese   - ¥Û¡¼¥à¥Ú¡¼¥¸)
641 ; Chinese  "zh" (Chinese   - ?)
642 ;
643 ; If you set DEFAULT_LANGUAGE to the empty string, your system's
644 ; default language (as determined by the applicable environment
645 ; variables) will be used.
646 ; If you plan to support Japanese or Chinese, CHARSET=utf-8 must be used.
647 ;
648 DEFAULT_LANGUAGE = en
649
650 ; WIKI_PGSRC -- specifies the source for the initial page contents of
651 ; the Wiki. The setting of WIKI_PGSRC only has effect when the wiki is
652 ; accessed for the first time (or after clearing the database.)
653 ; WIKI_PGSRC can either name a directory or a zip file. In either case
654 ; WIKI_PGSRC is scanned for files -- one file per page.
655 WIKI_PGSRC = pgsrc
656
657 ; DEFAULT_WIKI_PGSRC is only used when the language is *not* the
658 ; default (English) and when reading from a directory: in that case
659 ; some English pages are inserted into the wiki as well.
660 ; DEFAULT_WIKI_PGSRC defines where the English pages reside.
661 ;
662 ; FIXME: is this really needed?  Can't we just copy these pages into
663 ; the localized pgsrc?
664 DEFAULT_WIKI_PGSRC = pgsrc
665 ; These are the pages which will get loaded from DEFAULT_WIKI_PGSRC.
666 DEFAULT_WIKI_PAGES = "ReleaseNotes:SteveWainstead:TestPage"
667
668 ;=========================================================================
669 ; Part Five: Mark-up options.
670 ;=========================================================================
671 ;
672 ; allowed protocols for links - be careful not to allow "javascript:"
673 ; URL of these types will be automatically linked.
674 ; within a named link [name|uri] one more protocol is defined: phpwiki
675 ; Separate each of the protocol names with a vertical pipe, and ensure there
676 ; is no extraneous whitespace.
677 ALLOWED_PROTOCOLS = "http|https|mailto|ftp|news|nntp|ssh|gopher"
678
679 ; URLs ending with the following extension should be inlined as images.
680 ; Specify as per ALLOWED_PROTOCOLS
681 INLINE_IMAGES = "png|jpg|gif"
682
683 ; Perl regexp for WikiNames ("bumpy words")
684 ; (?<!..) & (?!...) used instead of '\b' because \b matches '_' as well
685 WIKI_NAME_REGEXP = "(?<![[:alnum:]])(?:[[:upper:]][[:lower:]]+){2,}(?![[:alnum:]])"
686
687 ; Defaults to '/', but '.' was also used.
688 SUBPAGE_SEPARATOR = /
689
690 ; InterWiki linking -- wiki-style links to other wikis on the web
691 ;
692 ; The map will be taken from a page name InterWikiMap.
693 ; If that page is not found (or is not locked), or map
694 ; data can not be found in it, then the file specified
695 ; by INTERWIKI_MAP_FILE (if any) will be used.
696 INTERWIKI_MAP_FILE = lib/interwiki.map
697
698 ; Display a warning if the internal lib/interwiki.map is used, and 
699 ; not the public InterWikiMap page. This file is not readable from outside.
700 WARN_NONPUBLIC_INTERWIKIMAP = false
701
702 ; Regexp used for automatic keyword extraction.
703 ;
704 ; Any links on a page to pages whose names match this regexp will
705 ; be used keywords in the keywords meta tag.  (This is an aid to
706 ; classification by search engines.)  The value of the match is
707 ; used as the keyword.
708 ;
709 ; The default behavior is to match Category* and Topic* links.
710 KEYWORDS = "Category:Topic"
711 ;KEYWORD_LINK_REGEXP = "(?<=^\'. join(\'|^\', $keywords) . \')[[:upper:]].*$"
712
713 ; Author and Copyright Site Navigation Links
714 ;
715 ; These will be inserted as <link rel> tags in the html header of
716 ; every page, for search engines and for browsers like Mozilla which
717 ; take advantage of link rel site navigation.
718 ;
719 ; If you have your own copyright and contact information pages change
720 ; these as appropriate.
721 COPYRIGHTPAGE_TITLE = GNU General Public License
722 COPYRIGHTPAGE_URL = http://www.gnu.org/copyleft/gpl.html#SEC1
723 AUTHORPAGE_TITLE = The PhpWiki Programming Team
724 AUTHORPAGE_URL = http://phpwiki.sourceforge.net/phpwiki/ThePhpWikiProgrammingTeam
725
726 ; Allow full markup in headers to be parsed by the CreateToc plugin.
727 ;
728 ; If false you may not use WikiWords or [] links or any other markup in 
729 ; headers in pages with the CreateToc plugin. But if false the parsing is 
730 ; faster and more stable.
731 TOC_FULL_SYNTAX = true
732
733 ;==========================================================================
734 ; Part Six: URL options.
735 ;==========================================================================
736 ;
737 ; You can probably skip this section.
738
739 ; The following section contains settings which you can use to tailor
740 ; the URLs which PhpWiki generates.
741 ;
742 ; Any of these parameters which are left undefined will be deduced
743 ; automatically. You need only set them explicitly if the
744 ; auto-detected values prove to be incorrect.
745 ;
746 ; In most cases the auto-detected values should work fine, so
747 ; hopefully you don't need to mess with this section.
748 ;
749 ; In case of local overrides of short placeholders, which themselves 
750 ; include index.php, we check for most constants. See '/wiki'.
751 ; We can override DATA_PATH and PHPWIKI_DIR to support multiple phpwiki 
752 ; versions (for development), but most likely other values like 
753 ; THEME, LANG and DbParams for a WikiFarm.
754
755 ; Canonical name and httpd port of the server on which this PhpWiki
756 ; resides.
757 ;/
758 ;SERVER_NAME = some.host.com
759 ;SERVER_PORT = 80
760
761 ; Relative URL (from the server root) of the PhpWiki
762 ; script.
763 ;SCRIPT_NAME = /some/where/index.php
764
765 ; URL of the PhpWiki install directory.  (You only need to set this
766 ; if you've moved index.php out of the install directory.)  This can
767 ; be either a relative URL (from the directory where the top-level
768 ; PhpWiki script is) or an absolute one.
769 ;DATA_PATH = /home/user/phpwiki
770
771 ; Path to the PhpWiki install directory.  This is the local
772 ; filesystem counterpart to DATA_PATH.  (If you have to set
773 ; DATA_PATH, your probably have to set this as well.)  This can be
774 ; either an absolute path, or a relative path interpreted from the
775 ; directory where the top-level PhpWiki script (normally index.php)
776 ; resides.
777 ;PHPWIKI_DIR = /home/user/public_html/phpwiki
778
779 ; PhpWiki will try to use short urls to pages, eg 
780 ; http://www.example.com/index.php/HomePage
781 ; If you want to use urls like 
782 ; http://www.example.com/index.php?pagename=HomePage
783 ; then define 'USE_PATH_INFO' as false by uncommenting the line below.
784 ; NB:  If you are using Apache >= 2.0.30, then you may need to to use
785 ; the directive "AcceptPathInfo On" in your Apache configuration file
786 ; (or in an appropriate <.htaccess> file) for the short urls to work:  
787 ; See http://httpd.apache.org/docs-2.0/mod/core.html#acceptpathinfo
788
789 ; See also http://phpwiki.sourceforge.net/phpwiki/PrettyWiki for more ideas
790 ; on prettifying your urls.
791 ;
792 ; Note that Google doesn't follow the default /index.php/PageName links.
793 ; You must use either a PrettyWiki setup (see below), or force USE_PATH_INFO=false.
794 ;
795 ; Default: PhpWiki will try to divine whether use of PATH_INFO
796 ; is supported in by your webserver/PHP configuration, and will
797 ; use PATH_INFO if it thinks that is possible.
798 ;USE_PATH_INFO = false
799
800 ; VIRTUAL_PATH is the canonical URL path under which your your wiki
801 ; appears. Normally this is the same as dirname(SCRIPT_NAME), however
802 ; using, e.g. apaches mod_actions (or mod_rewrite), you can make it
803 ; something different.
804 ;
805 ; If you do this, you should set VIRTUAL_PATH here.
806 ;
807 ; E.g. your phpwiki might be installed at at /scripts/phpwiki/index.php,
808 ; but  * you've made it accessible through eg. /wiki/HomePage.
809 ;
810 ; One way to do this is to create a directory named 'wiki' in your
811 ; server root. The directory contains only one file: an .htaccess
812 ; file which reads something like:
813 ;
814 ;    Action x-phpwiki-page /scripts/phpwiki/index.php
815 ;    SetHandler x-phpwiki-page
816 ;    DirectoryIndex /scripts/phpwiki/index.php
817 ;
818 ; In that case you should set VIRTUAL_PATH to '/wiki'.
819 ;
820 ; (VIRTUAL_PATH is only used if USE_PATH_INFO is true.)
821 ;/
822 ;VIRTUAL_PATH = /SomeWiki
823
824 ;===========================================================================
825 ; Part Seven: Miscellaneous settings
826 ;===========================================================================
827
828 ; Disable HTTP redirects.
829 ;
830 ; (You probably don't need to touch this.)
831 ;
832 ; PhpWiki uses HTTP redirects for some of it's functionality.
833 ; (e.g. after saving changes, PhpWiki redirects your browser to
834 ; view the page you just saved.)
835 ;
836 ; Some web service providers (notably free European Lycos) don't seem to
837 ; allow these redirects.  (On Lycos the result in an "Internal Server Error"
838 ; report.)  In that case you can set DISABLE_HTTP_REDIRECT to true.
839 ; (In which case, PhpWiki will revert to sneakier tricks to try to
840 ; redirect the browser...)
841 ;DISABLE_HTTP_REDIRECT = true