Siren Platform User Guide

Pulling the Image

Obtaining Siren Investigate for Docker is as simple as issuing a docker pull command.

The Docker image for the latest Siren Investigate can be retrieved with the following command:

docker pull sirensolutions/siren-platform:latest
docker run -d -p 5606:5606 -p 9220:9220 sirensolutions/siren-platform:latest

Or for specific version, for example 10.0.0:

docker pull sirensolutions/siren-platform:10.0.0
docker run -d -p 5606:5606 -p 9220:9220 sirensolutions/siren-platform:10.0.0

For an image pre-populated with demonstration data:

docker pull sirensolutions/siren-platform-demo-data:latest
docker run -d -p 5606:5606 -p 9220:9220 sirensolutions/siren-platform-demo-data:latest
Environment variable configuration

Under Docker, Siren Investigate can be configured using environment variables. When the container starts, a helper process checks the environment for variables that can be mapped to Siren Investigate command-line arguments.

For compatibility with container orchestration systems, these environment variables are written in all capitals, with underscores as word separators. The helper translates these names to valid Siren Investigate setting names.

Some example translations are shown here:

Table 2. Example Docker Environment Variables

Environment Variable

Siren Investigate Setting

SERVER_NAME

server.name

KIBANA_DEFAULTAPPID

kibana.defaultAppId

XPACK_MONITORING_ENABLED

xpack.monitoring.enabled



In general, any setting listed in Configuring Siren Investigate or X-Pack Settings can be configured with this technique.

These variables can be set with docker-compose like this:

services:
  investigate:
    image: docker.elastic.co/kibana/kibana:10.0.0
    environment:
      SERVER_NAME: siren.example.org
      ELASTICSEARCH_URL: http://elasticsearch.example.org

Because environment variables are translated to CLI arguments, they take precedence over settings configured in investigate.yml.

Docker defaults

The default settings when using the siren-investigate image (standalone Siren Investigate image) are:

elasticsearch.url

http://localhost:9220

server.basepath

""

kibana.index

.siren

Search results

    No results found