Skip to main content

FossID

FossID

Export reports from FossID.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  reporter:
    reporters:
      FossID:
        options:
          serverUrl: <OPTIONAL_STRING>
          reportType: XLSX
          selectionType: INCLUDE_ALL_LICENSES
        secrets:
          apiKey: <OPTIONAL_SECRET>
          user: <OPTIONAL_SECRET>

Options​

serverUrl​

STRING Required

The URL of the FossID server to connect to.

apiKey​

SECRET Required

The API key to use for authentication.

user​

SECRET Required

The user to authenticate as.

reportType​

ENUM Default

Possible values: HTML_DYNAMIC, HTML_STATIC, SPDX_RDF, XLSX

The type of report to generate.

selectionType​

ENUM Default

Possible values: INCLUDE_ALL_LICENSES, INCLUDE_COPYLEFT, INCLUDE_FOSS, INCLUDE_MARKED_LICENSES

The type of selection to use.