Installing Polarity Integrations

Installing integrations on Polarity v5 has become much easier and more streamlined, as installation can be done though the UI.

Install Integration through Store 

Polarity users and admins can now see all of our officially supported integrations right from the store as well as install update or view more information about those integrations on what they do! 

Admins can just navigate to the integration you want to install and hit the Install Button! 

Upload Integration through UI 

If there is a custom integration that someone has developed it can easily be added to Polarity by uploading the .tgz or .zip package. 

Ensure you have the integration fully installed (ie. the Node packages are included) then you can click on the "Add Custom Integration" button at the top right of the Integrations view and install the integration through the UI. 

Manual Integration Installation 

Manual installation of integrations requires SSH access to the server.  

Download the Release

Navigate to the releases page for the integration you are installing. The URL should look like https://github.com/polarityio/{integration_name}/releases.  For example, the releases page for the Virustotal integration is https://github.com/polarityio/virustotal/releases. You can find a link to the releases page on the right-hand side of the integration’s GitHub repository.

Download the .tgz file for the version of the integration you want to install (we typically recommend installing the latest version of the integration). 

For v5 servers before sure to download the .tgz file marked as being compatible with Polarity Server 5.x.

Once downloaded, upload the .tgz file to the Polarity Server’s integrations directory (/app/integrations).

Direct Download with wget or curl

If you have wget or curl installed on your Polarity Server and your server has access to GitHub, you can download the release directly onto your server. Right click on the release link and copy the download link to your clipboard. Save a copy of this link as you will need it to download the release onto your server.

With the link from above, you can download the link using either curl or wget.

wget

wget --directory-prefix=/app/integrations {{release-link}}

cd /app/integrations
curl -O {{release-link}}

This will place the download into the /app/integrations directory on your server.

Extract Integration Package

Once you have downloaded/uploaded the integration to your Polarity Server you will need to untar it.  Navigate to the integrations directory and extract the tar file:

cd /app/integrations
tar -xzvf {{filename}}

The extracted directory will not include the version number. For example, after untaring the file virustotal-3.7.4+node-18.tgz, the directory will just be called "virustotal".  This is deliberate and makes it easier to manage integration updates.

Rename Integration Directory

As an example, if you were to manually install Cisco Umbrella the untar'd directory would be named cisco-umbrella.  You need to rename the directory so the dash is an underscore:

mv cisco-umbrella cisco_umbrella

Restart Server

Once the integration directory is in place you can restart the Polarity containers using the provided down and up scripts so the new integration can be loaded.

cd /app && ./down.sh && ./up.sh

Updating Integrations

To update an integration follow the same steps as you did when initially installing.  When untaring the integration, the new integration files will replace the existing files.

Restarting the Polarity containers is only required when installing a new integration.

If you are updating an existing integration, you can restart the integration from the Polarity web interface.