Serving private documentation

There are links to the documentation from within Siren Investigate. By default, these link to the latest documentation at https://docs.siren.io/.

To view the documentation, from the app menu, click Help > Siren Platform documentation. Additionally, there are links throughout Siren Investigate to the documentation for specific features.

Siren Investigate comes bundled with a copy of the documentation in the docs/html5 folder. You can configure it to open this documentation instead or alternative documentation from a custom folder. This makes it possible to access documentation in a closed environment that does not have access to the internet.

Serving the bundled documentation

  1. In investigate.yml, set the following property:

    investigate_core.documentation_dir: "docs/html5"

  2. Restart Siren Investigate and confirm that the documentation is served at //host:port/ui/documentation/ and that the documentation links within Siren Investigate open your local files.

Serving documentation from a custom folder

To serve the documentation from another folder:

  1. Create the folder and add the documentation files.

  2. In investigate.yml, set the following property:

    investigate_core.documentation_dir: "/path/to/folder_containing_the_documentation"

  3. Restart Siren Investigate and confirm that the documentation is served at //host:port/ui/documentation/ and that the documentation links within Siren Investigate open the intended files.