sirensolutions/siren-platform-easy-start repository overview

⁠Siren Platform

The Siren Platform is comprised of two core components:

• Siren Investigate, the node.js based browser application (includes the Siren Alert component). For those familiar with the ELK stack, this has a similar role to Kibana
• Elasticsearch cluster(s) in which the Siren-Federate plugin has been installed

⁠Available from 10.3

Optional components that can be added to the platform include the Siren ER (beta)⁠ Docker container for entity resolution capabilities

For more information, please check the following links:

• Website⁠
• Documentation⁠

⁠Running the image

⁠Elasticsearch vm.max_map_count setting

To run Elasticsearch, vm.max_map_count must be set on the Docker host to at least 262144.

For more information and OS specific instructions, see here⁠.

The exposed ports are:

• 5606: Investigate HTTP server
• 9220: Elasticsearch REST interface

To run the image, execute the following command:

docker run -d -p 5606:5606 -p 9220:9220 sirensolutions/siren-platform-demo-data:10.2.2

Then connect to https://localhost:5606 to try the demo.

By default, the logs of Siren Investigate and Elasticsearch are stored in log files within the container.

If you wish to pass the logs out of the container, e.g. to access with docker logs <id>, add -e sirenlogs=host to the docker run command above.

⁠Troubleshooting

⁠docker-machine

If using docker-machine, change localhost to the IP address of docker-machine.

⁠Mac Docker Users

See here⁠ if there are any issues and for known limitations and workarounds.

⁠Windows Docker Users

Accessing docker containers in Windows may require a small adjustment to the NAT rules of VirtualBox. To expose port 5606 (and allow access to https://localhost:5606), try the following:

• Go to VirtualBox and select your VM image
• Choose NAT
• Click on Advanced
• Click on Port Forwarding
• Add a new rule that maps localhost:5606 to the VM port 5606
• Click OK and OK again to get back to VirtualBox's main page
• Restart the image by
  • rightclicking the image,
  • select Close -> Save State
  • rightclick again and select Start