http://fossology.org/ 2010-09-06T20:35:29-06:00 http://fossology.org/ http://fossology.org/lib/images/favicon.ico text/html 2008-04-01T11:27:15-06:00 http://fossology.org/0.6.1:agents?rev=1207070835&do=diff The entire FOSSology system is a combination of agents that run in series: * The unpack agent extracts files to analyze. * The filter_license agent creates the bsam cache files. * The license analysis agent runs the bsam algorithm on the cache files. This generates the list of detected licenses. * The filter_clean agent purges the bsam cache files that are no longer needed. * The engine-shell agent is a generic agent that can turn any command-line program into an agent. This is curren… text/html 2008-04-01T11:28:47-06:00 http://fossology.org/0.6.1:database?rev=1207070927&do=diff Creating a new instance of the database The Postgres command, pg_dump, can be used to dump the sql statements required to build the database schema and define users, functions, views, etc. When used with the options below, this will dump only the schema (not any database contents) to file ossdb.sql. text/html 2008-04-01T11:32:50-06:00 http://fossology.org/0.6.1:how_to_create_an_agent?rev=1207071170&do=diff This document covers how to create, configure, and install an agent for use with the scheduler, DB, and UI. Tip: Look at the Engine-Shell code in the SVN tree as an example. Purpose Agents are used to perform analysis, statistics, or management tasks related to anything in the database. Each agent performs one (1) task; do not overload agent functionality. If you need three different tasks, then create three different agents. For example, if your agent needs to unpack a file in order to ana… text/html 2008-04-01T11:34:37-06:00 http://fossology.org/0.6.1:interpret_the_job_queue?rev=1207071277&do=diff How to Access Job Queue Information To access the Fossology Software Repository Viewer Show Jobs screen: * Scroll to the bottom of the directory of folders/files shown in the left area of the Software Repository Viewer window. * Find Show Jobs (currently highlighted) and select it with your mouse. text/html 2008-04-01T11:36:07-06:00 http://fossology.org/0.6.1:interpret_the_license_analysis_report?rev=1207071367&do=diff License Hierarchy Description License analysis is performed by comparing an unknown file (that contains zero or more license sections) with a set of license templates. The comparison algorithm used by the license agent looks for groups of the similar words in a similar ordering. The algorithm does not mind if individual words are placed. For example, “This is the Gnu public license and you can share it” matches “This is the Neal public license and you can share it”. Changing a single word in th… text/html 2008-04-01T11:37:39-06:00 http://fossology.org/0.6.1:introduction_to_fossology?rev=1207071459&do=diff The FOSSology software is Free and Open Source Software representing a system for analyzing and studying FOSS – Free and Open Source Software. FOSSology uses a framework that provides the following capabilities: * Upload file(s) * Unpack and store the data to be analyzed * Invoke specialized “agents” to analyze the data * Populate a database to store and display the results text/html 2008-04-01T11:39:50-06:00 http://fossology.org/0.6.1:known_security_risks?rev=1207071590&do=diff The first release of FOSSology has not been through a thorough security audit and is not recommended for general-purpose wide-spread use. The known security risks are as follows: * Ununpack. The UNiversal Unpacker (ununpack) is used to extract files from archives. This program relies on tools such as “ar” and “unzip” to extract contents. If any of these tools are vulnerable to ”../” traversal or other exploits from hostile files, then the user “fossy” may be compromised. In general, the UI m… text/html 2008-04-01T11:48:52-06:00 http://fossology.org/0.6.1:multi-system_setup?rev=1207072132&do=diff The scheduler and repository are designed so they can be distributed across multiple hosts. There are few reasons for doing this: * I/O Bottlenecks. Some of the agents (e.g., the unpack agent) are I/O intensive. As a result, running two on the same host will likely be much slower than running two in serial (one at a time) on the same host. If you want to run two unpack agents in parallel, you should run them on different systems (or on one mega system that has multiple I/O channels to rel… text/html 2008-04-01T11:50:02-06:00 http://fossology.org/0.6.1:quickstart?rev=1207072202&do=diff This section is intended to give users a quick way to get started using the tool. For additional details, see the full reference for the topic. The primary steps in using the FOSSology tool are: * Upload a file or files * Check the Job Queue for information about the upload * Read the License Analysis Report for information about the file(s) text/html 2008-04-01T11:51:11-06:00 http://fossology.org/0.6.1:repository?rev=1207072271&do=diff The file repository is used to store the actual files loaded into the FOSSology system. While the Database stores meta information about files, the Repository holds the actual files. * Each file is named after a pseudo-unique checksum: sha1.md5.length * sha1. This is the sha1 value of the file's contents. * md5. This is the md5 value of the file's contents. * length. This is size of the file's contents. text/html 2008-04-01T11:52:25-06:00 http://fossology.org/0.6.1:scheduler?rev=1207072345&do=diff This document covers the technical implementation of the scheduler. It is intended for anyone who needs to replace, modify, or debug the scheduler. This document is not intended for people who want to create an agent (although it certainly helps to know this information). text/html 2008-04-01T11:53:51-06:00 http://fossology.org/0.6.1:software_repository_viewer?rev=1207072431&do=diff The primary user interface for FOSSology is the web based Software Repository Viewer that is provided with the default install. This interface provides a generic way to browse the file repository and view the results produced by the included agents text/html 2008-04-01T11:55:36-06:00 http://fossology.org/0.6.1:troubleshooting?rev=1207072536&do=diff Q: The jobs don't seem to be progressing, how do I tell if jobs are being processed? A: Use 'ps' to see what jobs are currently running: ps -u fossy -f . Also use top: top -u fossy . If none of the processes are consuming CPU cycles and jobs are scheduled then the scheduler might be hung. However, if any jobs are running and consuming CPU cycles, then there is probably nothing hung -- some jobs just take a while. (Processing large files, like ISO images, can take hours.) text/html 2008-04-01T11:56:42-06:00 http://fossology.org/0.6.1:uploading_a_file?rev=1207072602&do=diff The following steps describe how to upload a file or files into the FOSSology Software Repository Viewer. Refer to the Interpret the License Analysis Report section for information about how to interpret the information that is provided when you upload a file. text/html 2008-04-01T11:58:00-06:00 http://fossology.org/0.6.1:using_fossology_from_the_command_line?rev=1207072680&do=diff For release 1.0 FOSSology has only 1 command line interface. This interface is used to upload 1 or more archives into the DataBase. After the upload has been scheduled, the UI is used to track when the job(s) will be completed and to view the folders created by the upload. See the man page below for details.