Skip to content

Commit 8402bb6

Browse files
authored
docs: Update & correct README (#8166)
2 parents 82a20b5 + 282158a commit 8402bb6

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,29 @@ Documentation and links to production binary releases can be found on the [githu
1212

1313
This product uses the NVD API but is not endorsed or certified by the NVD.
1414

15+
## Mandatory Upgrade to 12.1.0+
16+
17+
Due to NVD API compatiiblity changes, an upgrade is mandatory. See [#7463](https://github.com/dependency-check/DependencyCheck/issues/7463) for more information.
1518

1619
## Breaking Changes in 11.0.0
1720

18-
- Java 11 is now required to run dependency-check 11.0.0 or higher
21+
- Java 11 is now required to run dependency-check `11.0.0` or higher
1922
- H2 database upgrade
2023

21-
11.0.0 contains breaking changes using the local H2 database. A full download
24+
`11.0.0` contains breaking changes using the local H2 database. A full download
2225
of the NVD data will occur. Note that if you are using a shared data directory
2326
the h2 database file is not compatible with older versions of dependency-check.
2427
If you run into problems you may need to run a purge:
2528

2629
- gradle: `./gradlew dependencyCheckPurge`
27-
- maven: `mvn org.owasp:dependency-check-maven:9.0.0:purge`
30+
- maven: `mvn org.owasp:dependency-check-maven:11.0.0:purge`
2831
- cli: `dependency-check.sh --purge`
2932

30-
## Mandatory Upgrade Notice
31-
32-
**Upgrading to 10.0.2 or later is mandatory**
33-
34-
Older versions of dependency-check are causing numerous, duplicative requests that
35-
end in processing failures are causing unnecassary load on the NVD API. Dependency-check
36-
10.0.2 uses an updated `User-Agent` header that will allow the NVD to block calls
37-
from the older client.
33+
## Other notices
3834

3935
### NVD API Key Highly Recommended
4036

41-
Dependency-check has moved from using the NVD data-feed to the NVD API.
37+
Dependency-check moved from using the NVD data-feed to the NVD API since `9.0.0+` (January 2024).
4238
Users of dependency-check are **highly** encouraged to obtain an NVD API Key; see https://nvd.nist.gov/developers/request-an-api-key
4339
Without an NVD API Key dependency-check's updates will be **extremely slow**.
4440
Please see the documentation for the cli, maven, gradle, or ant integrations on
@@ -50,9 +46,18 @@ The NVD API has enforced rate limits. If you are using a single API KEY and
5046
multiple builds occur you could hit the rate limit and receive 403 errors. In
5147
a CI environment one must use a caching strategy.
5248

53-
#### Gradle build Environment
49+
### OSSIndex API Token Now Required for usage
50+
51+
In September 2025 Sonatype OSSIndex started enforcing use of API tokens. If you
52+
wish to use Sonatype OSSIndex you must configure Dependency-Check
53+
to use a username and API token/password; see https://ossindex.sonatype.org/doc/api-token.
54+
Without OSSIndex credentials, Dependency Check will **automatically disable the OSSIndex analyzer**.
55+
Please see the documentation for the cli, maven, gradle, or ant integrations on
56+
how to set the OSSIndex credentials.
57+
58+
### Gradle build Environment
5459

55-
With 9.0.0 users may encounter issues with `NoSuchMethodError` exceptions due to
60+
With `9.0.0+` users may encounter issues with `NoSuchMethodError` exceptions due to
5661
dependency resolution. If you encounter this issue you will need to pin some of
5762
the transitive dependencies of dependency-check to specific versions. For example:
5863

0 commit comments

Comments
 (0)