Translations of this page?:

Configuring DokuWiki

Most of DokuWiki's features can be configured through various config options. The easiest way to modify these options is using the Configuration Manager.

What can be configured in DokuWiki

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.

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.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 acronyms.conf, smileys.conf or entities.conf.

Summary of the configuration files

All configuration files are to be found in the ./conf folder.

“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
dokuwiki.php local.php
local.protected.php
see below general wiki configuration
acronyms.conf acronyms.local.conf abbreviations automatic abbreviation hints
entities.conf entities.local.conf entities automatic text replacements
interwiki.conf interwiki.local.conf interwiki interwiki shortcut links
mime.conf mime.local.conf mime mime type settings for uploads
smileys.conf smileys.local.conf smileys graphic smiley replacements
acl.auth.php see acl Access Control settings
users.auth.php see acl Users and passwords
mediameta.php exif Metadata editable for images
wordblock.conf wordblock.local.conf blacklist Spam blacklist
userscript.js javascript Custom JavaScript enhancements
userstyle.css css Custom CSS enhancements

Configuration Options

Most of DokuWiki's features can be configured through various config options. The easiest way to modify these options is using the 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.

Here is a sample conf/local.php:

<?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: 9
  • Strings have to be enclosed in single or double quotes. Example: 'foo bar'
  • Booleans can be either true or false or 1 or 0
  • Arrays contain multiple values of one of the above types

Available Options

 
config.txt · Last modified: 2009/06/23 09:15 by 195.35.72.54
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Imprint Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki
WikiForumIRCBugsDarcsXRefTranslate