Managing Add-ons

About Add-ons

An add-on is an installable component that supplements or enhances the functionality of JIRA in some way. For example, the JIRA Calendar Plugin is an add-on that shows the due dates for issues and versions in calendar format. Other add-ons are available for connecting JIRA to Bamboo, developing for JIRA, and accessing Atlassian support from JIRA.

JIRA comes with many pre-installed add-ons (called system add-ons). You can install more add-ons, either by acquiring an add-on from the Atlassian Marketplace or by uploading an add-on from your file system. This means that you can install add-ons that you have developed yourself. For information about developing your own add-ons for JIRA, see the JIRA Developer documentation.

To enable various JIRA Gadgets (for example, the Text Gadget), please refer to this section: Configuring the Default Dashboard.

On this page:

You may notice that the terms 'add-on' and 'plugin' both appear in the Atlassian documentation and tools. While the terms are often used interchangeably, there is a difference. A plugin is a type of add-on that can be installed into an Atlassian host application. Plugins are what developers create with the Atlassian SDK. But there are other types of add-ons as well. For example, the JIRA client is an add-on that runs as a separate program rather than as a plugin to JIRA. This documentation uses the term 'add-on' most often.

About the Universal Plugin Manager

The Universal Plugin Manager (UPM) is itself an add-on that you use to administer add-ons from the JIRA Administration Console. UPM works across Atlassian applications, providing a consistent interface for administering add-ons in JIRA, Confluence, Crucible, Fisheye, Stash or Bamboo.

UPM comes pre-installed in recent versions of all Atlassian applications, so you do not normally need to install it yourself. However, like other add-ons, the UPM software is subject to regular software updates. Before administering add-ons in JIRA, therefore, you should verify your version of the UPM and update it if needed.

You can update UPM, or any add-on, from the UPM's own add-on administration pages. In addition to updating UPM, you can perform these tasks from the administration pages:

If the add-on request feature is enabled in your Atlassian application, non-administrative users can also discover add-ons on the Atlassian Marketplace. Instead of installing the add-ons, however, these users have the option of requesting the add-ons from you, the administrator of the Atlassian application.

For more information on administering the add-on request feature or performing other common add-on administration tasks, see the Universal Plugin Manager documentation. For an end-user's view of requesting add-ons in JIRA, see Requesting Add-ons.

Was this helpful?

Thanks for your feedback!

28 Archived comments

  1. User avatar

    Omar Hussain

    Is there no way to see what plugins were added beyond the default ones that come with the standard JIRA installer?

    I am trying to migrate to a new Jira instance and its time consuming figuring out from this large list of plugins which ones came with it and which were added later

    21 Jan 2010
    1. User avatar

      Rosie Jameson [Atlassian]

      Not via the JIRA admin screens at this time, sorry. You may like to vote for this issue: JRA-19636.

      Your best option would be to search for files in your JIRA installation that have a modified date that is later than JIRA's files.

      21 Jan 2010
  2. User avatar

    Larry Gilbert

    Not all plugins can be disabled using the instructions here, as some plugins do not offer a "Disable plugin" link (I am finding that about half of the plugins in my installation can't be disabled because of this).  Some more information on why this happens would be helpful.

    24 Mar 2010
  3. User avatar

    Brett Ryan

    Hi, I'm starting to develop v2 plugins with the SDK and am having a bit of a situation with the plugins not refreshing when redeployed.

    I start developing using the SDK, get to a point, then check in to Git, and at the same time build my plugin (using the 1.0-SNAPSHOT version), I deploy, all is fine.

    The problem arises when I update the plugin and redeploy. After I restart JIRA the old plugin is still loaded, I've tried deleting the webapps and work directories but no luck there, what's causing my old plugin to danlge around?

    I can solve this by updating the version, but the point is I want to eventually add this to a build server that will redeploy the plugins to our test JIRA once the system is down each night, I only want to update the version (as is why I'm using SNAPSHOT) when I'm ready for "production ready" code.

    Am I missing an uninstall step here or something?

    09 May 2010
  4. User avatar

    Anonymous

    Brilliant. I am trying to install the "Universal Plugin Manager" (why does it not come pre-installed???), and the help for that thing leads to this page. Here it tell me to "use the universal plugin manager...". Brilliant, just brilliant.

    12 Mar 2011
  5. User avatar

    Daniel Varela Santoalla

    Hello, just one minor thing. In my test LAN-based, no internet connection installation, the "Manage Plugins" admin page can not get any information about the plugins (clicking just gets the "wheel of death" and then just a pink bar), even for my locally developed plugins. In the logs I see that it is timing out when connecting somewhere, which is hosted in contegix.com.

    It would be nice to have the interface behaving properly even when there is no internet connection from the host. I guess it is trying to see if there are updated versions of the plugins but it is silly to just do that every time and to not display any data/controls (no enable/disable, no version number) if it fails.

    I'm using 4.3 btw

    11 Apr 2011
    1. User avatar

      Anonymous

      I am having the same issue. I'm unable to enable/disable/configure any plugins due to this.

      27 Apr 2011
  6. User avatar

    Mohammed Idrissi

    i want to create a plugin that creates issue's subtask programmatically , i mean i want to create 2 combobox , one of the projects present in my jira and the the second combobox is of the issues of the project selected and a textfield to give a name to a subtask and a submit button to create the issue's subtask...
    help please

    29 Jun 2011
  7. User avatar

    Anonymous

    Hi to all!

    I'm looking to get a list of plugins that are installed in a particular project.

    Greetings.

    11 Jul 2011
  8. User avatar

    Anonymous

    Hi 

    I am using Jira 5.0, but i cannot find the *Upgrade* tab in the *Manage my plugins* page. Whats missing?

    Regards

    Zahn

    20 Mar 2012
    1. User avatar

      Tuukka Ilomäki

      I was wondering the same thing. It seems that upgrade tab is not displayed if no updates are available - at least in the current Jira version. In one instance that I administer, the upgrade headingwas displayed. After I performed the upgrade, the heading vanished. The documentation is misleading when it says that you will see a list of plugins that are available for upgrading, under the heading 'Available Updates'. I would appreciate if I would see text "all you plugins are up to date" under that heading if there are no plugins available for upgrading instead of having to wonder if I am not looking at the right place.

      18 May 2012
  9. User avatar

    J Thomas

    Hi, thanks for the instructions on how to install my own v2 plugin.

    Please could you update the documentation to explain how I can update my own plugin?  It appears to be possible by installing it again (Install tab > Upload Plugin link) without uninstalling it first but is this the correct way or is there some way to tell JIRA to display an updated version in the Upgrade tab?  (My plugin isn't in the Plugin Exchange.)

    It would be reassuring to see the recommended way documented rather than having to guess and hope I haven't broken anything...

    Are there any Gotchas to watch out for eg don't put your jar into the installed-plugins directory when re-installing it via the UPM (it seems the UPM creates a copy of the jar which means you'd end up with two - possibly a problem if JIRA is restarted?)?

    26 Mar 2012
  10. User avatar

    Anonymous

    Hi,

    Could it be so, if there is no plugins/installed-plugins/ under JIRA home directory?

     

    18 Jul 2012
    1. User avatar

      Ivan Tse [Atlassian]

      That can definitely be the case. You will only have plugins in that directory if you've installed anything on top of system plugins. System plugins are stored elsewhere. This means that you will see items in that location if you installed plugins yourself. Updated versions of plugins will appear in that folder as well.  

      18 Jul 2012
  11. User avatar

    MadhanBabu

    Hello,

    When a plugin, say for example a plugin which gives a new feature, is accessed by multiple users  concurrently, the data structures defined withing the plugin's code are shared. Is there a way to avoid this?

    Note: I am not using any thread based codes within my plugin.

     

    Best regadrs

    Madhan

     

    24 Jul 2012
  12. User avatar

    Jon Abad

    Can a section be added to this document to explain the "Plugin Requests" functionality?

    I think it was added in 5.0 but i don't understand how someone triggers it and thus why i want to disable it.

    03 Aug 2012
    1. User avatar

      Andrew Frayling

      Seconded. I can't find any information on how users request plugins to be installed either so some explanation of this new functionality would be useful.

      24 Aug 2012
    1. User avatar

      Marcel Trautwein alias childno͡.de

      1. This feature is linked behind the new "Atlassian Marketplace" Menu item in the users menu
        This will lead the user to /plugins/servlet/upm/requests
        If you are an administrator, you are prompted for admin password and then redirected to /plugins/servlet/upm/marketplace
      2. It's exactly the same in Confluence and in Jira as it is part of the Universal Plugin Manager
      3. you might disable this at the bottom of the UPM (Universal Plugin Manager / "Manage Plugins") page.
        Then this menu Item only be shown to administrators!
      05 Sep 2012
  13. User avatar

    Anonymous

    Hi there,

    How can I get the Universal Plugin Manager when I use the Atlassian OnDemand? There is no "Home Directory"... and I cannot determine which version I use (although I think it should be the newest version).

    Thanks for your help!

    05 Sep 2012
    1. User avatar

      Renjith [Atlassian]

      Atlassian OnDemand has restrictions on plugins. Please check the Restricted Functions in Atlassian OnDemand for details. You cannot install additional third party plugins in OnDemand.

      05 Sep 2012
  14. User avatar

    Anonymous

    Hi everybody When i enable plugins i cant delete any issue in JIRA 5.1. ıs there anybody have same problem or can help me anybody  thanks for that..

    14 Sep 2012
    1. User avatar

      Ivan Tse [Atlassian]

      Off the top of my head I can't tell you why that might be. It could be because of the type of plugin you're installing. If you need additional help with it, I suggest you log a support ticket so you can share specifics with us.

      14 Sep 2012
  15. User avatar

    Anonymous

    I was wondering how you use the "Plugin Request" feature.  I came across this information...thought it would have been useful to find it here...so I'm sharing it here:

    Users have a new option under their user name titled "Atlassian Marketplace". If a user clicks on that they get sent to the marketplace page where they can search through plugins and use the request button to make a request. They get an option to include a note with the request.  If you are an Administrator, you will only get the install option.

    To see the full post, go here:

    https://answers.atlassian.com/questions/80693/how-do-you-use-the-new-plugin-requests-feature-in-upm-2-5-1

     

    12 Dec 2012
    1. User avatar

      Anonymous

      The UPM Plugin Request information is fully documented here: 

      https://confluence.atlassian.com/display/UPM/Requesting+Add-ons

      12 Dec 2012
  16. User avatar

    Bryce

    Can you still use JIRA while updating a plugin?  

    12 Jul 2013
    1. User avatar

      Susan Griffin [Atlassian]

      Yes, you should be able to. However, like all things, it will depend on the plugin that is being updated and what else is going on in JIRA at the time.

      15 Jul 2013
  17. User avatar

    Anonymous

    Hello,

     

    I'm trying to update JIRA's (v 6.1.1) plugins via UPM (v 2.13.3), but without success. My test below is for UPM update to the last version:
    "An unexpected error occurred. Refer to the logs for more information."

    In the logs:

    2014-01-21 11:15:22,608 UpmAsynchronousTaskManager:thread-3 ERROR xxxxx 628x331148x3 6z2o2m 10.32.29.10 /rest/plugins/1.0/available/featured [com.atlassian.upm.SelfUpdateControllerImpl] Unable to install self-update plugin: java.lang.RuntimeException: Could not install plugin: upm-selfupdate8263464139574754912.jar

    Is it possible update of the plugins without stopping the JIRA and replace the jar files at plugin install folder? Could be some bug? I didn't find any task for such problem.

    Could you please provide some information as soon as possible.

    Thank you in advance!

     

     



    21 Jan 2014
    1. User avatar

      Andrew Lui [Atlassian Technical Writer]

      Hi,

      Can you raise a support request? Our support team will help you resolve your issue.

      Kind regards,
      Andrew

      21 Jan 2014
Powered by Confluence and Scroll Viewport