Table of Contents
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 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 users.auth.php and acl.auth.php files which can be found in the
conf/ directory. These can be edited via the User Manager and the 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.local.conf file.
All 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.
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 Configuration File Manager.
|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|
| || ||manifest||PWA Manifest|
| || ||style.ini||Style files and variables|
| ||css||Custom CSS enhancements|
Theme configuration files
The configuration file
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 Styling Plugin let you via the Admin interface preview and change the appearance of any template and store in
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:
- Numbers can be written as is. Example:
- Strings have to be enclosed in single or double quotes. Example:
- Booleans can be either
- Arrays contain multiple values of one of the above types
- Basic Settings
- Display Settings
- Authentication Settings
- Anti-Spam Settings
- Editing Settings
- Link Settings
- Media Settings
- Notification Settings
- Syndication Settings
- Advanced options
- Network Settings
ftp (host, port, user, pass, root)(removed since release 2020 Hogfather)
- Feature Flags