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