DokuWiki

It's better when it's simple

User Tools

Site Tools


config

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
config [2016-11-18 16:28]
109.192.123.19 [Configuration files]
config [2020-09-13 00:09] (current)
Klap-in [Available Options]
Line 3: Line 3:
  
  
-To start the Configuration Manager log in as superuser and click the Admin button.+To start the [[plugin:config|Configuration Manager]] log in as superuser and click the Admin button. 
  
 ===== What can be configured ===== ===== What can be configured =====
Line 9: Line 10:
 The "system" options of DokuWiki will be found in the ''conf/dokuwiki.php'' file. However this file contains the "default" values of the system. To customize it, you should edit the file ''conf/local.php'' or create it if it doesn't exist. To find what you can configure within that file, see the list of [[#available options]] below. The "system" options of DokuWiki will be found in the ''conf/dokuwiki.php'' file. However this file contains the "default" values of the system. To customize it, you should edit the file ''conf/local.php'' or create it if it doesn't exist. To find what you can configure within that file, see the list of [[#available options]] below.
  
-User names, (encrypted) passwords and Access Control rules are stored in the [[acl|users.auth.php and acl.auth.php]].+User names, (encrypted) passwords and Access Control rules are stored in the [[acl|users.auth.php and acl.auth.php]] files which can be found in the conf directory.
  
-When uploading a new file within the mediamanager, you may encounter a ''"Upload denied. This file extension is forbidden!"'' message. This behavior is controlled within the ''conf/mime.conf'' file. To upload a new type of file, specify it within the [[mime|mime.conf]] file.+When uploading a new file within the mediamanager, you may encounter a ''"Upload denied. This file extension is forbidden!"'' message. This behavior is controlled within the ''conf/mime.conf'' file. To upload a new type of file, specify it within the [[mime|mime.local.conf]] file.
  
 Some automatic replacements are done when you edit your pages. Some generate tooltips, smileys or some special chars. This behavior is controlled by the [[abbreviations|acronyms.conf]], [[smileys|smileys.conf]] or [[entities|entities.conf]]. Some automatic replacements are done when you edit your pages. Some generate tooltips, smileys or some special chars. This behavior is controlled by the [[abbreviations|acronyms.conf]], [[smileys|smileys.conf]] or [[entities|entities.conf]].
 +
  
  
Line 25: Line 27:
  
  
-^main file           ^local file                ^type of config                 ^ quick info   +^ main file                 ^ local file                                         ^ type of config        ^ quick info                             
-|''dokuwiki.php''    |''local.php''\\ ''local.protected.php''|see below    | general wiki configuration | +| ''dokuwiki.php''          | ''local.php''\\ ''local.protected.php''            | see below             | general wiki configuration             
-|''acronyms.conf''   |''acronyms.local.conf''   |[[abbreviations]]         | automatic abbreviation hints | +| ''acronyms.conf''         | ''acronyms.local.conf''                            | [[abbreviations]]     | automatic abbreviation hints           
-|''entities.conf''   |''entities.local.conf''   |[[entities]]              | automatic text replacements | +| ''entities.conf''         | ''entities.local.conf''                            | [[entities]]          | automatic text replacements            
-|''interwiki.conf''  |''interwiki.local.conf''  |[[interwiki]]             | interwiki shortcut links | +| ''interwiki.conf''        | ''interwiki.local.conf''                           | [[interwiki]]         | interwiki shortcut links               
-|''mime.conf''       |''mime.local.conf''       |[[mime]]                  | mime type settings for uploads | +| ''mime.conf''             | ''mime.local.conf''                                | [[mime]]              | mime type settings for uploads         
-|''smileys.conf''    |''smileys.local.conf''    |[[smileys]]               | image replacements | +| ''smileys.conf''          | ''smileys.local.conf''                             | [[smileys]]           | image replacements                     
-                   |''acl.auth.php''          |see [[acl]]               | Access Control settings | +                          | ''acl.auth.php''                                   | see [[acl]]           | Access Control settings                
-                   |''users.auth.php''        |see [[acl]]               | Users and passwords | +                          | ''users.auth.php''                                 | see [[acl]]           | Users and passwords                    
-|''license.php''     |''license.local.php''     |[[config:license]]        | list of available licenses | +| ''license.php''           | ''license.local.php''                              | [[config:license]]    | list of available licenses             
-|''scheme.conf''     |''scheme.local.conf''     |[[urlschemes]]            | URL schemes to be recognized as links | +| ''scheme.conf''           | ''scheme.local.conf''                              | [[urlschemes]]        | URL schemes to be recognized as links  
-|''mediameta.php''                            |[[exif]]                  | Metadata editable for images | +| ''mediameta.php''         ''mediameta.local.php''                            | [[exif]]              | Metadata editable for images           
-|''wordblock.conf''  |''wordblock.local.conf''  |[[blacklist]]             | Spam blacklist | +| ''wordblock.conf''        | ''wordblock.local.conf''                           | [[blacklist]]         | Spam blacklist                         
-|''plugins.required.php'' |''plugins.local.php''\\ ''plugins.protected.php'' |see below      | Enabling/disabling plugins | +| ''plugins.required.php''  | ''plugins.local.php''\\ ''plugins.protected.php''  | see below             | Enabling/disabling plugins             
-                   |''userscript.js''         |[[devel:javascript]]      | Custom JavaScript enhancements | +                          | ''userscript.js''                                  | [[devel:javascript]]  | Custom JavaScript enhancements         
-                   |''userstyle.css''         |[[devel:css]]             | Custom CSS enhancements |+                          | ''userstyle.css''                                  | [[devel:css]]         | Custom CSS enhancements                | 
 +| ''manifest.json''         | ''manifest.local.json''                            | [[devel:manifest]]    | PWA Manifest                           |
  
 ==== Theme configuration files ==== ==== Theme configuration files ====
Line 48: Line 51:
 ===== Enabling/disabling plugins ===== ===== Enabling/disabling plugins =====
  
-Installed plugins are enabled by default. They could be disabled using the [[plugin:extension|Extension Manager]] or [[plugin:plugin|Plugin Manager]] which writes to the ''plugins.local.php'' file. You can protect certain plugins by placing them in ''conf/plugins.protected.php''.+Installed plugins are enabled by default. They could be disabled using the [[plugin:extension|Extension Manager]] which writes to the ''plugins.local.php'' file. You can protect certain plugins by placing them in ''conf/plugins.protected.php''.
  
 By default DokuWiki loads its configuration files in the following order: By default DokuWiki loads its configuration files in the following order:
  
   - ''conf/plugins.php'' -- default plugins   - ''conf/plugins.php'' -- default plugins
-  - ''conf/plugins.local.php'' -- changed by plugin manager +  - ''conf/plugins.local.php'' -- changed by the extension manager 
-  - ''conf/plugins.required.php'' -- these core plugins cannot be controlled by plugin manager+  - ''conf/plugins.required.php'' -- these core plugins cannot be controlled by the extension manager
   - ''conf/plugins.protected.php'' -- overrides setting in the other files   - ''conf/plugins.protected.php'' -- overrides setting in the other files
  
Line 64: Line 67:
 Most of [[DokuWiki]]'s features can be configured through various config options. The easiest way to modify these options is using the [[plugin:config|Configuration Manager]]. Most of [[DokuWiki]]'s features can be configured through various config options. The easiest way to modify these options is using the [[plugin:config|Configuration Manager]].
  
-The available settings are listed below. Their default values are stored in a file called ''conf/dokuwiki.php''. If you want to modify a setting you should do this in a file called ''conf/local.php'' -- this makes sure your special configs are not overwritten by a later upgrade. The config manager will use this file as well.  The file ''conf/local.protected.php'' can be used for configuration settings which cannot be modified.+The available settings are listed below. Their default values are stored in a file called ''conf/dokuwiki.php''. If you want to modify a setting you should do this in a file called ''conf/local.php'' -- this makes sure your special configs are not overwritten by a later upgrade. The [[plugin:config|Config Manager]] will use this file as well.  The file ''conf/local.protected.php'' can be used for configuration settings which cannot be modified in the Config Manager.
  
 Here is a sample ''conf/local.php'': Here is a sample ''conf/local.php'':
Line 97: Line 100:
     * [[config:basedir]]     * [[config:basedir]]
     * [[config:baseurl]]     * [[config:baseurl]]
 +    * [[config:cookiedir]]
     * [[config:dmode]]     * [[config:dmode]]
     * [[config:fmode]]     * [[config:fmode]]
Line 161: Line 165:
     * [[config:registernotify]]     * [[config:registernotify]]
     * [[config:mailfrom]]     * [[config:mailfrom]]
 +    * [[config:mailreturnpath]]
     * [[config:mailprefix]]     * [[config:mailprefix]]
     * [[config:htmlmail]]     * [[config:htmlmail]]
Line 171: Line 176:
     * [[config:rss_update]]     * [[config:rss_update]]
     * [[config:rss_show_summary]]     * [[config:rss_show_summary]]
 +    * [[config:rss_show_deleted]]
   * ** Advanced options **   * ** Advanced options **
     * [[config:updatecheck]]     * [[config:updatecheck]]
Line 188: Line 194:
     * [[config:renderer_xhtml]]     * [[config:renderer_xhtml]]
     * [[config:readdircache]]     * [[config:readdircache]]
 +    * [[config:search_nslimit]]
 +    * [[config:search_fragment]]
   * ** Network Settings **   * ** Network Settings **
     * [[config:dnslookups]]     * [[config:dnslookups]]
-    * [[config:proxy|proxy (host, port, user, pass, ssl)]] +    * [[config:jquerycdn]] 
-    * [[config:safemodehack]] +    * [[config:proxy|proxy (host, port, user, pass, ssl, except)]] 
-    * [[config:ftp|ftp (host, port, user, pass, root)]]+    * [[config:trustedproxy]] 
 +    * [[config:safemodehack]] (removed since release 2020 Hogfather) 
 +    * [[config:ftp|ftp (host, port, user, pass, root)]] (removed since release 2020 Hogfather) 
 +  * **Feature Flags** 
 +    * [[config:defer_js]]
config.1479482915.txt.gz · Last modified: 2016-11-18 16:28 by 109.192.123.19