Differences

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

--- config [2023-08-23 23:23] – Klap-in
+++ config [2024-02-27 19:32] (current) – [Configuration files] 182.177.27.17
@@ Line 2: / Line 2: @@
 DokuWiki can be configured depending on your needs by "system" options, configuration files for tuning behaviour, styling of the theme and dis/enabling extensions.
 ===== What can be configured =====
-The "system" options of DokuWiki can be set in the [[plugin:config|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/config/admin.svg?16}}]][[plugin:config|Configuration Manager]]. You need to login as superuser and click the Admin button to start it. The "default" values of the system are read from ''conf/dokuwiki.php'' file. To customize it, you can make changes in the Configuration Manager, which saves the changes to the file ''conf/local.php''. Alternatively, you edit it yourself 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 can be set in the [[plugin:config|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/config/admin.svg?14}}]][[plugin:config|Configuration Manager]]. You need to login as superuser and click the Admin button to start it. The "default" values of the system are read from ''conf/dokuwiki.php'' file. To customize it, you can make changes in the Configuration Manager, which saves the changes to the file ''conf/local.php''. Alternatively, you edit it yourself 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]] files which can be found in the ''conf/'' directory. These can be edited via the [[plugin:usermanager|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/usermanager/admin.svg?16}}]][[plugin:usermanager|User Manager]] and the [[plugin:acl|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/acl/admin.svg?16}}]][[plugin:acl|Access Control List Management]].
+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. These can be edited via the [[plugin:usermanager|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/usermanager/admin.svg?14}}]][[plugin:usermanager|User Manager]] and the [[plugin:acl|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/acl/admin.svg?14}}]][[plugin:acl|Access Control List Management]].
 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.
@@ Line 16: / Line 18: @@
 ===== Configuration files =====
-All configuration files are to be found in the ''conf/'' folder in your installation (or ''/etc/dokuwiki'' when installed from a Debian package).
+The configuration files are to be found in the ''conf/'' folder in your installation (or ''/etc/dokuwiki'' when installed from a Debian package).
 "Main files" usually ship with DokuWiki, whereas "local files" have to be created by the wiki admin.
@@ Line 22: / Line 24: @@
 If local files are supported you should use them instead of modifying the main files to avoid upgrade troubles.
-Alternatively, instead of editing the ''*.conf'' files directly, you can install and use the [[plugin:confmanager|{{https://raw.githubusercontent.com/cosmocode/confmanager/master/admin.svg?20}}]][[plugin:confmanager|Configuration File Manager]].
+Alternatively, instead of editing the ''*.conf'' files directly, you can install and use the [[plugin:confmanager|{{https://raw.githubusercontent.com/cosmocode/confmanager/master/admin.svg?16}}]][[plugin:confmanager|Configuration File Manager]].
-^ 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''                              | [[~:license]]    | list of available licenses             |
+| ''license.php''              | ''license.local.php''                              | [[~: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''         | ''mediameta.local.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         |
+| ''manifest.json''            | ''manifest.local.json''                            | [[devel:manifest]]    | PWA Manifest                           |
-|                           | ''userstyle.css''                                  | [[devel:css]]         | Custom CSS enhancements                |
+| ''lib/tpl/<tpl>/style.ini''  | ''conf/tpl/<tpl>/style.ini''                       | [[devel:style.ini]]   | Style files and variables              |
-| ''manifest.json''         | ''manifest.local.json''                            | [[devel:manifest]]    | PWA Manifest                           |
+|                              | ''userscript.js''                                  | [[devel:javascript]]  | Custom JavaScript enhancements         |
-| ''lib/tpl/<tpl>/style.ini'' | ''conf/tpl/<tpl>/style.ini'' | [[devel:style.ini]] | Style files and variables |
+|                              | ''userstyle.css''                                  | [[devel:css]]         | Custom CSS enhancements                |
 ==== Theme configuration files ====
-The configuration file ''[[devel:style.ini]]'' for changing the theme is found in ''/lib/tpl/dokuwiki'' (for the default dokuwiki theme). Style.ini is a text-file that is read by the theme, and the user can configure e.g. the background-color. The [[plugin:styling|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/styling/admin.svg?16}}]][[plugin:styling|Styling Plugin]] let you via the Admin interface preview and change the appearance of any template as stored in this file.
+The configuration file ''[[devel:style.ini]]'' for changing the theme is found in ''/lib/tpl/dokuwiki'' (for the default dokuwiki theme). Style.ini is a text-file that is read by the theme, and the user can configure e.g. the background-color. The [[plugin:styling|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/styling/admin.svg?14}}]][[plugin:styling|Styling Plugin]] let you via the Admin interface preview and change the appearance of any template and store in ''conf/tpl/<tpl>/style.ini''.
 ===== Enabling/disabling plugins =====
-Installed plugins are enabled by default. They could be disabled using the [[plugin:extension|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/extension/admin.svg?16}}]][[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''.
+Installed plugins are enabled by default. They could be disabled using the [[plugin:extension|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/extension/admin.svg?14}}]][[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:
@@ Line 64: / Line 66: @@
 ===== Configuration Options =====
-Most of [[DokuWiki]]'s features can be configured through various config options. The easiest way to modify these options is using the [[plugin:config|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/config/admin.svg?16}}]][[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|{{https://raw.githubusercontent.com/dokuwiki/dokuwiki/master/lib/plugins/config/admin.svg?14}}]][[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 [[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.
@@ Line 170: / Line 172: @@
     * [[~:htmlmail]]
     * [[~:dontlog]]
+    * [[~:logretain]]
   * ** Syndication Settings **
     * [[~:sitemap]]