diff --git a/ant/src/site/markdown/config-update.md b/ant/src/site/markdown/config-update.md index a60bc0efc77..6bc83c61d4b 100644 --- a/ant/src/site/markdown/config-update.md +++ b/ant/src/site/markdown/config-update.md @@ -17,16 +17,16 @@ Configuration: dependency-check-update Task -------------------- The following properties can be set on the dependency-check-update task. -Property | Description | Default Value -----------------------|-------------------------------------------------------------------------|------------------ -proxyServer | The Proxy Server. |   -proxyPort | The Proxy Port. |   -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 -failOnError | Whether the build should fail if there is an error executing the update | true +Property | Description | Default Value +----------------------|-----------------------------------------------------------------------------------------------|------------------ +proxyServer | The Proxy Server; see the [proxy configuration](../data/proxy.html) page for more information.|   +proxyPort | The Proxy Port. |   +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 +failOnError | Whether the build should fail if there is an error executing the update | true Advanced Configuration ==================== diff --git a/src/site/markdown/data/proxy.md b/src/site/markdown/data/proxy.md index 098e0e492f5..6e437ae103f 100644 --- a/src/site/markdown/data/proxy.md +++ b/src/site/markdown/data/proxy.md @@ -1,16 +1,37 @@ -Proxy Configuration -=================== -All of the dependency-check clients (CLI, Maven, Gradle, Ant, Jenkins) can be configured -to use a proxy to connect to the Internet. See the configuration settings for each: +# Proxy Configuration + +With dependency-check 9.x the proxy configuration is unfortunately in transition +and, if required, will likely need to be **configured twice**. + +## Java Properties + +The go-forward proxy configuration is done using standard Java proxy configuration +settings which can be set using an environment variable `JAVA_TOOL_OPTIONS`. +See https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html for +more information. The properties that can be configured are: + +- https.proxyHost +- https.proxyPort +- https.proxyUser +- https.proxyPassword +- http.nonProxyHosts + +As example configuration would be: + +```bash +export JAVA_TOOL_OPTIONS="-Dhttps.proxyHost=my-proxy.internal -Dhttps.proxyPort=8083" +``` + +## Legacy configuration + +Legacy proxy configuration can be configured in any of the dependency-check integrations +(CLI, Maven, Gradle, Ant, Jenkins). See the configuration settings for each: * [Maven Plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html) * [Gradle Plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-gradle/configuration.html) * [Ant Task](https://jeremylong.github.io/DependencyCheck/dependency-check-ant/configuration.html) * [Command Line](https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html) -Note, it may also be possible to use the core [Java proxy](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) -system properties instead of the configuration above. - Certificate Errors ------------------ In some cases if you setup a proxy the connection may still fail due to certificate