From ad4149a259d9a89538130a65624f13dc489181b8 Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Sun, 10 Jul 2016 06:27:40 -0400 Subject: [PATCH] updated documentation for PR #528 --- .../data/{database.md => database.md.vm} | 52 +++++++++++++++++-- 1 file changed, 48 insertions(+), 4 deletions(-) rename src/site/markdown/data/{database.md => database.md.vm} (60%) diff --git a/src/site/markdown/data/database.md b/src/site/markdown/data/database.md.vm similarity index 60% rename from src/site/markdown/data/database.md rename to src/site/markdown/data/database.md.vm index b41b7fb61..b5a6b514d 100644 --- a/src/site/markdown/data/database.md +++ b/src/site/markdown/data/database.md.vm @@ -7,8 +7,8 @@ file is configured using the data directory configuration option (see [CLI](https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html)). Some organizations may want to use a more robust centralized database. Currently, [H2 in -server mode](http://www.h2database.com/html/tutorial.html#using_server) and -[MySQL](https://www.mysql.com/) have been tested. In general, the setup is done by creating +server mode](http://www.h2database.com/html/tutorial.html#using_server), MySQL, MariaDB, PostgreSQL, +Oracle, and MS SQL Server have been tested. In general, the setup is done by creating a central database, setting up a single instance of dependency-check, which can connect to the Internet, that is run in update-only mode once a day. Then the other dependency-check clients can connect, using a read-only connection, to perform the analysis. Please note that if the @@ -18,7 +18,7 @@ see the note about Central [here](./index.html). To setup a centralized database the following generalized steps can be used:
  1. Create the database and tables using either initialize.sql - or initialize_mysql.sql.
  2. + or one of the other initialization scripts found here.
  3. The account that the clients will connect using must have select granted on the tables.
    • Note, if the clients performing the scans should run with the noupdate setting. A single instance of the dependency-check client should be setup with update enabled and the account @@ -32,11 +32,55 @@ To setup a centralized database the following generalized steps can be used:
Depending on the database being used, you may need to customize the [dbStatements.properties](https://github.com/jeremylong/DependencyCheck/blob/master/dependency-check-core/src/main/resources/data/dbStatements.properties). -Alternatively to modifying the dbStatements.properties it is now possible to use a dialect file to support other databases. +Alternatively to modifying the dbStatements.properties it is possible to use a dialect file to support other databases. See [dbStatements_h2.properties](https://github.com/jeremylong/DependencyCheck/blob/master/dependency-check-core/src/main/resources/data/dbStatements_h2.properties) as an example. Also, if using an external database you will need to manually upgrade the schema. See [database upgrades](./upgrade.html) for more information. +Examples +-------- +The following example shows how to use the Maven plugin with MariaDB: + +```xml + + 4.0.0 + dummy + dummy + 1.0-SNAPSHOT + + + + org.owasp + dependency-check-maven + ${project.version} + + + org.mariadb.jdbc + mariadb-java-client + 1.4.6 + + + + org.mariadb.jdbc.Driver + jdbc:mariadb://my.cvedb.host/cvedb + depscan + NotReallyMyDbPassword + + + + + update-only + + + + + + + +``` + +Support +------- As always, feel free to open an [issue](https://github.com/jeremylong/DependencyCheck/issues) or post a question to the [dependency-check google group](https://groups.google.com/forum/#!forum/dependency-check).