xref: /dokuwiki/conf/dokuwiki.php (revision 28f4004c937cfc11f16e6cc7c0eb7da1a61dfcbe)
14dc4b499Smatthiasgrimm<?php
2f3f0262cSandi/**
3f3f0262cSandi * This is DokuWiki's Main Configuration file
4c29dc6e4SAndreas Gohr *
5c29dc6e4SAndreas Gohr * All the default values are kept here, you should not modify it but use
656ee9557SAndreas Gohr * a local.php file instead to override the settings from here.
7c29dc6e4SAndreas Gohr *
8f3f0262cSandi * This is a piece of PHP code so PHP syntax applies!
9f3f0262cSandi *
108dbd31e5SGuy Brand * For help with the configuration see http://www.dokuwiki.org/config
11f3f0262cSandi */
12f3f0262cSandi
13f3f0262cSandi
14f3f0262cSandi/* Datastorage and Permissions */
15039e19f5STom Hoover
161ca31cfeSAndreas Gohr$conf['fmode']       = 0644;              //set file creation mode
171ca31cfeSAndreas Gohr$conf['dmode']       = 0755;              //set directory creation mode
18f3f0262cSandi$conf['lang']        = 'en';              //your language
19f62ea8a1Sandi$conf['basedir']     = '';                //absolute dir from serveroot - blank for autodetection
20ef7b3ecdSAndreas Gohr$conf['baseurl']     = '';                //URL to server including protocol - blank for autodetect
2198407a7aSandi$conf['savedir']     = './data';          //where to store all the files
22f6e0e340SAndreas Gohr$conf['allowdebug']  = 0;                 //allow debug output, enable if needed 0|1
23f3f0262cSandi
24f3f0262cSandi/* Display Options */
25f3f0262cSandi
26f3f0262cSandi$conf['start']       = 'start';           //name of start page
27f3f0262cSandi$conf['title']       = 'DokuWiki';        //what to show in the title
28066fee30SAndreas Gohr$conf['template']    = 'default';         //see lib/tpl directory
29066fee30SAndreas Gohr$conf['license']     = 'cc-by-nc-sa';     //see conf/license.php
30f3f0262cSandi$conf['fullpath']    = 0;                 //show full path of the document or relative to datadir only? 0|1
31f3f0262cSandi$conf['recent']      = 20;                //how many entries to show in recent
32f3f0262cSandi$conf['breadcrumbs'] = 10;                //how many recent visited pages to show
3331e187f8SSean Coates$conf['youarehere']  = 0;                 //show "You are here" navigation? 0|1
349426a41aSAndreas Gohr$conf['typography']  = 1;                 //smartquote conversion 0=off, 1=doublequotes, 2=all quotes
35f3f0262cSandi$conf['htmlok']      = 0;                 //may raw HTML be embedded? This may break layout and XHTML validity 0|1
36f3f0262cSandi$conf['phpok']       = 0;                 //may PHP code be embedded? Never do this on the internet! 0|1
37e656dcd4SAndreas Gohr$conf['dformat']     = '%Y/%m/%d %H:%M';  //dateformat accepted by PHPs strftime() function
38f3f0262cSandi$conf['signature']   = ' --- //[[@MAIL@|@NAME@]] @DATE@//'; //signature see wiki:config for details
399773c5edSjoe.lapp$conf['toptoclevel'] = 1;                 //Level starting with and below to include in AutoTOC (max. 5)
40851f2e89SAnika Henke$conf['tocminheads'] = 3;                 //Minimum amount of headlines that determines if a TOC is built
41f3f0262cSandi$conf['maxtoclevel'] = 3;                 //Up to which level include into AutoTOC (max. 5)
42f3f0262cSandi$conf['maxseclevel'] = 3;                 //Up to which level create editable sections (max. 5)
43f3f0262cSandi$conf['camelcase']   = 0;                 //Use CamelCase for linking? (I don't like it) 0|1
448a831f2bSAndreas Gohr$conf['deaccent']    = 1;                 //deaccented chars in pagenames (1) or romanize (2) or keep (0)?
45a77f5846Sjan$conf['useheading']  = 0;                 //use the first heading in a page as its name
46e28299ccSmatthiasgrimm$conf['refcheck']    = 1;                 //check for references before deleting media files
47e28299ccSmatthiasgrimm$conf['refshow']     = 0;                 //how many references should be shown, 5 is a good value
48dc58b6f4SAndy Webber$conf['showuseras']  = 'loginname';       // 'loginname' users login name
49dc58b6f4SAndy Webber                                          // 'username' users full name
50dc58b6f4SAndy Webber                                          // 'email' e-mail address (will be obfuscated as per mailguard)
51dc58b6f4SAndy Webber                                          // 'email_link' e-mail address as a mailto: link (obfuscated)
52f3f0262cSandi
53f3f0262cSandi/* Antispam Features */
54f3f0262cSandi
55f3f0262cSandi$conf['usewordblock']= 1;                 //block spam based on words? 0|1
566ba61cb1Sandi$conf['indexdelay']  = 60*60*24*5;        //allow indexing after this time (seconds) default is 5 days
576ba61cb1Sandi$conf['relnofollow'] = 1;                 //use rel="nofollow" for external links?
58f3f0262cSandi$conf['mailguard']   = 'hex';             //obfuscate email addresses against spam harvesters?
59f3f0262cSandi                                          //valid entries are:
60f3f0262cSandi                                          //  'visible' - replace @ with [at], . with [dot] and - with [dash]
61f3f0262cSandi                                          //  'hex'     - use hex entities to encode the mail address
62f3f0262cSandi                                          //  'none'    - do not obfuscate addresses
6326ceae18SAndreas Gohr$conf['iexssprotect']= 1;                 // check for JavaScript and HTML in uploaded files 0|1
64f3f0262cSandi
65b0855b11Sandi/* Authentication Options - read http://www.splitbrain.org/dokuwiki/wiki:acl */
66039e19f5STom Hoover
67f3f0262cSandi$conf['useacl']      = 0;                //Use Access Control Lists to restrict access?
68cab2716aSmatthias.grimm$conf['autopasswd']  = 1;                //autogenerate passwords and email them to user
69b0855b11Sandi$conf['authtype']    = 'plain';          //which authentication backend should be used
70d7be6245Sandi$conf['passcrypt']   = 'smd5';           //Used crypt method (smd5,md5,sha1,ssha,crypt,mysql,my411)
71f3f0262cSandi$conf['defaultgroup']= 'user';           //Default groups new Users are added to
727651d633SGuy Brand$conf['superuser']   = '!!not set!!';    //The admin can be user or @group or comma separated list user1,@group1,user2
737651d633SGuy Brand$conf['manager']     = '!!not set!!';    //The manager can be user or @group or comma separated list user1,@group1,user2
74f5c6743cSAndreas Gohr$conf['profileconfirm'] = 1;             //Require current password to confirm changes to user profile
751d5856cfSAndreas Gohr$conf['disableactions'] = '';            //comma separated list of actions to disable
76d1c7b6ecSAndreas Gohr$conf['sneaky_index']   = 0;             //check for namespace read permission in index view (0|1) (1 might cause unexpected behavior)
774c989037SChris Smith$conf['auth_security_timeout'] = 900;    //time (seconds) auth data is considered valid, set to 0 to recheck on every page view
78f5c6743cSAndreas Gohr$conf['securecookie'] = 1;               //never send HTTPS cookies via HTTP
79f3f0262cSandi
803ee5b583SAndreas Gohr$conf['xmlrpc']      = 0;                //Enable/disable XML-RPC interface
813ee5b583SAndreas Gohr$conf['xmlrpcuser']  = '!!not set!!';    //Restrict XML-RPC access to this groups/users
823ee5b583SAndreas Gohr
83f3f0262cSandi/* Advanced Options */
84039e19f5STom Hoover
85c29dc6e4SAndreas Gohr$conf['updatecheck'] = 1;                //automatically check for new releases?
866c7843b5Sandi$conf['userewrite']  = 0;                //this makes nice URLs: 0: off 1: .htaccess 2: internal
87f3f0262cSandi$conf['useslash']    = 0;                //use slash instead of colon? only when rewrite is on
88ee4c4a1bSAndreas Gohr$conf['usedraft']    = 1;                //automatically save a draft while editing (0|1)
894b5db43bSjoe.lapp$conf['sepchar']     = '_';              //word separator character in page names; may be a
904b5db43bSjoe.lapp                                         //  letter, a digit, '_', '-', or '.'.
91f3f0262cSandi$conf['canonical']   = 0;                //Should all URLs use full canonical http://... style?
92f03fd957SAndreas Gohr$conf['fnencode']    = 'url';            //encode filenames (url|safe|utf-8)
93f3f0262cSandi$conf['autoplural']  = 0;                //try (non)plural form of nonexisting files?
94ff3ed99fSmarcel$conf['compression'] = 'gz';             //compress old revisions: (0: off) ('gz': gnuzip) ('bz2': bzip)
95ff3ed99fSmarcel                                         //  bz2 generates smaller files, but needs more cpu-power
96f3f0262cSandi$conf['cachetime']   = 60*60*24;         //maximum age for cachefile in seconds (defaults to a day)
97f3f0262cSandi$conf['locktime']    = 15*60;            //maximum age for lockfiles (defaults to 15 minutes)
98894a80ccSAndreas Gohr$conf['fetchsize']   = 0;                //maximum size (bytes) fetch.php may download from extern, disabled by default
99f3f0262cSandi$conf['notify']      = '';               //send change info to this email (leave blank for nobody)
100a06e4bdbSSebastian Harl$conf['registernotify'] = '';            //send info about newly registered users to this email (leave blank for nobody)
101f3f0262cSandi$conf['mailfrom']    = '';               //use this email when sending mails
1025526795cSGuy Brand$conf['mailprefix']  = '';               //use this as prefix of outgoing mails
103f8f8e2deSAndreas Gohr$conf['gzip_output'] = 0;                //use gzip content encodeing for the output xhtml (if allowed by browser)
104825ec232Sandi$conf['gdlib']       = 2;                //the GDlib version (0, 1 or 2) 2 tries to autodetect
10568375754SPavel Vitis$conf['im_convert']  = '';               //path to ImageMagicks convert (will be used instead of GD)
1062b03e74dSBen Coburn$conf['jpg_quality'] = '70';             //quality of compression when scaling jpg images (0-100)
107f9eb5648Ssteven-danz$conf['subscribers'] = 0;                //enable change notice subscription support
1085b75cd1fSAdrian Lang$conf['subscribe_time'] = 24*60*60;      //Time after which digests / lists are sent (in sec, default 1 day)
10925fabd1dSAdrian Lang                                         //Should be smaller than the time specified in recent_days
11078a6aeb1SAndreas Gohr$conf['compress']    = 1;                //Strip whitespaces and comments from Styles and JavaScript? 1|0
111*28f4004cSAndreas Gohr$conf['cssdatauri']  = 0;                //Maximum byte size of small images to embed into CSS, won't work on IE<8
1120dc92c6fSAndreas Gohr$conf['hidepages']   = '';               //Regexp for pages to be skipped from RSS, Search and Recent Changes
1132649b1a4SAndreas Gohr$conf['send404']     = 0;                //Send a HTTP 404 status for non existing pages?
1148b9da5a7SAndreas Gohr$conf['sitemap']     = 0;                //Create a google sitemap? How often? In days.
11531f1284dSjoe.lapp$conf['rss_type']    = 'rss1';           //type of RSS feed to provide, by default:
11631f1284dSjoe.lapp                                         //  'rss'  - RSS 0.91
11731f1284dSjoe.lapp                                         //  'rss1' - RSS 1.0
11831f1284dSjoe.lapp                                         //  'rss2' - RSS 2.0
11931f1284dSjoe.lapp                                         //  'atom' - Atom 0.3
1204ab889eaSAndreas Gohr                                         //  'atom1' - Atom 1.0
12192e52d8dSjoe.lapp$conf['rss_linkto'] = 'diff';            //what page RSS entries link to:
12292e52d8dSjoe.lapp                                         //  'diff'    - page showing revision differences
12392e52d8dSjoe.lapp                                         //  'page'    - the revised page itself
12492e52d8dSjoe.lapp                                         //  'rev'     - page showing all revisions
12592e52d8dSjoe.lapp                                         //  'current' - most recent revision of page
126b5a0be43SAdrian Lang$conf['rss_content'] = 'abstract';       // what to put in the items by default?
1274ab889eaSAndreas Gohr                                         //  'abstract' - plain text, first paragraph or so
1284ab889eaSAndreas Gohr                                         //  'diff'     - plain text unified diff wrapped in <pre> tags
1294ab889eaSAndreas Gohr                                         //  'htmldiff' - diff as HTML table
1304ab889eaSAndreas Gohr                                         //  'html'     - the full page rendered in XHTML
1315dae719cSAdrian Lang$conf['rss_update'] = 5*60;              //Update the RSS feed every n seconds (defaults to 5 minutes)
13271726d78SBen Coburn$conf['recent_days'] = 7;                //How many days of recent changes to keep. (days)
133a1716312SMarc Mayfield$conf['rss_show_summary'] = 1;           //Add revision summary to title? 0|1
134cde6a01bSAndreas Gohr$conf['broken_iua']  = 0;                //Platform with broken ignore_user_abort (IIS+CGI) 0|1
1359a87c72aSAndreas Gohr$conf['xsendfile']   = 0;                //Use X-Sendfile (1 = lighttpd, 2 = standard)
136d968d3e5SChris Smith$conf['renderer_xhtml'] = 'xhtml';       //renderer to use for main page generation
13717f89d7eSMichael Klier$conf['rememberme'] = 1;                 //Enable/disable remember me on login
138f3f0262cSandi
139f3f0262cSandi//Set target to use when creating links - leave empty for same window
140f3f0262cSandi$conf['target']['wiki']      = '';
141b7441779SAndreas Gohr$conf['target']['interwiki'] = '';
142b7441779SAndreas Gohr$conf['target']['extern']    = '';
143f3f0262cSandi$conf['target']['media']     = '';
144f3f0262cSandi$conf['target']['windows']   = '';
145f3f0262cSandi
14694de3b7aSAndreas Gohr//Proxy setup - if your Server needs a proxy to access the web set these
14794de3b7aSAndreas Gohr$conf['proxy']['host']    = '';
14894de3b7aSAndreas Gohr$conf['proxy']['port']    = '';
14994de3b7aSAndreas Gohr$conf['proxy']['user']    = '';
15094de3b7aSAndreas Gohr$conf['proxy']['pass']    = '';
151506fa893SAndreas Gohr$conf['proxy']['ssl']     = 0;
1527aeda574SAndreas Gohr$conf['proxy']['except']  = '';
15394de3b7aSAndreas Gohr
1543dc3a5f1Sandi/* Safemode Hack */
155039e19f5STom Hoover
156f46c9e83SAnika Henke$conf['safemodehack'] = 0;               //read http://www.dokuwiki.org/config:safemodehack !
1573dc3a5f1Sandi$conf['ftp']['host'] = 'localhost';
1583dc3a5f1Sandi$conf['ftp']['port'] = '21';
1593dc3a5f1Sandi$conf['ftp']['user'] = 'user';
1603dc3a5f1Sandi$conf['ftp']['pass'] = 'password';
1613dc3a5f1Sandi$conf['ftp']['root'] = '/home/user/htdocs';
1623dc3a5f1Sandi
16322952965SYoBoY$conf['readdircache'] = 0;               //time cache in second for the readdir opération, 0 to deactivate.
164