How to Run Your First OSS Discovery Scan

To run your first scan with OSS Discovery, follow these steps:

Download and install Ruby 1.8.5 or 1.8.6 from www.ruby-lang.org. Windows users will be warned that they need administrative priviledges. This is so that Ruby can be added to the path and accessed from any DOS window.
Unzip or untar OSS Discovery into your desired [install directory].
In a command line or shell, navigate to the [install directory]\discovery2-client directory and run the following command:
discovery.bat --path [path to directory to be scanned] (if you are running on Windows)
./discovery --path [path to directory to be scanned] (if you are on Linux or other UNIX platform such as Solaris)
Windows users will need to enclose paths that contain spaces in quotation marks ("").
Human readable results get printed to the screen and sent to a text file called readable_scanresults.txt located in the [install directory]\discovery2-client directory.
Machine readable results get written to the scan_results.txt file located in the [install directory]\discovery2-client directory.

Although you currently need to download and install Ruby prior to running OSS Discovery, in an upcoming release we will deliver this as a combined package.

Understanding Your Scan Results

Machine readable results will include the same information, but in a format a server can use. The human readable results will print to the screen and will include information such as directories walked, number of files encountered and duration of the scan.

Linux Example

The human readable results of a scan of the directory for the test content of Ant.

~/Documents/discovery2-client/main> ./discovery --path /home/test/resources/content-cg/ant
Reading project rules....
Scanning /home/test/resources/content-cg/ant
directories walked    : 33
files encountered     : 16
symlinks found        : 0
symlinks not followed : 0
bad symlinks found    : 0
permission denied     : 0
files of interest     : 16
start time            : Wed Dec  5 16:56:10 2007
end time              : Wed Dec  5 16:56:14 2007
scan time             : 00:00:04 (hh:mm:ss)
distro                : SUSE Linux: SUSE Linux Enterprise Desktop 10 (x86_64)
kernel                : 2.6.16.21-0.8-smp #1
machine id            : db1051de0d2dfe0c9bd8e200c8d1dfe6
packages found        : 16
Package Name Version Location
============ ======= ========
ant 1.1     /home/test/resources/content-cg/ant/jakarta-ant-1.1/lib
ant 1.2     /home/test/resources/content-cg/ant/jakarta-ant-1.2/lib
ant 1.3     /home/test/resources/content-cg/ant/jakarta-ant-1.3/lib
ant 1.4     /home/test/resources/content-cg/ant/jakarta-ant-1.4/lib
ant 1.5     /home/test/resources/content-cg/ant/jakarta-ant-1.5/lib
ant 1.5.1   /home/test/resources/content-cg/ant/jakarta-ant-1.5.1/lib
ant 1.5.2   /home/test/resources/content-cg/ant/apache-ant-1.5.2/lib
ant 1.5.3-1 /home/test/resources/content-cg/ant/apache-ant-1.5.3-1/lib
ant 1.5.4   /home/test/resources/content-cg/ant/apache-ant-1.5.4/lib
ant 1.6.0   /home/test/resources/content-cg/ant/apache-ant-1.6.0/lib
ant 1.6.1   /home/test/resources/content-cg/ant/apache-ant-1.6.1/lib
ant 1.6.2   /home/test/resources/content-cg/ant/apache-ant-1.6.2/lib
ant 1.6.3   /home/test/resources/content-cg/ant/apache-ant-1.6.3/lib
ant 1.6.4   /home/test/resources/content-cg/ant/apache-ant-1.6.4/lib
ant 1.6.5   /home/test/resources/content-cg/ant/apache-ant-1.6.5/lib
ant 1.7.0   /home/test/resources/content-cg/ant/apache-ant-1.7.0/lib
Scan complete

Windows Example

The human readable results of a scan of the directory for the test content of Ant.

C:\discovery2-client\main\> discovery.bat --path \test\resources\content-cg\ant
Reading project rules....
Scanning C:/test/resources/content-cg/ant/
directories walked    : 33
files encountered     : 16
symlinks found        : 0
symlinks not followed : 0
bad symlinks found    : 0
permission denied     : 0
files of interest     : 16
start time            : Thu Dec 06 09:58:20 2007
end time              : Thu Dec 06 09:58:31 2007
scan time             : 00:00:11 (hh:mm:ss)
distro                : Windows: Windows XP Professional
kernel                : i386-mswin32
machine id            : a984b0bc33b13b05333cc0c02c27adec
packages found        : 16
Package Name Version Location
============ ======= ========
ant 1.1     C:/test/resources/content-cg/ant/jakarta-ant-1.1/lib
ant 1.2     C:/test/resources/content-cg/ant/jakarta-ant-1.2/lib
ant 1.3     C:/test/resources/content-cg/ant/jakarta-ant-1.3/lib
ant 1.4     C:/test/resources/content-cg/ant/jakarta-ant-1.4/lib
ant 1.5     C:/test/resources/content-cg/ant/jakarta-ant-1.5/lib
ant 1.5.1   C:/test/resources/content-cg/ant/jakarta-ant-1.5.1/lib
ant 1.5.2   C:/test/resources/content-cg/ant/apache-ant-1.5.2/lib
ant 1.5.3-1 C:/test/resources/content-cg/ant/apache-ant-1.5.3-1/lib
ant 1.5.4   C:/test/resources/content-cg/ant/apache-ant-1.5.4/lib
ant 1.6.0   C:/test/resources/content-cg/ant/apache-ant-1.6.0/lib
ant 1.6.1   C:/test/resources/content-cg/ant/apache-ant-1.6.1/lib
ant 1.6.2   C:/test/resources/content-cg/ant/apache-ant-1.6.2/lib
ant 1.6.3   C:/test/resources/content-cg/ant/apache-ant-1.6.3/lib
ant 1.6.4   C:/test/resources/content-cg/ant/apache-ant-1.6.4/lib
ant 1.6.5   C:/test/resources/content-cg/ant/apache-ant-1.6.5/lib
ant 1.7.0   C:/test/resources/content-cg/ant/apache-ant-1.7.0/lib
Scan complete