2 // PukiWiki - Yet another WikiWikiWeb clone
5 // 2002-2016 PukiWiki Development Team
6 // 2001-2002 Originally written by yu-ji
7 // License: GPL v2 or (at your option) any later version
9 // PukiWiki main setting file
11 /////////////////////////////////////////////////
12 // Functionality settings
14 // PKWK_OPTIMISE - Ignore verbose but understandable checking and warning
15 // If you end testing this PukiWiki, set '1'.
16 // If you feel in trouble about this PukiWiki, set '0'.
17 if (! defined('PKWK_OPTIMISE'))
18 define('PKWK_OPTIMISE', 0);
20 /////////////////////////////////////////////////
23 // PKWK_READONLY - Prohibits editing and maintain via WWW
24 // NOTE: Counter-related functions will work now (counter, attach count, etc)
25 if (! defined('PKWK_READONLY'))
26 define('PKWK_READONLY', 0); // 0 or 1
28 // PKWK_SAFE_MODE - Prohibits some unsafe(but compatible) functions
29 if (! defined('PKWK_SAFE_MODE'))
30 define('PKWK_SAFE_MODE', 0);
32 // PKWK_DISABLE_INLINE_IMAGE_FROM_URI - Disallow using inline-image-tag for URIs
33 // Inline-image-tag for URIs may allow leakage of Wiki readers' information
34 // (in short, 'Web bug') or external malicious CGI (looks like an image's URL)
35 // attack to Wiki readers, but easy way to show images.
36 if (! defined('PKWK_DISABLE_INLINE_IMAGE_FROM_URI'))
37 define('PKWK_DISABLE_INLINE_IMAGE_FROM_URI', 0);
39 // PKWK_QUERY_STRING_MAX
40 // Max length of GET method, prohibits some worm attack ASAP
41 // NOTE: Keep (page-name + attach-file-name) <= PKWK_QUERY_STRING_MAX
42 define('PKWK_QUERY_STRING_MAX', 640); // Bytes, 0 = OFF
44 /////////////////////////////////////////////////
45 // Experimental features
47 // Multiline plugin hack (See BugTrack2/84)
48 // EXAMPLE(with a known BUG):
49 // #plugin(args1,args2,...,argsN){{
55 // #memo(This makes '#memo(foo)' to this)
56 define('PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK', 1); // 1 = Disabled
58 /////////////////////////////////////////////////
59 // Language / Encoding settings
61 // LANG - Internal content encoding ('en', 'ja', or ...)
64 // UI_LANG - Content encoding for buttons, menus, etc
65 define('UI_LANG', LANG); // 'en' for Internationalized wikisite
67 /////////////////////////////////////////////////
68 // Directory settings I (ended with '/', permission '777')
70 // You may hide these directories (from web browsers)
71 // by setting DATA_HOME at index.php.
73 define('DATA_DIR', DATA_HOME . 'wiki/' ); // Latest wiki texts
74 define('DIFF_DIR', DATA_HOME . 'diff/' ); // Latest diffs
75 define('BACKUP_DIR', DATA_HOME . 'backup/' ); // Backups
76 define('CACHE_DIR', DATA_HOME . 'cache/' ); // Some sort of caches
77 define('UPLOAD_DIR', DATA_HOME . 'attach/' ); // Attached files and logs
78 define('COUNTER_DIR', DATA_HOME . 'counter/' ); // Counter plugin's counts
79 define('PLUGIN_DIR', DATA_HOME . 'plugin/' ); // Plugin directory
81 /////////////////////////////////////////////////
82 // Directory settings II (ended with '/')
84 // Skins / Stylesheets
85 define('SKIN_DIR', 'skin/');
86 // Skin files (SKIN_DIR/*.skin.php) are needed at
87 // ./DATAHOME/SKIN_DIR from index.php, but
88 // CSSs(*.css) and JavaScripts(*.js) are needed at
89 // ./SKIN_DIR from index.php.
92 define('IMAGE_DIR', 'image/');
93 // Keep this directory shown via web browsers like
94 // ./IMAGE_DIR from index.php.
96 /////////////////////////////////////////////////
99 switch (LANG) { // or specifiy one
101 define('ZONE', 'JST');
102 define('ZONETIME', 9 * 3600); // JST = GMT + 9
105 define('ZONE', 'GMT');
106 define('ZONETIME', 0);
110 /////////////////////////////////////////////////
111 // Title of your Wikisite (Name this)
112 // Also used as RSS feed's channel name etc
113 $page_title = 'PukiWiki';
115 // Specify PukiWiki URL (default: auto)
116 //$script = 'http://example.com/pukiwiki/';
118 // Shorten $script: Cut its file name (default: not cut)
119 //$script_directory_index = 'index.php';
121 // Site admin's name (CHANGE THIS)
122 $modifier = 'anonymous';
124 // Site admin's Web page (CHANGE THIS)
125 $modifierlink = 'http://pukiwiki.example.com/';
128 $defaultpage = 'FrontPage'; // Top / Default page
129 $whatsnew = 'RecentChanges'; // Modified page list
130 $whatsdeleted = 'RecentDeleted'; // Removeed page list
131 $interwiki = 'InterWikiName'; // Set InterWiki definition here
132 $menubar = 'MenuBar'; // Menu
134 /////////////////////////////////////////////////
135 // Change default Document Type Definition
137 // Some web browser's bug, and / or Java apprets may needs not-Strict DTD.
138 // Some plugin (e.g. paint) set this PKWK_DTD_XHTML_1_0_TRANSITIONAL.
140 //$pkwk_dtd = PKWK_DTD_XHTML_1_1; // Default
141 //$pkwk_dtd = PKWK_DTD_XHTML_1_0_STRICT;
142 //$pkwk_dtd = PKWK_DTD_XHTML_1_0_TRANSITIONAL;
143 //$pkwk_dtd = PKWK_DTD_HTML_4_01_STRICT;
144 //$pkwk_dtd = PKWK_DTD_HTML_4_01_TRANSITIONAL;
146 /////////////////////////////////////////////////
147 // Always output "nofollow,noindex" attribute
149 $nofollow = 0; // 1 = Try hiding from search engines
151 /////////////////////////////////////////////////
153 // PKWK_ALLOW_JAVASCRIPT - Must be 1 only for compatibility
154 define('PKWK_ALLOW_JAVASCRIPT', 1);
156 /////////////////////////////////////////////////
157 // _Disable_ WikiName auto-linking
160 /////////////////////////////////////////////////
163 // AutoLink minimum length of page name
164 $autolink = 0; // Bytes, 0 = OFF (try 8)
166 /////////////////////////////////////////////////
167 // Enable Freeze / Unfreeze feature
168 $function_freeze = 1;
170 /////////////////////////////////////////////////
171 // Allow to use 'Do not change timestamp' checkbox
172 // (0:Disable, 1:For everyone, 2:Only for the administrator)
175 /////////////////////////////////////////////////
176 // Admin password for this Wikisite
178 // Default: always fail
179 $adminpass = '{x-php-md5}!';
182 //$adminpass = 'pass'; // Cleartext
183 //$adminpass = '{x-php-md5}1a1dc91c907325c69271ddf0c944bc72'; // PHP md5() 'pass'
184 //$adminpass = '{CRYPT}$1$AR.Gk94x$uCe8fUUGMfxAPH83psCZG/'; // LDAP CRYPT 'pass'
185 //$adminpass = '{MD5}Gh3JHJBzJcaScd3wyUS8cg=='; // LDAP MD5 'pass'
186 //$adminpass = '{SMD5}o7lTdtHFJDqxFOVX09C8QnlmYmZnd2Qx'; // LDAP SMD5 'pass'
188 /////////////////////////////////////////////////
189 // Page-reading feature settings
190 // (Automatically creating pronounce datas, for Kanji-included page names,
191 // to show sorted page-list correctly)
193 // Enable page-reading feature by calling ChaSen or KAKASHI command
194 // (1:Enable, 0:Disable)
195 $pagereading_enable = 0;
197 // Specify converter as ChaSen('chasen') or KAKASI('kakasi') or None('none')
198 $pagereading_kanji2kana_converter = 'none';
200 // Specify Kanji encoding to pass data between PukiWiki and the converter
201 $pagereading_kanji2kana_encoding = 'EUC'; // Default for Unix
202 //$pagereading_kanji2kana_encoding = 'SJIS'; // Default for Windows
204 // Absolute path of the converter (ChaSen)
205 $pagereading_chasen_path = '/usr/local/bin/chasen';
206 //$pagereading_chasen_path = 'c:\progra~1\chasen21\chasen.exe';
208 // Absolute path of the converter (KAKASI)
209 $pagereading_kakasi_path = '/usr/local/bin/kakasi';
210 //$pagereading_kakasi_path = 'c:\kakasi\bin\kakasi.exe';
212 // Page name contains pronounce data (written by the converter)
213 $pagereading_config_page = ':config/PageReading';
215 // Page name of default pronouncing dictionary, used when converter = 'none'
216 $pagereading_config_dict = ':config/PageReading/dict';
219 /////////////////////////////////////////////////
220 // Authentication type
221 // AUTH_TYPE_NONE, AUTH_TYPE_FORM, AUTH_TYPE_BASIC, AUTH_TYPE_EXTERNAL, ...
222 // $auth_type = AUTH_TYPE_FORM;
223 // $auth_external_login_url_base = './exlogin.php';
225 /////////////////////////////////////////////////
227 $ldap_user_account = 0; // (0: Disabled, 1: Enabled)
228 // $ldap_server = 'ldap://ldapserver:389';
229 // $ldap_base_dn = 'ou=Users,dc=ldap,dc=example,dc=com';
230 // $ldap_bind_dn = 'uid=$login,dc=example,dc=com';
231 // $ldap_bind_password = '';
233 /////////////////////////////////////////////////
234 // User prefix that shows its auth provider
235 $auth_provider_user_prefix_default = 'default:';
236 $auth_provider_user_prefix_ldap = 'ldap:';
237 $auth_provider_user_prefix_external = 'external:';
238 $auth_provider_user_prefix_saml = 'saml:';
241 /////////////////////////////////////////////////
244 // Username => password
245 'foo' => 'foo_passwd', // Cleartext
246 'bar' => '{x-php-md5}f53ae779077e987718cc285b14dfbe86', // PHP md5() 'bar_passwd'
247 'hoge' => '{SMD5}OzJo/boHwM4q5R+g7LCOx2xGMkFKRVEx', // LDAP SMD5 'hoge_passwd'
251 $auth_groups = array(
252 // Groupname => group members(users)
253 'valid-user' => '', // Reserved 'valid-user' group contains all authenticated users
254 'groupfoobar' => 'foo,bar',
257 /////////////////////////////////////////////////
258 // Authentication method
260 $auth_method_type = 'pagename'; // By Page name
261 //$auth_method_type = 'contents'; // By Page contents
263 /////////////////////////////////////////////////
264 // Read auth (0:Disable, 1:Enable)
267 $read_auth_pages = array(
268 // Regex Groupname or Username
269 '#PageForAllValidUsers#' => 'valid-user',
270 '#HogeHoge#' => 'hoge',
271 '#(NETABARE|NetaBare)#' => 'foo,bar,hoge',
274 /////////////////////////////////////////////////
275 // Edit auth (0:Disable, 1:Enable)
278 $edit_auth_pages = array(
280 '#BarDiary#' => 'bar',
281 '#HogeHoge#' => 'hoge',
282 '#(NETABARE|NetaBare)#' => 'foo,bar,hoge',
285 /////////////////////////////////////////////////
287 // 0: Disabled (Search read-prohibited page contents)
288 // 1: Enabled (Search only permitted pages for the user)
291 /////////////////////////////////////////////////
293 $ticket_link_sites = array(
297 'type' => 'redmine', // type: redmine, jira or git
298 'title' => 'PHP :: Bug #$1',
299 'base_url' => 'https://bugs.php.net/bug.php?id=',
304 'title' => 'ASF JIRA [$1]',
305 'base_url' => 'https://issues.apache.org/jira/browse/',
308 'key' => 'pukiwiki-commit',
310 'title' => 'PukiWiki revision $1',
311 'base_url' => 'https://ja.osdn.net/projects/pukiwiki/scm/git/pukiwiki/commits/',
316 /////////////////////////////////////////////////
317 // $whatsnew: Max number of RecentChanges
320 // $whatsdeleted: Max number of RecentDeleted
322 $maxshow_deleted = 60;
324 /////////////////////////////////////////////////
325 // Page names can't be edit via PukiWiki
326 $cantedit = array( $whatsnew, $whatsdeleted );
328 /////////////////////////////////////////////////
329 // HTTP: Output Last-Modified header
332 /////////////////////////////////////////////////
334 $date_format = 'Y-m-d';
337 $time_format = 'H:i:s';
339 /////////////////////////////////////////////////
340 // Max number of RSS feed
343 /////////////////////////////////////////////////
344 // Backup related settings
349 // When a page had been removed, remove its backup too?
352 // Bacukp interval and generation
353 $cycle = 3; // Wait N hours between backup (0 = no wait)
354 $maxage = 120; // Stock latest N backups
356 // NOTE: $cycle x $maxage / 24 = Minimum days to lost your data
359 // Splitter of backup data (NOTE: Too dangerous to change)
360 define('PKWK_SPLITTER', '>>>>>>>>>>');
362 /////////////////////////////////////////////////
363 // Command execution per update
365 define('PKWK_UPDATE_EXEC', '');
367 // Sample: Namazu (Search engine)
368 //$target = '/var/www/wiki/';
369 //$mknmz = '/usr/bin/mknmz';
370 //$output_dir = '/var/lib/namazu/index/';
371 //define('PKWK_UPDATE_EXEC',
372 // $mknmz . ' --media-type=text/pukiwiki' .
373 // ' -O ' . $output_dir . ' -L ja -c -K ' . $target);
375 /////////////////////////////////////////////////
376 // HTTP proxy setting
378 // Use HTTP proxy server to get remote data
381 $proxy_host = 'proxy.example.com';
384 // Do Basic authentication
385 $need_proxy_auth = 0;
386 $proxy_auth_user = 'username';
387 $proxy_auth_pass = 'password';
389 // Hosts that proxy server will not be needed
391 'localhost', // localhost
392 '127.0.0.0/8', // loopback
393 // '10.0.0.0/8' // private class A
394 // '172.16.0.0/12' // private class B
395 // '192.168.0.0/16' // private class C
399 ////////////////////////////////////////////////
400 // Mail related settings
402 // Send mail per update of pages
406 $notify_diff_only = 1;
408 // SMTP server (Windows only. Usually specified at php.ini)
409 $smtp_server = 'localhost';
411 // Mail recipient (To:) and sender (From:)
412 $notify_to = 'to@example.com'; // To:
413 $notify_from = 'from@example.com'; // From:
415 // Subject: ($page = Page name wll be replaced)
416 $notify_subject = '[PukiWiki] $page';
419 // NOTE: Multiple items must be divided by "\r\n", not "\n".
422 /////////////////////////////////////////////////
423 // Mail: POP / APOP Before SMTP
425 // Do POP/APOP authentication before send mail
428 $pop_server = 'localhost';
433 // Use APOP instead of POP (If server uses)
434 // Default = Auto (Use APOP if possible)
435 // 1 = Always use APOP
436 // 0 = Always use POP
437 // $pop_auth_use_apop = 1;
439 /////////////////////////////////////////////////
442 // Regex of ignore pages
445 // Search ignored pages
446 $search_non_list = 1;
449 // Page redirect rules
450 $page_redirect_rules = array(
451 //'#^FromProject($|(/(.+)$))#' => 'ToProject$1',
452 //'#^FromProject($|(/(.+)$))#' => function($matches) { return 'ToProject' . $matches[1]; },
455 /////////////////////////////////////////////////
458 $auto_template_func = 1;
459 $auto_template_rules = array(
460 '((.+)\/([^\/]+))' => '\2/template'
463 /////////////////////////////////////////////////
464 // Automatically add fixed heading anchor
465 $fixed_heading_anchor = 1;
467 /////////////////////////////////////////////////
468 // Remove the first spaces from Preformatted text
469 $preformat_ltrim = 1;
471 /////////////////////////////////////////////////
472 // Convert linebreaks into <br />
475 /////////////////////////////////////////////////
476 // Use date-time rules (See rules.ini.php)
479 /////////////////////////////////////////////////
480 // Logging updates (0 or 1)
481 $logging_updates = 0;
482 $logging_updates_log_dir = '/var/log/pukiwiki';
484 /////////////////////////////////////////////////
485 // User-Agent settings
487 // If you want to ignore embedded browsers for rich-content-wikisite,
488 // remove (or comment-out) all 'keitai' settings.
490 // If you want to to ignore desktop-PC browsers for simple wikisite,
491 // copy keitai.ini.php to default.ini.php and customize it.
494 // pattern: A regular-expression that matches device(browser)'s name and version
495 // profile: A group of browsers
497 // Embedded browsers (Rich-clients for PukiWiki)
499 // Windows CE (Microsoft(R) Internet Explorer 5.5 for Windows(R) CE)
500 // Sample: "Mozilla/4.0 (compatible; MSIE 5.5; Windows CE; sigmarion3)" (sigmarion, Hand-held PC)
501 array('pattern'=>'#\b(?:MSIE [5-9]).*\b(Windows CE)\b#', 'profile'=>'default'),
503 // ACCESS "NetFront" / "Compact NetFront" and thier OEM, expects to be "Mozilla/4.0"
504 // Sample: "Mozilla/4.0 (PS2; PlayStation BB Navigator 1.0) NetFront/3.0" (PlayStation BB Navigator, for SONY PlayStation 2)
505 // Sample: "Mozilla/4.0 (PDA; PalmOS/sony/model crdb/Revision:1.1.19) NetFront/3.0" (SONY Clie series)
506 // Sample: "Mozilla/4.0 (PDA; SL-A300/1.0,Embedix/Qtopia/1.1.0) NetFront/3.0" (SHARP Zaurus)
507 array('pattern'=>'#^(?:Mozilla/4).*\b(NetFront)/([0-9\.]+)#', 'profile'=>'default'),
509 // Embedded browsers (Non-rich)
511 // Windows CE (the others)
512 // Sample: "Mozilla/2.0 (compatible; MSIE 3.02; Windows CE; 240x320 )" (GFORT, NTT DoCoMo)
513 array('pattern'=>'#\b(Windows CE)\b#', 'profile'=>'keitai'),
515 // ACCESS "NetFront" / "Compact NetFront" and thier OEM
516 // Sample: "Mozilla/3.0 (AveFront/2.6)" ("SUNTAC OnlineStation", USB-Modem for PlayStation 2)
517 // Sample: "Mozilla/3.0(DDIPOCKET;JRC/AH-J3001V,AH-J3002V/1.0/0100/c50)CNF/2.0" (DDI Pocket: AirH" Phone by JRC)
518 array('pattern'=>'#\b(NetFront)/([0-9\.]+)#', 'profile'=>'keitai'),
519 array('pattern'=>'#\b(CNF)/([0-9\.]+)#', 'profile'=>'keitai'),
520 array('pattern'=>'#\b(AveFront)/([0-9\.]+)#', 'profile'=>'keitai'),
521 array('pattern'=>'#\b(AVE-Front)/([0-9\.]+)#', 'profile'=>'keitai'), // The same?
523 // NTT-DoCoMo, i-mode (embeded Compact NetFront) and FOMA (embedded NetFront) phones
524 // Sample: "DoCoMo/1.0/F501i", "DoCoMo/1.0/N504i/c10/TB/serXXXX" // c以降は可変
525 // Sample: "DoCoMo/2.0 MST_v_SH2101V(c100;TB;W22H12;serXXXX;iccxxxx)" // ()の中は可変
526 array('pattern'=>'#^(DoCoMo)/([0-9\.]+)#', 'profile'=>'keitai'),
528 // Vodafone's embedded browser
529 // Sample: "J-PHONE/2.0/J-T03" // 2.0は"ブラウザの"バージョン
530 // Sample: "J-PHONE/4.0/J-SH51/SNxxxx SH/0001a Profile/MIDP-1.0 Configuration/CLDC-1.0 Ext-Profile/JSCL-1.1.0"
531 array('pattern'=>'#^(J-PHONE)/([0-9\.]+)#', 'profile'=>'keitai'),
533 // Openwave(R) Mobile Browser (EZweb, WAP phone, etc)
534 // Sample: "OPWV-SDK/62K UP.Browser/6.2.0.5.136 (GUI) MMP/2.0"
535 array('pattern'=>'#\b(UP\.Browser)/([0-9\.]+)#', 'profile'=>'keitai'),
537 // Opera, dressing up as other embedded browsers
538 // Sample: "Mozilla/3.0(DDIPOCKET;KYOCERA/AH-K3001V/1.4.1.67.000000/0.1/C100) Opera 7.0" (Like CNF at 'keitai'-mode)
539 array('pattern'=>'#\b(?:DDIPOCKET|WILLCOM)\b.+\b(Opera) ([0-9\.]+)\b#', 'profile'=>'keitai'),
541 // Planetweb http://www.planetweb.com/
542 // Sample: "Mozilla/3.0 (Planetweb/v1.07 Build 141; SPS JP)" ("EGBROWSER", Web browser for PlayStation 2)
543 array('pattern'=>'#\b(Planetweb)/v([0-9\.]+)#', 'profile'=>'keitai'),
545 // DreamPassport, Web browser for SEGA DreamCast
546 // Sample: "Mozilla/3.0 (DreamPassport/3.0)"
547 array('pattern'=>'#\b(DreamPassport)/([0-9\.]+)#', 'profile'=>'keitai'),
549 // Palm "Web Pro" http://www.palmone.com/us/support/accessories/webpro/
550 // Sample: "Mozilla/4.76 [en] (PalmOS; U; WebPro)"
551 array('pattern'=>'#\b(WebPro)\b#', 'profile'=>'keitai'),
553 // ilinx "Palmscape" / "Xiino" http://www.ilinx.co.jp/
554 // Sample: "Xiino/2.1SJ [ja] (v. 4.1; 153x130; c16/d)"
555 array('pattern'=>'#^(Palmscape)/([0-9\.]+)#', 'profile'=>'keitai'),
556 array('pattern'=>'#^(Xiino)/([0-9\.]+)#', 'profile'=>'keitai'),
558 // SHARP PDA Browser (SHARP Zaurus)
559 // Sample: "sharp pda browser/6.1[ja](MI-E1/1.0) "
560 array('pattern'=>'#^(sharp [a-z]+ browser)/([0-9\.]+)#', 'profile'=>'keitai'),
563 array('pattern'=>'#^(WebTV)/([0-9\.]+)#', 'profile'=>'keitai'),
565 // Desktop-PC browsers
567 // Opera (for desktop PC, not embedded) -- See BugTrack/743 for detail
568 // NOTE: Keep this pattern above MSIE and Mozilla
569 // Sample: "Opera/7.0 (OS; U)" (not disguise)
570 // Sample: "Mozilla/4.0 (compatible; MSIE 5.0; OS) Opera 6.0" (disguise)
571 array('pattern'=>'#\b(Opera)[/ ]([0-9\.]+)\b#', 'profile'=>'default'),
573 // MSIE: Microsoft Internet Explorer (or something disguised as MSIE)
574 // Sample: "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)"
575 array('pattern'=>'#\b(MSIE) ([0-9\.]+)\b#', 'profile'=>'default'),
578 // NOTE: Keep this pattern above Mozilla
579 // Sample: "Mozilla/5.0 (Windows; U; Windows NT 5.0; ja-JP; rv:1.7) Gecko/20040803 Firefox/0.9.3"
580 array('pattern'=>'#\b(Firefox)/([0-9\.]+)\b#', 'profile'=>'default'),
582 // Loose default: Including something Mozilla
583 array('pattern'=>'#^([a-zA-z0-9 ]+)/([0-9\.]+)\b#', 'profile'=>'default'),
585 array('pattern'=>'#^#', 'profile'=>'default'), // Sentinel