Plugin manager

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

To use the plugin manager, click Plugins in the side navigation bar. The Plugins tab is accessible only to the Admin user.

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

Important: As of Digital.ai Deploy 10.2.0, the plugin manager is available in cluster mode.

View and install an official Digital.ai Deploy plugin

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

  1. In the side 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 to x.x.x.
  4. You must restart Digital.ai Deploy to finish the plugin installation process.

Important: Plugins which are shown on the Browse tab of the plugin manager are Digital.ai official plugins. Ensure there is network connectivity in order to see all the official Digital.ai Deploy plugins on the Browse tab.

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 side 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 Digital.ai Nexus). There are certain rules with installation of same plugins of different versions. Refer Plugin Synchronization for more information.

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

Remove a plugin

To remove a plugin:

  1. Shut down the Deploy server.
  2. You can delete Digital.ai Deploy plugins with the plugin manager command-line interface (CLI) from the database or filesystem. Refer Plugin Manager CLI for more information.
  3. Start the Deploy server. Depending on your system, execute one of the following:

    • Unix-based system: run.sh
    • Microsoft Windows: run.cmd
  4. Refresh the Deploy GUI in your browser.

Configure proxy for plugin manager

If the Digital.ai 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 https://plugins.xebialabs.com/nexus/ URL to fetch the plugins.

To configure the proxy settings for the plugin manager, add the below configuration to the conf/xl-deploy.conf file:

xl {
  features.plugins.servers.xebialabs-plugins.proxy {
                host = "proxy.example.com"
                port = 8888
                credentials{
                username = "user"
                password = "password"
              }
  }
}

Plugin Manager CLI

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

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