Documentation for JIRA 4.1. Documentation for other versions of JIRA is available too.
On this page:
A plugin is a .jar file (containing code, resources and a configuration file) that can be installed into an Atlassian product to add new functionality or change the behaviour of existing features.
You can use plugins to customise and extend the functionality of JIRA in a variety of ways, including:
JIRA ships with a number of preinstalled plugins, and many more are available for download from the Atlassian Plugin Exchange.
You can also create your own plugins — please visit the JIRA Development Hub for information on building 'Version 1' plugins, or visit the Plugin Framework for information on building 'Version 2' (OSGi) plugins. These plugins can be installed in your JIRA instance as described below.
Installed JIRA plugins can be enabled or disabled.
Every plugin is made up of one or more plugin modules. A single plugin may do many things, and each module represents a single function of the plugin. Individual modules can be enabled or disabled, although this is not recommended as modules can often depend on each other. To do so safely would require knowledge of the module interdependencies.
There are two types of Atlassian plugins:
atlassian-jira/WEB-INF/lib/
.
plugins/installed-plugins/
. 'Version 2' plugins are deployed in an internal OSGi container to isolate the plugin from the core code and other plugins, and to allow sophisticated dependency management. 'Version 2' plugins have to be specifically declared as such, using the plugins-version="2"
attribute in the plugin's configuration file (atlassian-plugin.xml
). Go to https://plugins.atlassian.com and look at the plugin's details. The 'Plugin System' field will show 'ONE' for Version 1 plugins and 'TWO' for Version 2 plugins.
atlassian-jira/WEB-INF/lib/
.plugins/installed-plugins/
.If you copy the JIRA jar file of a 'Version 1' plugin into the installation directory for 'Version 2' plugins (or vice versa), JIRA provides a warning, indicating that the plugin has been installed into the wrong directory.
However, there may be a very small number of 'Version 1' plugins (such as the JIRA RPC Plugin) which, when accidentally installed into the 'Version 2' plugins directory (<JIRA home directory>/plugins/installed-plugins/
), will not generate this warning. Nevertheless, the plugin will not function correctly and the JIRA administration 'Plugins' page typically indicates that this plugin has zero modules.
To rectify this problem, reinstall the plugin jar to the correct directory by:
<JIRA installation directory>/atlassian-jira/WEB-INF/lib/
The process for updating a plugin is similar to installing a new one. Simply download or create your updated plugin jar, then follow these steps to install it in your JIRA instance:
atlassian-jira/WEB-INF/lib/
.plugins/installed-plugins/
.
Also note that JIRA can automatically disable plugins if they cause errors on startup or initialisation. This is usually caused by having an old version of the plugin that is not compatible with your current version of JIRA. If this occurs, it will be indicated on the 'Current Plugins' page (shown above). You will need to stop JIRA, install the newer version of the plugin and restart JIRA.
Note: newly installed plugins are enabled by default.
To enable a plugin:
Follow these steps to uninstall a plugin from your JIRA instance: