Skip to content

docs: Fix vulnz links #7647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Fix vulnz links #7647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ant/src/site/markdown/config-purge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Configuration: dependency-check-purge Task
--------------------
The following properties can be set on the dependency-check-purge task.

Property | Description | Default Value
---------------|----------------------------------------------------------------------------|--------------------------------------------------
dataDirectory | Data directory that is used to store the local caches and NVD CVE database | `<folder-of-dependency-check-ant.jar>/data/11.0`
failOnError | Whether the build should fail if there is an error executing the purge | true
| Property | Description | Default Value |
|---------------|----------------------------------------------------------------------------|--------------------------------------------------|
| dataDirectory | Data directory that is used to store the local caches and NVD CVE database | `<folder-of-dependency-check-ant.jar>/data/11.0` |
| failOnError | Whether the build should fail if there is an error executing the purge | true |

92 changes: 46 additions & 46 deletions ant/src/site/markdown/config-update.md
View file
Open in desktop

Large diffs are not rendered by default.

268 changes: 134 additions & 134 deletions ant/src/site/markdown/configuration.md
View file
Open in desktop

Large diffs are not rendered by default.

272 changes: 136 additions & 136 deletions cli/src/site/markdown/arguments.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion core/src/main/java/org/owasp/dependencycheck/data/update/NvdApiDataSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ private boolean processApi() throws UpdateException {
final String msg;
if (key != null) {
msg = "Error updating the NVD Data; the NVD returned a 403 or 404 error\n\nPlease ensure your API Key is valid; "
+ "see https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#api-key-is-used-and-a-403-or-404-error-occurs\n\n"
+ "see https://github.com/jeremylong/open-vulnerability-cli/blob/main/README.md#api-key-is-used-and-a-403-or-404-error-occurs\n\n"
+ "If your NVD API Key is valid try increasing the NVD API Delay.\n\n"
+ "If this is occurring in a CI environment";
} else {
Expand Down
310 changes: 155 additions & 155 deletions maven/src/site/markdown/configuration.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/site/markdown/data/cachenvd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Creating an offline cache for the NVD API
=========================================

The Open Vulnerability Project's [vuln CLI](https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data)
The Open Vulnerability Project's [vuln CLI](https://github.com/jeremylong/open-vulnerability-cli/blob/main/README.md#mirroring-the-nvd-cve-data)
can be used to create an offline copy of the data obtained from the NVD API.
272 changes: 136 additions & 136 deletions src/site/markdown/dependency-check-gradle/configuration-aggregate.md
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions src/site/markdown/dependency-check-gradle/configuration-purge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Tasks
====================

Task | Description
---------------------------------------------------------|-----------------------
[dependencyCheckAnalyze](configuration.html) | Runs dependency-check against the project and generates a report.
[dependencyCheckAggregate](configuration-aggregate.html) | Runs dependency-check against a multi-project build and generates a report.
[dependencyCheckUpdate](configuration-update.html) | Updates the local cache of the NVD data from NIST.
dependencyCheckPurge | Deletes the local copy of the NVD. This is used to force a refresh of the data.
| Task | Description |
|----------------------------------------------------------|---------------------------------------------------------------------------------|
| [dependencyCheckAnalyze](configuration.html) | Runs dependency-check against the project and generates a report. |
| [dependencyCheckAggregate](configuration-aggregate.html) | Runs dependency-check against a multi-project build and generates a report. |
| [dependencyCheckUpdate](configuration-update.html) | Updates the local cache of the NVD data from NIST. |
| dependencyCheckPurge | Deletes the local copy of the NVD. This is used to force a refresh of the data. |

Configuration
====================
Expand All @@ -27,9 +27,9 @@ apply plugin: 'org.owasp.dependencycheck'
$ gradle dependencyCheckPurge
```

Property | Description | Default Value
---------------------|------------------------------------|------------------
failOnError | Fails the build if an error occurs during the dependency-check analysis. | true
| Property | Description | Default Value |
|-------------|--------------------------------------------------------------------------|---------------|
| failOnError | Fails the build if an error occurs during the dependency-check analysis. | true |

#### Example
```groovy
Expand All @@ -42,9 +42,9 @@ dependencyCheck {

The following properties can be configured in the dependencyCheckPurge task. However, they are less frequently changed.

Config Group | Property | Description | Default Value
-------------|-------------------|---------------------------------------------------------------------------------------------|------------------
data | directory | Sets the data directory to hold SQL CVEs contents. This should generally not be changed. | &nbsp;
| Config Group | Property | Description | Default Value |
|--------------|-----------|------------------------------------------------------------------------------------------|---------------|
| data | directory | Sets the data directory to hold SQL CVEs contents. This should generally not be changed. | &nbsp; |

#### Example
```groovy
Expand Down
Loading