Installation

Install integrations on your Polarity server

The Polarity Integration Framework provides a way to connect data sources to Polarity so that real-time notifications can be pushed to Polarity users based on data that is important to you.

In addition to connecting to existing datasources, the integration framework allows you customize how that data is displayed in the notification window.

Integrations

All Polarity Integrations are installed in a similar manner. You can install integrations by either downloading a tar archive from the GitHub releases page of the integration you are interested in, or by using git to clone the repo to your server.

In the instructions below we have provided example commands which will need to be modified depending on which integration you are installing. The following variables will need to be modified when you run the example commands:

{{integration_version}} : The version of the integration you are trying to install (e.g., “1.0.1-beta”, “0.0.1”, “2.0.0”, etc.)
{{integration_name}}: The name of the integration you are trying to install. For example, “virustotal”, “google-maps”, “crits”, etc. Note that the name of the integration will match the name of the repository in GitHub.

Installing via Git

Installing via git requires that your Polarity server has access to Github (https://github.com/polarityio) as well as the NPM registry (https://npmjs.com). If you do not have outbound access to those domains you can install integration by downloading a release.

Navigate to the integrations folder on your Polarity Server:

cd /app/polarity-server/integrations

Generally, you will want to clone the latest release of the integration using the following command:

git clone https://github.com/polarityio/{{integration_name}}.git

For example, to clone the latest VirusTotal integration you would use the following command:

git clone https://github.com/polarityio/virustotal.git

If you are looking to install a specific version you can do that as well:

git clone --branch {{integration_version}} https://github.com/polarityio/{{integration_name}}.git

As an example, if you wanted to install version 3.5.1-beta of the virustotal integration you would use the commands:

cd /app/polarity-server/integrations
git clone --branch 3.5.1-beta https://github.com/polarityio/virustotal.git

Once the repo has been cloned onto your server, change into the integration directory:

cd /app/polarity-server/integrations/{{integration_name}}

Use npm to install the integration’s dependencies run the npm install command from inside the integration's directory.

npm install --production

Ensure the integration directory is owned by the polarityd user

cd /app/polarity-server/integrations
chown -R polarityd:polarityd {{integration_name}}

Be careful when applying ownership to ensure you are targeting the integration directory specifically.

Restart the Polarity Server process.

systemctl restart polarityd

Restarting the Polarity service 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.

The integration is now installed and you can use the Integrations page in Polarity-Web to configure integration specific options. Please see the README.md file of the installed integration for details about integration specific options.

For information on configuring integrations, including making them available for users:

IntegrationsPolarity Enterprise Guide

Channel and Integration PermissionsPolarity Enterprise Guide

Installing via Package

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 tar.gz 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 tar.gz file to the Polarity Server’s integrations directory (/app/polarity-server/integrations).

If you have wget or curl installed on your Polarity Server 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 --directory-prefix=/app/polarity-server/integrations {{release-link}}

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

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

Untar and Install

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:

cd /app/polarity-server/integrations

Then, extract the tar file:

tar -xzvf {{filename}}

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

Ensure the integration directory is owned by the polarityd user

chown -R polarityd:polarityd {{integration_name}}

Restart the Polarity service so the new integration can be loaded.

systemctl restart polarityd

Restarting the Polarity service 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.

For information on configuring integrations, including making them available for users:

IntegrationsPolarity Enterprise Guide

Channel and Integration PermissionsPolarity Enterprise Guide

PreviousAuto Subscribe CLI Tool NextInstall Multiple Copies of an Integration

Last updated 1 year ago