Configuring jsreport

This section describes how to run jsreport using Docker or by installing the distribution directly on your system.

Siren Investigate works as a reverse proxy to jsreport, so a custom jsreport configuration is needed to:

  • Disable the built-in authentication extension (authentication will be handled by Siren Investigate).

  • Ensure that the jsreport application is available at the /reporting path.

Network access to the jsreport server should be allowed only to the Siren Investigate server.

Preparing the configuration file

Create a file named jsreport.config.json with the following contents:

{
  "httpPort": 5488,
  "appPath": "/reporting",
  "mountOnAppPath": true,
  "store": {
    "provider": "fs"
  },
  "blobStorage": {
    "provider": "fs"
  },
  "allowLocalFilesAccess": true,
  "reportTimeout": 60000,
  "extensions": {
    "authentication": {
      "enabled": false
    },
    "sample-template": {
      "createSamples": true
    }
  }
}

If you are running Siren Investigate with a custom server.basePath setting, make sure to include the basePath in the appPath setting. For example, if server.basePath is set to "/inve" in your investigate.yml file, appPath has to be set to "/inve/reporting" in the jsreport.config.json file.

Licensing

If you have a valid license key for jsreport it can be added to jsreport.config.json using the licenseKey property, for example:

{
  "httpPort": 5488,
  ...
  "licenseKey": "yourkey"
}

Advanced configuration options

You can find the full list of configuration options in the jsreport configuration reference.

Next steps

To run jsreport using Docker, see Running jsreport with Docker.

To run jsreport using a local node.js installation, see Running jsreport with node.js.