Learn about DokuWiki
Learn about DokuWiki
Many of DokuWiki's features can be configured through various config options. The easiest way to modify these options is using the Configuration Manager which allows wiki administrators to easily alter the wiki configuration settings online from the comfort of their favorite web browser.
To start the Configuration Manager log in as superuser and click the Admin button.
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 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.local.conf file.
All configuration files are to be found in the
./conf folder 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.
If local files are supported you should use them instead of modifying the main files to avoid upgrade troubles.
|main file||local file||type of config||quick info|
| || ||see below||general wiki configuration|
| || ||abbreviations||automatic abbreviation hints|
| || ||entities||automatic text replacements|
| || ||interwiki||interwiki shortcut links|
| || ||mime||mime type settings for uploads|
| || ||smileys||image replacements|
| ||see acl||Access Control settings|
| ||see acl||Users and passwords|
| || ||license||list of available licenses|
| || ||urlschemes||URL schemes to be recognized as links|
| || ||exif||Metadata editable for images|
| || ||blacklist||Spam blacklist|
| || ||see below||Enabling/disabling plugins|
| ||css||Custom CSS enhancements|
| || ||manifest||PWA Manifest|
Additional configuration files are found in
/var/lib/dokuwiki/lib/tpl/dokuwiki (Debian), e.g.
style.ini. Style.ini is a text-file that is read by the default theme, and the user can configure e.g. the background-color.
Installed plugins are enabled by default. They could be disabled using the Extension Manager which writes to the
plugins.local.php file. You can protect certain plugins by placing them in
By default DokuWiki loads its configuration files in the following order:
conf/plugins.php– default plugins
conf/plugins.local.php– changed by the extension 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
The loading order of configuration files is controlled by the global
$config_cascade variable. By using a preload.php file you can change this behavior.
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 in the Config Manager.
Here is a sample
<?php $conf['title'] = 'Admin\'s Wiki'; $conf['useacl'] = 1; $conf['superuser'] = 'admin';
Some notes about the config file. The file is a piece of PHP code so the PHP syntax has to be preserved. E.g. each line has to have a semicolon at the end. There are multiple types of variables: