Skip to content

docs: document configuration of Gradle connection timeouts #8490

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

Draft
chadlwilson wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

docs: document configuration of Gradle connection timeouts #8490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3040345
docs: Document connection timeout config for Gradle
chadlwilson May 7, 2026
ebd0577
docs: improve consistency of Gradle documentation for a couple of values
chadlwilson May 7, 2026
afbd2bb
docs: Document connection timeouts consistently with one another
chadlwilson May 7, 2026
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
4 changes: 2 additions & 2 deletions ant/src/site/markdown/config-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ The following properties can be set on the dependency-check-update task.
| proxyUsername | Defines the proxy user name. |   |
| proxyPassword | Defines the proxy password. |   |
| nonProxyHosts | Defines the hosts that will not be proxied. |   |
| connectionTimeout | The URL Connection Timeout (in milliseconds). | 10000 |
| readtimeout | The URL Read Timeout (in milliseconds). | 60000 |
| connectionTimeout | Sets the connection timeout (in milliseconds) used when downloading external data. | 10000 |
| readTimeout | Sets the read timeout (in milliseconds) used when downloading external data. | 60000 |
| retireJsAnalyzerEnabled | Sets whether the RetireJS Analyzer update and analyzer are enabled. | true |

Advanced Configuration
Expand Down
4 changes: 2 additions & 2 deletions ant/src/site/markdown/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ The following properties can be set on the dependency-check task.
| proxyUsername | Defines the proxy user name. |   |
| proxyPassword | Defines the proxy password. |   |
| nonProxyHosts | Defines the hosts that will not be proxied. |   |
| connectionTimeout | The URL Connection Timeout (in milliseconds). | 10000 |
| readtimeout | The URL Read Timeout (in milliseconds). | 60000 |
| connectionTimeout | Sets the connection timeout (in milliseconds) used when downloading external data. | 10000 |
| readTimeout | Sets the read timeout (in milliseconds) used when downloading external data. | 60000 |
| enableExperimental | Enable the [experimental analyzers](../analyzers/index.html). If not enabled the experimental analyzers (see below) will not be loaded or used. | false |
| enableRetired | Enable the [retired analyzers](../analyzers/index.html). If not enabled the retired analyzers (see below) will not be loaded or used. | false |
| suppressionFile | The file path to the XML suppression file \- used to suppress [false positives](../general/suppression.html). The parameter value can be a local file path, a URL to a suppression file, or even a reference to a file on the class path (see https://github.com/dependency-check/DependencyCheck/issues/1878#issuecomment-487533799) |   |
Expand Down
4 changes: 2 additions & 2 deletions maven/src/site/markdown/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,8 @@ Note that any passwords in the below configuration could be exposed if you use `
| suppressionFileUser | If you don't want register user/password in settings.xml, you can specify Basic username. |   |
| suppressionFilePassword | If you don't want register user/password in settings.xml, you can specify Basic password, but be aware that if you use -X the secret will be written to the standard out. |   |
| suppressionFileBearerToken | If you don't want register token as password in settings.xml, you can specify Bearer token, but be aware that if you use -X the secret will be written to the standard out. |   |
| connectionTimeout | Sets the URL Connection Timeout (in milliseconds) used when downloading external data. | 10000 |
| readTimeout | Sets the URL Read Timeout (in milliseconds) used when downloading external data. | 60000 |
| connectionTimeout | Sets the connection timeout (in milliseconds) used when downloading external data. | 10000 |
| readTimeout | Sets the read timeout (in milliseconds) used when downloading external data. | 60000 |
| dataDirectory | Sets the data directory to hold SQL CVEs contents. This should generally not be changed. | ~/.m2/repository/org/owasp/dependency-check-data/ |
| databaseDriverName | The database driver full classname; note, only needs to be set if the driver is not JDBC4 compliant or the JAR is outside of the class path. |   |
| databaseDriverPath | The path to the database driver JAR file; only needs to be set if the driver is not in the class path. |   |
Expand Down
4 changes: 3 additions & 1 deletion src/site/markdown/dependency-check-gradle/configuration-aggregate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ The following properties can be configured in the dependencyCheck task. However,
|   | suppressionFileUser | Credentials used for basic authentication for web-hosted suppression files |   |
|   | suppressionFilePassword | Credentials used for basic authentication for web-hosted suppression files |   |
|   | suppressionFileBearerToken | Credentials used for bearer authentication for web-hosted suppression files |   |
|   | connectionTimeout | Sets the connection timeout used when downloading external data. | 10000 |
|   | readTimeout | Sets the read timeout used when downloading external data. | 60000 |
| nvd | apiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   |
| nvd | endpoint | The NVD API endpoint URL; setting this is uncommon. | https://services.nvd.nist.gov/rest/json/cves/2.0 |
| nvd | maxRetryCount | The maximum number of retry requests for a single call to the NVD API. | 10 |
Expand All @@ -97,7 +99,7 @@ The following properties can be configured in the dependencyCheck task. However,
| hostedSuppressions | password | Credentials used for basic authentication for the hosted suppressions file. |   |
| hostedSuppressions | bearerToken | Credentials used for bearer authentication for the hosted suppressions file. |   |
| hostedSuppressions | validForHours | The number of hours to wait before checking for new updates of the hosted suppressions file . | 2 |
| cache | ossIndex | Sets whether the OSS Index Analyzer will cache results. Cached results expire after 24 hours. | true |
| cache | ossIndex | Sets whether the OSS Index Analyzer will cache results. See `analyzers.ossIndex.validForHours` for configuration. | true |
| cache | central | Sets whether the Central Analyzer will cache results. Cached results expire after 30 days. | true |
| cache | nodeAudit | Sets whether the Node Audit Analyzer should cache results locally. Cached results expire after 24 hours. | true |

Expand Down
6 changes: 4 additions & 2 deletions src/site/markdown/dependency-check-gradle/configuration-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ The following properties can be configured in the dependencyCheck task. However,

| Config Group | Property | Description | Default Value |
|--------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
|   | connectionTimeout | Sets the connection timeout used when downloading external data. | 10000 |
|   | readTimeout | Sets the read timeout used when downloading external data. | |
| nvd | apiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   |
| nvd | endpoint | The NVD API endpoint URL; setting this is uncommon. | https://services.nvd.nist.gov/rest/json/cves/2.0 |
| nvd | maxRetryCount | The maximum number of retry requests for a single call to the NVD API. | 10 |
Expand All @@ -64,11 +66,11 @@ The following properties can be configured in the dependencyCheck task. However,
| data | password | The password used when connecting to the database. |   |
| hostedSuppressions | enabled | Whether the hosted suppressions file will be used. | true |
| hostedSuppressions | forceupdate | Sets whether hosted suppressions file will update regardless of the `autoupdate` setting. | false |
| hostedSuppressions | url | The URL to (a mirror of) the hosted suppressions file. | https://dependency-check.github.io/DependencyCheck/suppressions/publishedSuppressions.xml |
| hostedSuppressions | url | The URL to a mirrored copy of the hosted suppressions file for internet-constrained environments. | https://dependency-check.github.io/DependencyCheck/suppressions/publishedSuppressions.xml |
| hostedSuppressions | user | Credentials used for basic authentication for the hosted suppressions file. |   |
| hostedSuppressions | password | Credentials used for basic authentication for the hosted suppressions file. |   |
| hostedSuppressions | bearerToken | Credentials used for bearer authentication for the hosted suppressions file. |   |
| hostedSuppressions | validForHours | The number of hours to wait before checking for new updates of the hosted suppressions file . | 2 |
| hostedSuppressions | validForHours | The number of hours to wait before checking for new updates of the hosted suppressions file. | 2 |

#### Example

Expand Down
Loading
Loading