Manage and install plugins and templates (bundled with DokuWiki)
The Extension Manager plugin allows superusers to administer installed plugins and templates and install new ones as listed in the plugins and template repositories.
The Extension Manager is accessible from the admin screen (Login as superuser, click “Admin” and choose “ Extension Manager”).
The Installed Plugins listing is the default action of the Extension Manager. The second tab lists the Installed templates. Each plugin or template is shown in its own row. The right hand side column contains action buttons like Disable/Enable, Install/Uninstall/Re-install and Update. Not all buttons are available in all circumstances. For example, there is no enable button for templates.
Plugins and templates with gray font are currently disabled.
To disable or enable a plugin, you use the Disable and Enable buttons on the right hand side.
Disabled plugins will no longer be loaded by DokuWiki, their stylesheets and JavaScript won't be loaded, and their syntax will no longer have any effect.
Templates are activated and deactivated by selecting the active template in the Configuration Manager.
Pressing the arrow button in the rightbottom corner will display some basic information about the chosen plugin read from two sources, namely
The information of the repository is shown firstly, next it is completed with some info of the local info file. This local info can be outdated.
Extensions can add useful features, but please be aware that installing 3rd party code may pose a security risk.
In the third tab “Search and Install” of the Extension manager you can search the extension repositories on dokuwiki.org for plugins and templates and install them using the “Install” button.
Plugins and templates not provided via the online repository or a version from a different download location can be installed via the fourth tab “Manual Install”. You can provide a url or choose an archive from your computer.
Depending on the automatically gathered information about installed extensions you may see an additional button for “Re-Install” or “Update”.
If you have installed an extension that shares the same name as one in the online repository but is a different one, do not use this feature for it.
You will see no such button for extensions that are not available in the online repository. This may be due to end of support, never having been added to the repository, or use of an alternative installation source. The latter especially for extensions that are installed using Git.
Re-Installing may be useful if you are not sure if something may have spoiled your extension.
When you press “Update” the Extension Manager will use the Download URL as provided via the online repository for retrieving updates. The extension manager will re-download the extension and install it again, overwriting the older version.
For the update process to work properly it is necessary that the date “Last updated on” in the Dokuwiki Extension repository equals the date in the file plugin.info.txt for plugins and template.info.txt for templates in the source tarbal/zipfile. If this is not the case: the update will not take place or the “Update” signal persists.
If an extension is updated, the Extension Manager will remove all the files listed in the deleted.files file if such a file is added to the extension.
Every installed extension has an “Uninstall” button.
If the installation of a defective or conflicting extension broke the “Uninstall” button or made your whole wiki unavailable, you can delete it by removing the extension's directory (or ask your administrator to do so):
/lib/tpl
(for a template) or /lib/plugins
folderAlternatively, if the goal is to disable temporary the plugin due to issues, you can also first try to disable the plugin by adding the following line to the local config.
$plugins['pluginname'] = 0;
The plugin also installs a command line plugin which allows to do all the actions mentioned above from the command line. This is especially useful if you want to automate the setup of your DokuWiki. Eg. using salt or ansible.
Run the following command in your DokuWiki directory for a list of commands and options:
./bin/plugin.php extension --help
To be able to install and modify your extensions, the webserver needs to be able to write to the lib/plugins
or the lib/tpl
directory and all files below. Refer to permissions for details on how set file permissions on various systems.
The extension manager will detect missing file permissions and warn you when a plugin or a template could not be installed. You have to install extensions manually in this case, by downloading and unpacking them in lib/plugins
or lib/tpl
yourself.
If you try to install extensions using the automatic download and install tool and get the error message “No plugins found, or there has been an unknown problem during downloading and installing.”, then you should check:
php-zlib
package.The rewrite of DokuWiki's Plugin Manager plugin was part of Google Summer of Code 2011 with Piyush Mishra as developer. Before inclusion it was rewritten by Michitux and Andi.
Please refer to DokuWikis bug tracker for reporting bugs or feature requests.