github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-01-13 23:33:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

minor update to formating

Browse Source 
Former-commit-id: 6bd182ef660034549b2be16b4a22574171351a8b
This commit is contained in:
Jeremy Long
2014-03-03 07:37:33 -05:00
parent 94a0c98bfe
commit 3a7fd7d271
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
dependency-check-ant/src/site/markdown/configuration.md
View File

@@ -22,19 +22,19 @@ The following table lists the configurable properties:
Property | Description | Requirement | Default Value
----------------------|-------------|-------------|------------
ApplicationName | The name of the application to use in the generated report. | Required |  
ReportFormat | The format of the report to be generated. Allowed values are: HTML, XML, VULN, or ALL. The default value is HTML.| Optional | HTML
ReportOutputDirectory | The directory where dependency-check will store data used for analysis. Defaults to the current working directory. | Optional |  
FailBuildOn | If set and a CVE is found that is greater then the specified value the build will fail. The default value is 11 which means that the build will not fail. Valid values are 0-11. | Optional | 11
AutoUpdate | If set to false the NVD CVE data is not automatically updated. Setting this to false could result in false negatives. However, this may be required in some environments. | Optional | true
DataDirectory | The directory where dependency-check will store data used for analysis. Defaults to a folder called, called 'dependency-check-data', that is in the same directory as the dependency-check-ant jar file was installed in. *It is not recommended to change this.* | Optional |  
LogFile | The file path to write verbose logging information. | Optional |  
SuppressionFile | An XML file conforming to the suppression schema that suppresses findings; this is used to hide [false positives](../suppression.html). | Optional |  
ProxyUrl | Defines the proxy used to connect to the Internet. | Optional |  
ProxyPort | Defines the port for the proxy. | Optional |  
ProxyUsername | Defines the proxy user name. | Optional |  
ProxyPassword | Defines the proxy password. | Optional |  
ConnectionTimeout | The connection timeout used when downloading data files from the Internet. | Optional |  
applicationName | The name of the application to use in the generated report. | Required |  
reportFormat | The format of the report to be generated. Allowed values are: HTML, XML, VULN, or ALL. The default value is HTML.| Optional | HTML
reportOutputDirectory | The directory where dependency-check will store data used for analysis. Defaults to the current working directory. | Optional |  
failBuildOn | If set and a CVE is found that is greater then the specified value the build will fail. The default value is 11 which means that the build will not fail. Valid values are 0-11. | Optional | 11
autoUpdate | If set to false the NVD CVE data is not automatically updated. Setting this to false could result in false negatives. However, this may be required in some environments. | Optional | true
dataDirectory | The directory where dependency-check will store data used for analysis. Defaults to a folder called, called 'dependency-check-data', that is in the same directory as the dependency-check-ant jar file was installed in. *It is not recommended to change this.* | Optional |  
logFile | The file path to write verbose logging information. | Optional |  
suppressionFile | An XML file conforming to the suppression schema that suppresses findings; this is used to hide [false positives](../suppression.html). | Optional |  
proxyUrl | Defines the proxy used to connect to the Internet. | Optional |  
proxyPort | Defines the port for the proxy. | Optional |  
proxyUsername | Defines the proxy user name. | Optional |  
proxyPassword | Defines the proxy password. | Optional |  
connectionTimeout | The connection timeout used when downloading data files from the Internet. | Optional |  
nexusAnalyzerEnabled | The connection timeout used when downloading data files from the Internet. | Optional |  
nexusUrl | The connection timeout used when downloading data files from the Internet. | Optional |  
nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | Optional | true