Installation
Install integrations on the latest Polarity V5 version has become much easier and more streamlined as all installation is done simply though the UI now.
Last updated
Install integrations on the latest Polarity V5 version has become much easier and more streamlined as all installation is done simply though the UI now.
Last updated
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!
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 (aka the node packages are included) then you can click on the "Add Custom Integration" button and install the integration through the UI.
As stated above the custom integration will need to be fully packaged and in a .tgz or .zip file formats
Manual installation of integrations requires SSH access to the server.
Download the tgz file for the version of the integration you want to install (we typically recommend installing the latest version of the integration).
Once downloaded, upload the tgz file to the Polarity Server’s integrations directory (/app/integrations).
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.
This will place the download into the /app/integrations directory on your server.
Once you have downloaded/uploaded the integration to your Polarity Server you will need to untar it. First, ensure you are in the integrations directory:
Then, extract the tar file:
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.
As an example, if you were to manually install Cisco Umbrella the untar'd directory would be named cisco-umbrella. You will want to rename the directory so the dash is an underscore:
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.
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.
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 . You can find a link to the releases page on the right hand side of the integration’s GitHub repository.
Integrations with a dash (-) in the directory name will not be loaded properly by the v5 server. When manually installing integration you will need to ensure that you rename directories to use underscores (_) instead.
