====== Plugin Manager plugin ======

---- plugin ----
description: Manage and install plugins (bundled with DokuWiki)
author     : Chris Smith
email      : chris@jalakai.co.uk
type       : admin
lastupdate : 
compatible : (bundled)
depends    : 
conflicts  : 
similar    : 
tags       : configuration, management, plugins, !bundled
----

{{ :pluginmanager.png?350|The Plugin Manager}}

The Plugin Manager plugin allows [[config:superusers]] to administrate installed [[:plugins]] and install new ones. 

The Plugin is bundled with DokuWiki and does not need to be installed separately. The Plugin Manager is accessible from the admin screen (Login as superuser, click "Admin" and choose "Manage Plugins").

===== Usage Notes =====

==== Listing installed Plugins =====

This is the default action of the Plugin Manager. Each plugin is shown in its own row. A checkbox in front of the name indicates if the plugin is enabled or not.

Plugins listed with a light red background can not be deleted. Plugins with a light blue background are currently disabled.

==== Enabling/Disabling Plugins ====

To disable a plugin, uncheck the checkbox in front of its name and press the save button. Plugins are disabled by placing a ''disabled'' file into the plugin directory.

Disabled plugins will no longer be loaded by DokuWiki, their [[devel:css|Stylesheets]] and [[devel:JavaScript]] won't be loaded and their syntax will no longer have any effect.

==== Display Plugin Details ====

Pressing the info button will display some basic information about the chosen plugin and its components. The ''Source'' and ''Installed'' fields are only available when the plugin was installed through the Plugin Manager.

==== Installing a Plugin from a Remote URL ====

The plugin manager can download, unpack and install plugins for you. To install a new plugin follow these steps:

  -  Find the plug in you want in the [[plugins]] page
  -  Copy the link (URL) to the plugin package (in .tgz or .zip format) from the plugin's detail page
  -  Paste the link into the URL box on your Plugin Manager page and hit "Download"

==== Updating a Plugin ====

When you install a plugin with the plugin manager it will remember the download URL. To update a plugin you can simply press the "Update" button next to it and the Plugin Manager will redownload the plugin and install it again, overwriting the older version.

Note: This only works when the plugin maintainer always uses the same URL for the plugin or provides some redirection to the latest version through a common URL. If this is not the case just get the new URL and install it like a new plugin. The Plugin Manager then will update your old plugin.

Plugins that were not installed through the plugin manager can not be updated with this method. The "Update" button is disabled for these plugins.

===== File Permissions =====

To be able to install and modify your plugins, the webserver needs to be able to write to the ''lib/plugins'' directory and all files below. Refer to [[install:permissions]] on details how set file permissions on various systems.

The plugin manager will detect missing file permissions and warn you when a plugin could not be installed. You have to install plugins manually in this case, by downloading and unpacking them in ''lib/plugins'' your self.