DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace: • config
config

This is an old revision of the document!

Table of Contents

Configuring DokuWiki

DokuWiki can be configured depending on your needs by “system” options, configuration files for tuning behaviour, styling of the theme and dis/enabling extensions.

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 conf/tpl/<tpl>/style.ini.

Enabling/disabling plugins

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 conf/plugins.protected.php.

By default DokuWiki loads its configuration files in the following order:

  1. conf/plugins.php – default plugins
  2. conf/plugins.local.php – changed by the extension manager
  3. conf/plugins.required.php – these core plugins cannot be controlled by the extension manager
  4. 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.

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. 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: 

<?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 1 or 0
  • Arrays contain multiple values of one of the above types

Available Options

config.1705127911.txt.gz · Last modified: 2024-01-13 07:38 by 2001:8f8:153d:6d24:6551:761c:8300:c0ac
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

Global DokuWiki Links