Plugins

You can add extra features to Siren Investigate by installing plugin modules.

You use the bin/investigate-plugin command to manage these modules.

Installing and enabling plugins

To install a plugin, run the following command:

bin/investigate-plugin install <path to the plugin zip file>

If the plugins were installed by a different user and the server is not starting, then you must change the owner of the optimize folder to the user running Siren Investigate, for example:

$ chown -R investigate /path/to/siren-investigate/optimize

Installing the Siren Entity Resolution plugin (beta)

For information about installing the Siren Entity Resolution plugin, see Siren Entity Resolution on the Siren Support Portal.

Updating and removing plugins

To update a plugin, remove the current version and reinstall the plugin.

To remove a plugin, run the following command:

$ bin/investigate-plugin remove <plugin ID>

You can also remove a plugin manually by deleting the plugin’s subfolder inside the plugins/ folder.

Removing a plugin causes an 'optimize' run of the system, which can delay the startup of Siren Investigate.

Switching off plugins

Before you begin, find the plugin ID by looking at the value of the name property in the plugin’s package.json file.

To switch off a plugin, run the following command:

./bin/investigate --<plugin ID>.enabled=false

Switching a plugin on or off causes an 'optimize' run of the system, which can delay the startup of Siren Investigate.

Custom Siren Investigate configurations

To specify the path to the configuration file that is used to start Siren Investigate, use the -c or --config options.

By default, Siren Investigate uses the config/investigate.yml file.

When you are using a customized configuration file, you must specify the path to that configuration file every time you use the bin/investigate plugin command.

Plugin manager exit codes

0

Success

64

Unknown command or incorrect option parameter

74

I/O error

70

Other error

Latest Siren plugins

You can find the latest beta plugins on the Siren Labs page of the Siren Support Portal.