Configuration Manager Plugin

The Config Manager allows wiki administrators to easily alter the wiki configuration settings online from the comfort of their favorite web browser.

The Plugin is bundled with DokuWiki and does not need to be installed separately. The Config Manager is accessible from the admin screen (Login as superuser, click “Admin” and choose “Configuration Settings”).

Settings are shown with different backgrounds to highlight their current status. A blue background is used to show default values (conf/dokuwiki.php), eg. values that have not been modified by the user. A white background indicates local changes (conf/local.php). A light red background shows protected settings (conf/local.protected.php) which can not be modified.

On saving changed settings this plugin will copy the current local settings file (conf/local.php) to conf/local.php.bak and save the updated settings to conf/local.php. It will never make any changes to the default settings stored in conf/dokuwiki.php. However, any settings found in conf/local.php will override the default settings as explained in the configuration options page.

The plugin adds the following lines to the top of conf/local.php when it updates it:

/*
 * DokuWiki's Main Configuration File - Local Settings 
 * Auto-generated by config plugin 
 * Run for user: <username>
 * Date: <current date/time, rfc 2822 format (day, dd MMM YYYY hh:mm:ss TZ)>
 */

You can protect certain settings by placing them in conf/local.protected.php. This plugin adds the following line to the bottom of conf/local.php —

@include(DOKU_CONF.'local.protected.php');

— thereby ensuring the protected settings are included and will override any previously set values from conf/dokuwiki.php and conf/local.php. Any settings found in this file will be displayed by the plugin surrounded in light-red to indicated their protected status. Editing of protected values is disabled.

To be able to save the configuration data, the file permissions of conf/local.php and conf/local.php.bak need to be writable by the webserver. Refer to permissions on details how set file permissions on various systems.

When the plugin detects that the config file can not be written, it will show a message box at the top of the page explaining the settings are for information only and can't be changed. The save button usually located at the end of the page will not be shown in the this case.