Installing Siren Platform
Prerequisites
The minimum hardware requirements are:
x64 CPU with four processing units (cores)
16GB RAM
10GB free SSD disk space
We support the following operating systems:
Microsoft Windows (64-bit)
Linux 2.6.32 or later (x86-64)
We support the following browsers:
Google Chrome
Mozilla Firefox
Microsoft IE 11
Microsoft Edge
You must install one of these Java versions:
Oracle JDK 8
OpenJDK 8
Ensure that the JAVA_HOME
environment variable is set to the appropriate path. To set the JAVA_HOME
environment variable, follow the instructions here.
If you want to connect an external datasource by using a JDBC connector, see JDBC driver installation and compatibility.
For information about compatibility between versions of Siren Investigate, Siren Federate, and Elasticsearch, see the version compatibility matrix.
Download the Siren platform
Download Siren Platform from https://siren.io/downloads/.
Complete the validation form, accept the license, and click Proceed.
Install Elasticsearch as a Windows service
Copy the
elasticsearch
folder and its contents from theZIP
archive you downloaded to yourProgram Files
folder.Edit the
elasticsearch.yml
file in the%ProgramFiles%\elasticsearch\config
folder.In the Path section, enter the data and log paths, for example:
path.data: C:\Program Files\elasticsearch\data path.logs: C:\Program Files\elasticsearch\logs
In the Network section, change the
network.host
to127.0.0.1
and save the file.From the command prompt, enter:
cd %ProgramFiles%\elasticsearch bin\elasticsearch-service install
Open the Services management console (you can enter
services.msc
at the command prompt).Locate the Elasticsearch service and change Startup Type to Automatic.
Right-click the service and select Start.
Install Elasticsearch as a Linux service
Create a system user for the service, for example
adduser --system elasticsearch
.Copy the
elasticsearch
folder and its contents from theZIP
archive you downloaded to the/opt
folder and then set the permissions for the system user, for examplesudo chown -R elasticsearch /opt/elasticsearch
.Edit the
elasticsearch.yml
file in the/opt/elasticsearch/config
folder.In the Path section, enter the data and log paths, for example:
path.data: /opt/elasticsearch/data path.logs: /opt/elasticsearch/logs
In the Network section, change the
network.host
to127.0.0.1
and save the file.From the command prompt, as root enter:
cat <<EOF >/opt/elasticsearch.environment ES_JAVA_OPTS="-Xms4g -Xmx4g" EOF cat <<EOF >/etc/systemd/system/elasticsearch.service [Unit] Description=Elasticsearch (Siren) After=network.target auditd.service [Service] WorkingDirectory=/opt/elasticsearch EnvironmentFile=-/opt/elasticsearch.environment ExecStart=/opt/elasticsearch/bin/elasticsearch KillMode=process Restart=on-failure RestartPreventExitStatus=255 Type=simple User=elasticsearch LimitMEMLOCK=infinity LimitNOFILE=65536 [Install] WantedBy=multi-user.target Alias=elasticsearch.service EOF echo "vm.max_map_count = 262144" > /etc/sysctl.d/99-elasticsearch.conf sysctl -p /etc/sysctl.d/99-elasticsearch.conf ln -s ../elasticsearch.service /etc/systemd/system/multi-user.target.wants/ systemctl daemon-reload systemctl start elasticsearch
Install Siren Investigate as a Windows service
Installing Siren Investigate as a service with Windows requires use of the third-party tool NSSM (https://nssm.cc/download). Because it configures services, anti-virus software may identify it as "riskware". However, an SHA checksum and source code are provided. You can verify the checksum using the Microsoft File Checksum Integrity Verifier (https://www.microsoft.com/en-us/download/details.aspx?id=11533).
Copy the
siren-investigate
folder and its contents from the Siren platformZIP
archive you downloaded to your%ProgramFiles%
folder.Copy the
nssm.exe
program from thewin64
folder in the NSSMZIP
archive you downloaded to the%ProgramFiles%\siren-investigate\bin
folder.Set the
INVESTIGATE_HOME
environment variable to%ProgramFiles%\siren-investigate
.From the command prompt, enter
%ProgramFiles%\siren-investigate\bin\nssm install "Siren Investigate"
.In the Application Path box, enter
%ProgramFiles%\siren-investigate\bin\investigate.bat
.In the Startup directory box, enter
%ProgramFiles%\siren-investigate
.On the Details tab, in the Display name box, enter
Siren Investigate
.On the Dependencies tab, in the box enter
elasticsearch-service-x64
.Click Install service.
Open the Services management console (you can enter
services.msc
at the command prompt).Locate the Siren Investigate service, right-click it and select Start .
Install Siren Investigate as a Linux service
Create a system user for the service, for example
adduser --system siren
.Copy the
siren-investigate
folder and its contents from theZIP
archive you downloaded to the/opt
folder and then set the permissions for the system user, for examplesudo chown -R siren /opt/siren-investigate
.From the command prompt, as root enter:
cat <<EOF >/etc/systemd/system/siren.service [Unit] Description=Siren Investigate After=network.target auditd.service [Service] WorkingDirectory=/opt/siren-investigate EnvironmentFile=-/opt/siren.environment ExecStart=/opt/siren-investigate/bin/investigate KillMode=process Restart=on-failure RestartPreventExitStatus=255 Type=simple User=siren [Install] WantedBy=multi-user.target Alias=siren.service EOF ln -s ../siren.service /etc/systemd/system/multi-user.target.wants/ systemctl daemon-reload systemctl start siren
Test your connection
In your browser, navigate to http://localhost:5606/status. If the Elasticsearch and Siren Investigate services are running, the sign in screen is displayed.
Next steps
Import data either by using Logstash, by connecting to JDBC datasources, or by uploading Excel or CSV files.