User Documentation

With FOSSology source code can be scanned to find out licenses, copyrights, ECC information and other individual information you are looking for. The different Use Cases and functionalities of the UI are described in this User documentation.

1. User Interface

1.1. Home

FOSSOlogy is a framework for software analysis tools. With it, you can:

• Upload files into the FOSSology repository.
• Unpack files (zip, tar, bz2, iso's, and many others) into its component files.
• Browse upload file trees.
• View file contents and meta data.
• Scan for software licenses.
• Scan for copyrights and other author information.
• View side-by-side license and bucket differences between file trees.
• Tag and attach notes to files.
• Report files based on your own custom classification scheme.

Where to Begin...

The menu at the top contains all the primary capabilities of FOSSology. This menu is explained in the following documentation. Login: Depending on your account's access rights, you may be able to upload files, schedule analysis tasks, or even add new users.

1.2. Search

Searching for files in uploads

1.3. Browse - License Compliance Clearing

Describes the structure of the files and the different scanning options. This is the core of the tool and many different functionalities are available.

1.4. Uploading Packages

uploading packages or files.

1.5. Jobs

• My recent Jobs
• All recent Jobs
• Schedule agents

1.6. Organize

Organize: Describes how to organize

• Folders
• Licenses
• Uploads

1.7. Admin

Administration of

• Agents
• Buckets
• Configuration Variables
• Dashboards
• Fossdash Management
• Groups
• License Admin
• FOSSology Maintenance
• Obligation Admin
• Scheduler
• Tag
• Upload Permissions
• User

1.8. Help

Documentation and Debug information

2. Rest-API

Basic Guide for FOSSology REST API.