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