Quickstart (2.2.0)

This section is intended to give users a quick way to get started using FOSSology. For additional details, see the references under each topic.
The primary steps in using the FOSSology tool are:

  1. Log into the FOSSology UI
  2. Click on Upload to to choose a method for uploading a file into FOSSology.
  3. Specify an upload method (from File, URL, or Server) and fill in the upload form and click the Upload button.
  4. When the analysis is complete, Browse to the folder and click on your upload to view the results.

The following shows you additional details.

Uploading Files

The steps to upload a file are:

  • If desired, create a folder using Organize >> Folders >> Create
  • Click on Upload to to choose a method for uploading a file(s) for analysis.
  • Specify an upload method, the folder for storing the upload and provide a pathname. * When uploading from your computer, you may only upload a single file. (Note the size restriction.) * Upload from URL allows one or more files or directories to be uploaded. Be very careful when using patterns, wildcards and recursion for multiple uploads. * Upload from Server is probably something you won't use much unless you are a system admin. Upload from Server means that the source file is located on the same server as the FOSSology web server.
  • Click on the upload button to start your upload and analysis.

See upload a file for analysis for more detail on the upload forms and the other menu choices (one-shot) in the Upload pull-down.

What happens after the upload?

When an upload is requested, FOSSology automatically schedules additional "agents" to process and analyze the upload. The first step is to "unpack" the upload into individual files in preparation for analysis. This is necessary because the file you upload can be a tar, gz, iso, bzip, or many other archive type files.

There are 3 primary analysis agents that scan the resulting unpacked files to:

  • Identify copyright/URL/email strings embedded in files
  • Identify open source licenses embedded in files
  • Read the debian and rpm package headers
  • Categorize files by your own criteria (aka buckets)

The scan results are written to the database and reported by the web GUI.

Examine the Analysis

When your analysis is complete, you can use the Browse button to select and navigate the contents of your upload. This is our file browser.

When you click on the upload name, another Browse page will allow you to drill down the unpacked contents of your upload. This page includes a "micro menu" with the following choices:

  • License Browser
  • Bucket Browser
  • Copyright/Email/URL
  • Browse
  • Search
  • View
  • Info

Click on License Browser in the micro menu and you will be presented with another file browser, but this one shows the software licenses detected by FOSSology. For example:

Licenses are identified by pattern matching heuristics (aka license signatures).

Notice all the blue text. All those are hyperlinks. For example, you can click on each of the license names to see in which directories/files they are embedded. Clicking on Show will display a list of files containing the identified license. Clicking on a directory name will drill down into that directory. Clicking on a file will open that file.

Let's look at a copyright report. This is really a user identification report that shows all the copyrights, urls and email addresses that it finds:

You probably noticed right away that in addition to copyrights, the report shows that Jason Gunthorpe is an author. Click on Show and you will see which files he is an author of. This is what I mean about the report being a user identification report and not strictly a copyright report. One other thing to know about the copyright report is that it has a hard time telling where the end of the copyright (user ID) statement is. That's why "author: jason gunthorpe" is listed 6 times instead of once. This copyright (user ID) report is also susceptible to false positives, but we figure that is better than missing data. Not shown in the screen shot are the URL and email lists.

The last major feature of FOSSology is the bucket report.

Buckets let you organize files based on your own criteria. In the above example, one bucket was defined to be "Possibly restrictive licensing terms" and one file fell into that bucket. Buckets, what they are called, how they are defined, and even their color coding is defined by your FOSSology system administrator. Other popular buckets are "Files with source code requirement", "Affero", and "Ship-Hold".

Browse2.2.gif (33.3 kB) Bob Gobeille, 04/26/2013 05:54 pm

BrowseDrillDown.gif (37.3 kB) Bob Gobeille, 04/26/2013 07:32 pm

LicBrowse.gif (73.4 kB) Bob Gobeille, 04/26/2013 07:40 pm

Copyright2.2.gif (75.2 kB) Bob Gobeille, 04/26/2013 08:04 pm

buckets2.2.gif (28.9 kB) Bob Gobeille, 04/26/2013 09:03 pm