Skip to content

Commit

Permalink
docs(website): Add a section for the new BlackDuck advisor
Browse files Browse the repository at this point in the history
Signed-off-by: Frank Viernau <x9fviern@zeiss.com>
  • Loading branch information
fviernau committed Dec 28, 2024
1 parent 0fd398c commit 6858178
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions website/docs/tools/advisor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,28 @@ The providers require specific configuration in the [ORT configuration file](htt
When executing the advisor, the providers to enable are selected with the `--advisors` option (or its short alias `-a`); here a comma-separated list with provider IDs is expected.
The following sections describe the providers supported by the advisor:

## Black Duck

This vulnerability provider obtains information about security vulnerabilities from the Black Duck instance specified in the configuration.
The configuration is mandatory, because authentication is required.
:::note
The implementation is in *experimental* state.
:::
Initial experiments indicate that it works with the ecosystems mentioned [over here](https://github.com/oss-review-toolkit/ort/issues/9638).

```yaml
ort:
advisor:
config:
BlackDuck:
options:
serverUrl: 'server-url'
secrets:
apiToken: 'token'
```
To enable this provider, pass `-a BlackDuck` on the command line.

## OSS Index

This vulnerability provider does not require any further configuration as it uses the public service at https://ossindex.sonatype.org/.
Expand Down

0 comments on commit 6858178

Please sign in to comment.