Installing a plugin
Error rendering macro 'viewport-redirect'
Only pages and blog posts are supported as redirect target.
This page describes how to install a plugin in Bamboo. You can use plugins to customize and extend the functionality of Bamboo.
A number of plugins are available from the Atlassian Plugin Exchange. You can also create your own as described in the Bamboo Plugin Guide.
Adding a plugin from the Atlassian Plugin Exchange
- Log in as a user with the 'Admin' global permission.
- Click Administration in the top navigation bar.
- Click Plugin Manager, in the left-hand panel, under 'Plugins'.
To find a plugin in the Atlassian Plugin Exchange and add it to Bamboo:
- Click the 'Install' tab in the UPM. You will see a list of featured plugins.
- Search for your plugin as follows:
- Enter some keywords that describe the plugin in the 'Search the Plugin Exchange' search box and press 'Enter'.
- Alternatively, browse to the desired plugin in the list. You can choose 'Featured', 'Popular', 'Supported' (by Atlassian) or 'All available' from the 'Plugins to show' dropdown to see a different list of plugins.
- Click the 'Install' button for the desired plugin to add it to your application. A confirmation message and the plugin details will appear when the plugin is installed successfully.
Note: You may need to restart your application for your change to take effect. The Universal Plugin Manager will inform you if this is the case.
Note: Not all plugins can be automatically installed. Some required manual installation. These plugins will have a 'Download' button instead of an 'Install' button. In these cases, you should read and follow the plugin's installation instructions.
Now, restart Bamboo with the plugin installed.
On this page:
Related pages:
Uploading your own plugin
Upload an app using the UI
Since the Bamboo 9.2.11, the upload button used to install apps from the marketplace has been disabled.
It's possible to re-enable the upload button so that you can upload apps through the UI. To do that, add the -Dupm.plugin.upload.enabled=true considering your operating system. For more details, see Configuring your system properties.
After restarting Bamboo, the upload button will be accessible again.
To upload an app use the following steps:
- Log in as a user with the 'Admin' global permission.
- Click Administration in the top navigation bar.
- Click Plugin Manager, in the left-hand panel, under 'Plugins'.
To upload your own plugin to Bamboo:
- Click the 'Install' tab in the UPM. You will see a list of featured plugins.
- Click the 'Upload Plugin' link. The 'Upload Plugin' window will appear.
- Specify the location of your plugin:
- If the plugin you want to install is on your computer, use the 'Browse' dialogue to choose the plugin JAR file.
- If you want to install a plugin from a remote location, enter the URL of the plugin JAR file in the 'From this URL' text box.
- Click the 'Upload' button to upload and enable your plugin. A confirmation message will appear when the plugin is successfully installed.
Note: You may need to restart your application for your change to take effect. The Universal Plugin Manager will inform you if this is the case.
Now, restart Bamboo with the plugin installed.
Screenshot: Uploading a new plugin
Upload app JAR file manually
If, for security reasons, admin can't enable the upload app using UI, the app still can be uploaded directly to the plugin folder with following these steps:
- Stop Bamboo.
- Copy your JAR file into the directory:
<bamboo-shared-home>/plugins. - Start Bamboo.
- Confirm the installation by going to Administration > Manage apps. The add-on should appear in the list as enabled.
Notes
- In Bamboo, you can install and uninstall version 2 (but not version 1) plugins using the Universal Plugin Manager. You will see an Install or an Uninstall button.
- Some entries that you find listed in the Universal Plugin Manager are not actually plugins. These entries will show a Download button that allows you to download the application to your desktop and run it.