updated documentation

This commit is contained in:
Jeremy Long
2015-11-30 06:52:48 -05:00
parent a426de69cd
commit 44c6a6b4e8
114 changed files with 31 additions and 6498 deletions

View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2015-11-28
| Generated by Apache Maven Doxia at 2015-11-30
| Rendered using Apache Maven Fluido Skin 1.4
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20151128" />
<meta name="Date-Revision-yyyymmdd" content="20151130" />
<meta http-equiv="Content-Language" content="en" />
<title>dependency-check &#x2013; Usage</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.4.min.css" />
@@ -29,7 +29,7 @@
<a href="https://github.com/jeremylong/DependencyCheck">
<a href="https://github.com/jeremylong/dependency-check-gradle">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
alt="Fork me on GitHub">
@@ -42,7 +42,7 @@
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<img src="../images/dc.svg" alt="OWASP dependency-check"/>
<img src="../images/dc-gradle.svg" alt="OWASP dependency-check"/>
</div>
</div>
<div class="pull-right"> </div>
@@ -62,9 +62,9 @@
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-11-28</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-11-30</li>
<li id="projectVersion" class="pull-right">
Version: 1.3.2
Version: 1.3.2.1
</li>
</ul>
@@ -298,6 +298,7 @@
<p>It is important to understand that the first time this task is executed it may take 5-20 minutes as it downloads and processes the data from the National Vulnerability Database (NVD) hosted by NIST: <a class="externalLink" href="https://nvd.nist.gov">https://nvd.nist.gov</a></p>
<p>After the first batch download, as long as the plugin is executed at least once every seven days the update will only take a few seconds.</p>
<div class="section">
<h2><a name="Quick_Start"></a>Quick Start</h2>
<div class="section">
<h3><a name="Step_1_Apply_dependency-check-gradle_plugin"></a>Step 1, Apply dependency-check-gradle plugin</h3>
<p>Install from Maven central repo</p>
@@ -308,11 +309,11 @@
mavenCentral()
}
dependencies {
classpath 'org.owasp:dependency-check-gradle:1.3.2'
classpath 'org.owasp:dependency-check-gradle:1.3.2.1'
}
}
apply plugin: 'dependencyCheck'
apply plugin: 'org.owasp.dependencycheck'
</pre></div></div></div>
<div class="section">
<h3><a name="Step_2_Run_the_dependencyCheck_task"></a>Step 2, Run the dependencyCheck task</h3>
@@ -321,7 +322,10 @@ apply plugin: 'dependencyCheck'
<div class="source">
<div class="source"><pre class="prettyprint linenums">gradle dependencyCheck --info
</pre></div></div>
<p>The reports will be generated automatically under <tt>buildDir/reports</tt> folder.</p></div></div>
<p>The reports will be generated automatically under <tt>build/reports</tt> folder.</p></div></div>
<div class="section">
<h2><a name="Task_Configuration"></a>Task Configuration</h2>
<p>The OWASP dependency-check-gradle plugin contains three tasks: <a href="configuration.html">dependencyCheck</a>, <a href="configuration-update.html">dependencyCheckUpdate</a>, and <a href="configuration-purge.html">dependencyCheckPurge</a>. Please see each tasks configuration page for more information.</p></div>
<div class="section">
<h2><a name="Mailing_List"></a>Mailing List</h2>
<p>Subscribe: <a class="externalLink" href="mailto:dependency-check+subscribe@googlegroups.com">dependency-check+subscribe@googlegroups.com</a></p>