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/optimizeInstalling the Siren Entity Resolution plugin (beta)
For information about installing the Siren Entity Resolution plugin, see the Siren ER User Guide.
Installing the Siren NLP plugin (beta)
For information about installing the Siren NLP plugin, see the Siren NLP documentation.
Enabling the Jira plugin (beta)
For information about enabling the Jira integration feature, see the Jira plugin documentation.
Enabling the IBM® i2® Analyst’s Notebook plugin (beta)
For information about enabling the IBM i2 export feature, see Exporting a graph to IBM i2 Analyst’s Notebook.
CLI options
You can use the following command line options when installing a plugin:
| Long option | Short option | Description |
|---|---|---|
|
|
Disables all process messaging except errors. |
|
|
Disables all process messaging. |
|
|
Specifies the path to the Investigate config file. |
|
|
Specifies the length of time before failing in milliseconds. |
|
|
Downloads from a URL without validating its SSL certificate. |
|
|
Specifies the directory where plugins are installed. |
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. |
CLI options
You can use the following command line options when removing a plugin:
| Long option | Short option | Description |
|---|---|---|
|
|
Disables all process messaging except errors. |
|
|
Disables all process messaging. |
|
|
Specifies the path to the Investigate config file. |
|
|
Specifies the directory where the plugin is stored. |
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.