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