Siren Platform User Guide

Setting up Siren Investigate

This section includes information on how to set up Siren Investigate and get it running, including:

  • Downloading

  • Installing

  • Starting

  • Configuring

  • Upgrading

Supported platforms

Packages of Siren Investigate are provided for and tested with Linux and Windows. Because Siren Investigate runs on Node.js, the required Node.js binaries for these platforms are included. Running Siren Investigate against a separately maintained version of Node.js is not supported.

Version compatibility

Siren Investigate should be configured to run against the Elasticsearch node of the supported version.

Table 1. Version compatibility matrix

Siren Investigate

Siren Federate

Elasticsearch

10.0.2

5.6.4-10.0.2 to 5.6.10-10.0.2

5.6.4 to 5.6.10

10.1.0

5.6.10-10.1.0

5.6.10

6.3.2-10.1.0

6.3.2



Running different major version releases of Siren Investigate and Elasticsearch, for example Siren Investigate 10.x and Elasticsearch 2.x, is not supported, nor is running a minor version of Siren Investigate that is newer than the version of Elasticsearch, for example Siren Investigate 10.0.x and Elasticsearch 5.0.x.

Running a minor version of Elasticsearch that is higher than supported version will generally work to facilitate an upgrade process where Elasticsearch is upgraded first, for example Siren Investigate 10.0.x and Elasticsearch 5.7.x. In this configuration, a warning will be logged on Siren Investigate server startup, so it is only meant to be temporary until Siren Investigate is upgraded to the same version as Elasticsearch.

Running different patch version releases of Siren Investigate and Elasticsearch, for example Siren Investigate 10.0.0-1 and Elasticsearch 5.6, is generally supported, though we encourage users to run the supported versions of Siren Investigate and Elasticsearch down to the patch version.