Plugins manager

The Deploy plugin manager displays the list of installed plugins on the filesystem or database and their current version. You can manage your Deploy plugins directly from the Deploy user interface. You can upload a new plugin or update a new version of an installed plugin directly from the Deploy plugin manager user interface.

To use the plugin manager, click Plugins in the top menu bar.

You can view a list of all the installed plugins in Deploy under the Installed tab.

Important: The Plugins tab is accessible only to the Admin user.
Important: As of Deploy 10.2.0, the plugin manager is available in cluster mode.

View and install an official Deploy plugin

To view and install the official Deploy plugins, do the following steps:

  1. On the top navigation bar, click Plugins and then click on Browse tab.
  2. Click Install now on the respective plugin that you would like to install. At that point (while install is in process) if you wish to abort the installation process, you can click on Cancel installation.
  3. If there is a newer version of an already installed plugin available, the button will turn state and show Upgrade.

Important: You must restart Deploy to finish the plugin installation process.
Important: Plugins which are shown on the Browse tab of the plugin manager are coming from official Nexus repository. In order to see all the official Deploy plugins on the Browse tab, ensure there is network connectivity.

Plugins Manager

Upload a new plugin

To upload a new plugin or a new version of an existing plugin, do the following steps:

  1. In the top navigation bar, click Plugins and then click on Installed tab
  2. Click Upload new plugin file and then select and upload the plugin file from your local machine. Note: It is possible to upload either 3rd party or official plugins (works only with network connectivity to Nexus). There are certain rules with installation of same plugins of different versions. For more information, see Plugin Synchronization.

Important: After you upload a plugin, you must restart your Deploy instance.

Remove a plugin

To remove a plugin:

  1. Shut down the Deploy server.
  2. You can delete Deploy plugins with the plugin manager command-line interface (CLI) from the database or filesystem.

    For more information, see Plugin Manager CLI

  3. Start the Deploy server. Depending on your system, execute one of the following:

    • Unix-based system:
    • Microsoft Windows: run.cmd For more information, see Start Deploy.
  4. Refresh the Deploy GUI in your browser.

Configure proxy for plugin manager

If the Deploy server uses a proxy to connect to the internet, the plugin manager cannot install a plugin from the GUI. The plugin manager must access the URL to fetch the plugins.

To configure the proxy settings for the plugin manager, add the below configuration to the centralConfiguration/deploy-plugins.yaml file:

               host: ""
               port: 8888
                  username: "user"
                  password: "password" 

Plugin Manager CLI

Limited plugin management is available through command-line interface integrated into the server. For more information, see Plugin Manager CLI

Plugin storage

Plugins are stored in the database and users should be handling them only by using the GUI and CLI.

WARNING: All manual file operations (copying, renaming, moving, removing, etc.) inside the plugins folder is strictly not allowed

For more information, see Plugin synchronization