From 68e959d4aec570e99dece038a81ea2b9a98093dd Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Mon, 4 Dec 2023 06:42:08 -0500 Subject: [PATCH] docs: add documentation on caching --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 08e4bed9fb6..f43de7e9828 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,13 @@ Without an NVD API Key dependency-check's updates will be **extremely slow**. Please see the documentation for the cli, maven, gradle, or ant integrations on how to set the NVD API key. +#### The NVD API Key, CI, and Rate Limiting + +The NVD API has enforced rate limits. If you are using a single API KEY and +multiple builds occur you could hit the rate limit and receive 403 errors. In +a CI environment one must use a caching strategy. + + ### Breaking Changes 9.0.0 contains breaking changes which requires updates to the database. If using