Installing CloudBees CD/RO plugins

2 minute read

Plugins can be installed from any of the following locations:

  • The Installed plugins tab on the Plugin management page in CloudBees CD/RO. From the Installed plugins tab, you can install a plugin from a file that is on the CloudBees CD/RO server host or from a URL.

  • The Plugins catalog tab on the Plugin management page in CloudBees CD/RO.

  • The CloudBees CD/RO plugins page at docs.cloudbees.com/plugins/cd.

Installing a plugin from a file

If you downloaded a plugin jar file to the server host, you can then install the file from the plugin manager.

To install a plugin from a file:

  1. From the main menu, select DevOps Essentials Plugin Management.

  2. On the Intalled plugins tab, select the Install plugin icon.

    Install plugin icon.300
    Figure 1. Install plugin icon
  3. On the Install plugin window, select File install.

  4. Click Browse to locate and select the plugin’s jar file in your local directory.

  5. (Optional) If a plugin of the same name is already installed and you want to overwrite it with the new plugin, select Disable plugin version check.

  6. Click Install.

    If this option is not available, you might not have the access control permissions to install a plugin.

    The server has a configurable maximum file upload size that defaults to 50 MB. Adjust the Maximum upload size setting on the server if a larger file upload size is needed.

Installing a plugin by using a URL

If you know the URL of a plugin you want to install, you can install it with the URL install option in the plugin manager.

To install a plugin by using a URL:

  1. From the main menu, select DevOps Essentials Plugin Management.

  2. On the Intalled plugins tab, select the Install plugin icon.

    Install plugin icon.300
    Figure 2. Install plugin icon
  3. On the Install plugin window, select URL install.

  4. In the blank field, type the URL for the plugin you want to install. For example, https://downloads.cloudbees.com/cloudbees-cd/plugins/EC-Git/latest/EC-Git.jar.

  5. (Optional) If a plugin of the same name is already installed and you want to overwrite it with the new plugin, select Disable plugin version check.

  6. Click Install.

    If this option is not available, you might not have the access control permissions to install a plugin.

    The server has a configurable maximum file upload size that defaults to 50 MB. Adjust the Maximum upload size setting on the server if a larger file upload size is needed.

Installing a plugin from the plugin catalog

The plugin catalog contains a list of all the available plugins for CloudBees CD/RO. You can search the plugin catalog for a plugin, and then install it from the catalog.

To install a plugin from the plugin catalog:

  1. From the main menu, select DevOps Essentials Plugin Management.

  2. On the Plugins catalog tab, locate the plugin you want to install, and then select Install.

Installing a plugin from the CloudBees CD/RO plugins page

The CloudBees documentation site includes the Plugins tab, where you can search for plugins. After locating a plugin, you can then download it.

  1. Go to CloudBees CD/RO plugins.

  2. In Search plugins, type the name of the plugin you want to install.

  3. Select the box for the plugin.

  4. On the plugin’s detail page, select Download Plugin.

  5. Select the downloaded jar file to install it.