[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/conf/ -> dokuwiki.php (source)

   1  <?php
   2  /**
   3   * This is DokuWiki's Main Configuration file
   4   *
   5   * All the default values are kept here, you should not modify it but use
   6   * a local.php file instead to override the settings from here.
   7   *
   8   * This is a piece of PHP code so PHP syntax applies!
   9   *
  10   * For help with the configuration and a more detailed explanation of the various options
  11   * see https://www.dokuwiki.org/config
  12   */
  13  
  14  
  15  /* Basic Settings */
  16  $conf['title']       = 'DokuWiki';        //what to show in the title
  17  $conf['start']       = 'start';           //name of start page
  18  $conf['lang']        = 'en';              //your language
  19  $conf['template']    = 'dokuwiki';         //see lib/tpl directory
  20  $conf['tagline']     = '';                //tagline in header (if template supports it)
  21  $conf['sidebar']     = 'sidebar';         //name of sidebar in root namespace (if template supports it)
  22  $conf['license']     = 'cc-by-nc-sa';     //see conf/license.php
  23  $conf['savedir']     = './data';          //where to store all the files
  24  $conf['basedir']     = '';                //absolute dir from serveroot - blank for autodetection
  25  $conf['baseurl']     = '';                //URL to server including protocol - blank for autodetect
  26  $conf['cookiedir']   = '';                //path to use in cookies - blank for basedir
  27  $conf['dmode']       = 0755;              //set directory creation mode
  28  $conf['fmode']       = 0644;              //set file creation mode
  29  $conf['allowdebug']  = 0;                 //allow debug output, enable if needed 0|1
  30  
  31  /* Display Settings */
  32  $conf['recent']      = 20;                //how many entries to show in recent
  33  $conf['recent_days'] = 7;                 //How many days of recent changes to keep. (days)
  34  $conf['breadcrumbs'] = 10;                //how many recent visited pages to show
  35  $conf['youarehere']  = 0;                 //show "You are here" navigation? 0|1
  36  $conf['fullpath']    = 0;                 //show full path of the document or relative to datadir only? 0|1
  37  $conf['typography']  = 1;                 //smartquote conversion 0=off, 1=doublequotes, 2=all quotes
  38  $conf['dformat']     = '%Y/%m/%d %H:%M';  //dateformat accepted by PHPs strftime() function
  39  $conf['signature']   = ' --- //[[@MAIL@|@NAME@]] @DATE@//'; //signature see wiki page for details
  40  $conf['showuseras']  = 'loginname';       // 'loginname' users login name
  41                                            // 'username' users full name
  42                                            // 'email' e-mail address (will be obfuscated as per mailguard)
  43                                            // 'email_link' e-mail address as a mailto: link (obfuscated)
  44  $conf['toptoclevel'] = 1;                 //Level starting with and below to include in AutoTOC (max. 5)
  45  $conf['tocminheads'] = 3;                 //Minimum amount of headlines that determines if a TOC is built
  46  $conf['maxtoclevel'] = 3;                 //Up to which level include into AutoTOC (max. 5)
  47  $conf['maxseclevel'] = 3;                 //Up to which level create editable sections (max. 5)
  48  $conf['camelcase']   = 0;                 //Use CamelCase for linking? (I don't like it) 0|1
  49  $conf['deaccent']    = 1;                 //deaccented chars in pagenames (1) or romanize (2) or keep (0)?
  50  $conf['useheading']  = 0;                 //use the first heading in a page as its name
  51  $conf['sneaky_index']= 0;                 //check for namespace read permission in index view (0|1) (1 might cause unexpected behavior)
  52  $conf['hidepages']   = '';                //Regexp for pages to be skipped from RSS, Search and Recent Changes
  53  
  54  /* Authentication Settings */
  55  $conf['useacl']      = 0;                //Use Access Control Lists to restrict access?
  56  $conf['autopasswd']  = 1;                //autogenerate passwords and email them to user
  57  $conf['authtype']    = 'authplain';      //which authentication backend should be used
  58  $conf['passcrypt']   = 'bcrypt';           //Used crypt method (smd5,md5,sha1,ssha,crypt,mysql,my411,bcrypt)
  59  $conf['defaultgroup']= 'user';           //Default groups new Users are added to
  60  $conf['superuser']   = '!!not set!!';    //The admin can be user or @group or comma separated list user1,@group1,user2
  61  $conf['manager']     = '!!not set!!';    //The manager can be user or @group or comma separated list user1,@group1,user2
  62  $conf['profileconfirm'] = 1;             //Require current password to confirm changes to user profile
  63  $conf['rememberme'] = 1;                 //Enable/disable remember me on login
  64  $conf['disableactions'] = '';            //comma separated list of actions to disable
  65  $conf['auth_security_timeout'] = 900;    //time (seconds) auth data is considered valid, set to 0 to recheck on every page view
  66  $conf['securecookie'] = 1;               //never send HTTPS cookies via HTTP
  67  $conf['remote']      = 0;                //Enable/disable remote interfaces
  68  $conf['remoteuser']  = '!!not set!!';    //user/groups that have access to remote interface (comma separated). leave empty to allow all users
  69  $conf['remotecors']  = '';               //enable Cross-Origin Resource Sharing (CORS) for the remote interfaces. Asterisk (*) to allow all origins. leave empty to deny.
  70  
  71  /* Antispam Features */
  72  $conf['usewordblock']= 1;                //block spam based on words? 0|1
  73  $conf['relnofollow'] = 1;                //use rel="ugc nofollow" for external links?
  74  $conf['indexdelay']  = 60*60*24*5;       //allow indexing after this time (seconds) default is 5 days
  75  $conf['mailguard']   = 'hex';            //obfuscate email addresses against spam harvesters?
  76                                           //valid entries are:
  77                                           //  'visible' - replace @ with [at], . with [dot] and - with [dash]
  78                                           //  'hex'     - use hex entities to encode the mail address
  79                                           //  'none'    - do not obfuscate addresses
  80  $conf['iexssprotect']= 1;                // check for JavaScript and HTML in uploaded files 0|1
  81  
  82  /* Editing Settings */
  83  $conf['usedraft']    = 1;                //automatically save a draft while editing (0|1)
  84  $conf['locktime']    = 15*60;            //maximum age for lockfiles (defaults to 15 minutes)
  85  $conf['cachetime']   = 60*60*24;         //maximum age for cachefile in seconds (defaults to a day)
  86  
  87  /* Link Settings */
  88  // Set target to use when creating links - leave empty for same window
  89  $conf['target']['wiki']      = '';
  90  $conf['target']['interwiki'] = '';
  91  $conf['target']['extern']    = '';
  92  $conf['target']['media']     = '';
  93  $conf['target']['windows']   = '';
  94  
  95  /* Media Settings */
  96  $conf['mediarevisions'] = 1;             //enable/disable media revisions
  97  $conf['refcheck']    = 1;                //check for references before deleting media files
  98  $conf['gdlib']       = 2;                //the GDlib version (0, 1 or 2) 2 tries to autodetect
  99  $conf['im_convert']  = '';               //path to ImageMagicks convert (will be used instead of GD)
 100  $conf['jpg_quality'] = '70';             //quality of compression when scaling jpg images (0-100)
 101  $conf['fetchsize']   = 0;                //maximum size (bytes) fetch.php may download from extern, disabled by default
 102  
 103  /* Notification Settings */
 104  $conf['subscribers'] = 0;                //enable change notice subscription support
 105  $conf['subscribe_time'] = 24*60*60;      //Time after which digests / lists are sent (in sec, default 1 day)
 106                                           //Should be smaller than the time specified in recent_days
 107  $conf['notify']      = '';               //send change info to this email (leave blank for nobody)
 108  $conf['registernotify'] = '';            //send info about newly registered users to this email (leave blank for nobody)
 109  $conf['mailfrom']    = '';               //use this email when sending mails
 110  $conf['mailreturnpath']    = '';         //use this email as returnpath for bounce mails
 111  $conf['mailprefix']  = '';               //use this as prefix of outgoing mails
 112  $conf['htmlmail']    = 1;                //send HTML multipart mails
 113  $conf['dontlog'] = 'debug';              //logging facilities that should be disabled
 114  
 115  /* Syndication Settings */
 116  $conf['sitemap']     = 0;                //Create a Google sitemap? How often? In days.
 117  $conf['rss_type']    = 'rss1';           //type of RSS feed to provide, by default:
 118                                           //  'rss'  - RSS 0.91
 119                                           //  'rss1' - RSS 1.0
 120                                           //  'rss2' - RSS 2.0
 121                                           //  'atom' - Atom 0.3
 122                                           //  'atom1' - Atom 1.0
 123  $conf['rss_linkto'] = 'diff';            //what page RSS entries link to:
 124                                           //  'diff'    - page showing revision differences
 125                                           //  'page'    - the revised page itself
 126                                           //  'rev'     - page showing all revisions
 127                                           //  'current' - most recent revision of page
 128  $conf['rss_content'] = 'abstract';       //what to put in the items by default?
 129                                           //  'abstract' - plain text, first paragraph or so
 130                                           //  'diff'     - plain text unified diff wrapped in <pre> tags
 131                                           //  'htmldiff' - diff as HTML table
 132                                           //  'html'     - the full page rendered in XHTML
 133  $conf['rss_media']   = 'both';           //what should be listed?
 134                                           //  'both'     - page and media changes
 135                                           //  'pages'    - page changes only
 136                                           //  'media'    - media changes only
 137  $conf['rss_update'] = 5*60;              //Update the RSS feed every n seconds (defaults to 5 minutes)
 138  $conf['rss_show_summary'] = 1;           //Add revision summary to title? 0|1
 139  $conf['rss_show_deleted'] = 1;           //Show deleted items 0|1
 140  
 141  /* Advanced Settings */
 142  $conf['updatecheck'] = 1;                //automatically check for new releases?
 143  $conf['userewrite']  = 0;                //this makes nice URLs: 0: off 1: .htaccess 2: internal
 144  $conf['useslash']    = 0;                //use slash instead of colon? only when rewrite is on
 145  $conf['sepchar']     = '_';              //word separator character in page names; may be a
 146                                           //  letter, a digit, '_', '-', or '.'.
 147  $conf['canonical']   = 0;                //Should all URLs use full canonical http://... style?
 148  $conf['fnencode']    = 'url';            //encode filenames (url|safe|utf-8)
 149  $conf['autoplural']  = 0;                //try (non)plural form of nonexistent files?
 150  $conf['compression'] = 'gz';             //compress old revisions: (0: off) ('gz': gnuzip) ('bz2': bzip)
 151                                           //  bz2 generates smaller files, but needs more cpu-power
 152  $conf['gzip_output'] = 0;                //use gzip content encoding for the output xhtml (if allowed by browser)
 153  $conf['compress']    = 1;                //Strip whitespaces and comments from Styles and JavaScript? 1|0
 154  $conf['cssdatauri']  = 512;              //Maximum byte size of small images to embed into CSS, won't work on IE<8
 155  $conf['send404']     = 0;                //Send an HTTP 404 status for nonexistent pages?
 156  $conf['broken_iua']  = 0;                //Platform with broken ignore_user_abort (IIS+CGI) 0|1
 157  $conf['xsendfile']   = 0;                //Use X-Sendfile (1 = lighttpd, 2 = standard)
 158  $conf['renderer_xhtml'] = 'xhtml';       //renderer to use for main page generation
 159  $conf['readdircache'] = 0;               //time cache in second for the readdir operation, 0 to deactivate.
 160  $conf['search_nslimit'] = 0;             //limit the search to the current X namespaces
 161  $conf['search_fragment'] = 'exact';      //specify the default fragment search behavior
 162  $conf['trustedproxy'] = '^(::1|[fF][eE]80:|127\.|10\.|192\.168\.|172\.((1[6-9])|(2[0-9])|(3[0-1]))\.)';
 163                                           //Regexp of trusted proxy address when reading IP using HTTP header
 164                                           //  if blank, do not trust any proxy (including local IP)
 165  
 166  /* Feature Flags */
 167  $conf['defer_js'] = 1;                   // Defer javascript to be executed after the page's HTML has been parsed. Setting will be removed in the next release.
 168  $conf['hidewarnings'] = 0;               // Hide warnings
 169  
 170  /* Network Settings */
 171  $conf['dnslookups'] = 1;                 //disable to disallow IP to hostname lookups
 172  $conf['jquerycdn']  = 0;                 //use a CDN for delivering jQuery?
 173  // Proxy setup - if your Server needs a proxy to access the web set these
 174  $conf['proxy']['host']    = '';
 175  $conf['proxy']['port']    = '';
 176  $conf['proxy']['user']    = '';
 177  $conf['proxy']['pass']    = '';
 178  $conf['proxy']['ssl']     = 0;
 179  $conf['proxy']['except']  = '';