http://fossology.org/ 2008-05-13T12:44:04-06:00 http://fossology.org/ http://fossology.org/lib/images/favicon.ico text/html 2008-05-13T12:20:28-06:00 Mike Ruscio http://fossology.org/overview_of_the_user_interface?rev=1210702828&do=diff1210702828 Fossology User Interface - Initial Screen The Fossology User Interface (UI) is shown below. When you initially access the Fossology UI - limited functionality is available until you log in to the interface. The functions that are provided to user who are not logged-in are: text/html 2008-05-13T11:13:29-06:00 Neal Krawetz http://fossology.org/how_to_extend_the_user_interface?rev=1210698809&do=diff1210698809 The FOSSology user interface (UI) is a modular design written in PHP. Each module (called “plugins”) defines a single function. Plugins have the option to depend on other plugins, in order to extend or reuse functionality. Plugins may depend on other plugins. If a required plugin is unavailable then the dependent plugin will be unavailable. text/html 2008-05-13T08:24:28-06:00 Neal Krawetz http://fossology.org/developer_documentation?rev=1210688668&do=diff1210688668 This page provides an index of FOSSology project documentation geared towards developers and anyone interested in looking into or extending the code itself. * Scheduler * Repository * Database * Known Security Risks * Agents * How To Create An Agent * How To Extend The User Interface * Symbolic Alignment Matrix White Paper * Mining Freshmeat * Mining Fedora * Project System Administration * Task List * Interesting Ideas, Leads, Articles text/html 2008-05-12T10:24:40-06:00 Neal Krawetz http://fossology.org/interpret_the_license_group_analysis_report?rev=1210609480&do=diff1210609480 License Group Description The license heirarchy permits viewing individual licenses. However, it is common for individual licenses to fit into specific categories. For example, you may not care whether a license the specific license is “NCSA” or “X11”, you may simply regard them as an “MIT-style” license. Similarly, GPL version 1, version 2, and version 3 may just be grouped as “GPL“. text/html 2008-05-09T12:09:43-06:00 Mike Ruscio http://fossology.org/user_documentation?rev=1210356583&do=diff1210356583 This page provides an index of FOSSology project documentation geared towards the end-user. ...old sections - to be removed... * Introduction to FOSSology * Quickstart * Videos * Screenshots * Software Repository Viewer * Uploading a File * Interpret the Job Queue * Interpret the License Analysis Report * Using FOSSology from the Command Line * Troubleshooting * Frequently Asked Questions * Multi-System Setup * Release Notes * 0.6.1 Documentation Archive text/html 2008-05-09T12:08:49-06:00 Mike Ruscio http://fossology.org/videos?rev=1210356529&do=diff1210356529 This page contains links to tutorial videos for FOSSology It’s best to right click and save these on your computer before playing. * The new 0.7.0 user interface - Nice Overview (10 enjoyable minutes) * Windows Media video (26MB) [<http://fossology.org/video/ui0.7.wmv>] * Quicktime video (17MB) [<http://fossology.org/video/ui0.7.mov>] * Ogg video (38MB) [<http://fossology.org/video/ui0.7.ogg>] text/html 2008-05-09T10:50:54-06:00 Mike Ruscio http://fossology.org/how_to_find_analyzed_license_information?rev=1210351854&do=diff1210351854 To make best use of this section you should already be familiar with How to Browse the Data-Base. In general, the Browse area of the user interface operates as follows: * You select an item from the Browse screen. * The selected item (usually highlighted in blue) will display it’s contents. * If you’ve selected a file, the interface tries to display it. * If you’ve selected a folder or directory, the contents of the folder is displayed. text/html 2008-05-09T10:34:20-06:00 Mark Donohoe http://fossology.org/using_fossology_from_the_command_line?rev=1210350860&do=diff1210350860 Most programs that drive the fossology application have a command line interface. All cli programs will print a usage message. Try typing the program name or the program name -h. Not all programs have a reference page as they are meant to be run by the web user interface. Even if the the program does not have a reference page, it may still be run from the cli. This type of usage is usually only needed by developers or advanced users who understand the interactions of all of the underlying prog… text/html 2008-05-09T10:33:13-06:00 Mike Ruscio http://fossology.org/how_to_interpret_the_license_analysis_report?rev=1210350793&do=diff1210350793 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 wo… text/html 2008-05-08T14:56:49-06:00 Mike Ruscio http://fossology.org/how_browse_for_analyzed_license_information?rev=1210280209&do=diff1210280209 To make best use of this section you should already be familiar with How to Browse the Data-Base. In general, the Browse area of the user interface operates as follows: * You select an item from the Browse screen. * The selected item (usually highlighted in blue) will display it’s contents. * If you’ve selected a file, the interface tries to display it. * If you’ve selected a folder or directory, the contents of the folder is displayed. text/html 2008-05-08T14:54:56-06:00 Dan Stangel http://fossology.org/project_team?rev=1210280096&do=diff1210280096 The FOSSology project team. * Task List * Roadmap * Project Team These are the people working on the Task List items and Roadmap. Who’s who on the FOSSology team and what do they tend to do? * Mark Donohoe (rando) - Software development text/html 2008-05-08T12:56:34-06:00 Dan Stangel http://fossology.org/task:re-structure_documentation_for_0.8.0?rev=1210272994&do=diff1210272994 Re-structure docsTask Re-structure and update docs for the 0.8 releaseOwner MikeRTarget 0.8.0 The project documentation on the website are only current to 0.6.1 and do not adequately document the new UI as of 0.7.0, or license groups as of 0.8.0. This will require updating the docs, as well as organizing them a little better for more intuitive reading. text/html 2008-05-08T12:52:27-06:00 Dan Stangel http://fossology.org/task:add_license_groups?rev=1210272747&do=diff1210272747 Add license groupsTaskAdd license groups to analysis reportsOwnerNealkTarget0.8.0 License groups will be logical groupings of various licenses known to FOSSology. The project will provide a default set of license groups that seem to make sense to us, but users can define their own license groups arbitrarily. text/html 2008-05-07T18:19:40-06:00 Mark Donohoe http://fossology.org/foss-scheduler?rev=1210205980&do=diff1210205980 Configuring the Scheduler The scheduler uses a configuration file to specify the number of processes per host and each agent. A configuration file creator script, mkconfig, is available to aid in the creation of this file. For example: %Host localhost 2 1 agent=wget host=localhost | /usr/local/fossology/agents/wget_agent agent=unpack host=localhost | /usr/local/fossology/agents/engine-shell unpack '/usr/local/fossology/agents/ununpack -d /home/repository//ununpack/%{U} -qRCQx' agent=filter_l… text/html 2008-05-07T17:36:19-06:00 Mark Donohoe http://fossology.org/how_to_upload_files_for_analysis?rev=1210203379&do=diff1210203379 To upload to the Fossology data-base you must be logged in. FOSSology has many options for importing and uploading files for analysis. The options vary based on where the data to upload is located. The data may be located: * On your browser system. Use the Upload->Upload File option to select and upload the file. While this can be very convenient (particularly if the file is not readily accessible online), uploading via your web browser can be slow for large files, and files larger than 6… text/html 2008-05-07T17:10:05-06:00 Dan Stangel http://fossology.org/how_to_create_a_new_release?rev=1210201805&do=diff1210201805 Increment Version Number Appropriately First thing’s first... How do you increment version numbers? This mailing list post describes the version number in detail. To summarize: A.B.C where A = Major release number Reason for change: schema and/or agent API _breakage_ B = Minor release number Reasons for change: schema and/or agent APIs are _added_ or _extended_ new agents added security fixes major roll up of bugfixes C = Bugfix release number … text/html 2008-05-07T16:25:14-06:00 Mark Donohoe http://fossology.org/how_to_browse_the_data-base?rev=1210199114&do=diff1210199114 Select the browse menu Using the Browse menu will show all of the folders in the data base. There are two types of folders, Folders and upload folders. Folders can contain other folders or uploads, upload folders only contain uploads. Upload folders can be stored in any folder, but not another upload folder. There can be multiple upload folders in a folder. text/html 2008-05-06T16:49:45-06:00 Dan Stangel http://fossology.org/task_list?rev=1210114185&do=diff1210114185 This page will capture a 3-tiered task list for the FOSSology project. * Task List * Roadmap * Project Team These tasks should map to the Roadmap. These tasks should have assigned owners from the Project Team. Current Tasks This is a list of the project’s current tasks. This is what we’re working on now. text/html 2008-05-06T12:29:11-06:00 Dan Stangel http://fossology.org/task:document_procedure_to_backup_the_fossology_metadata?rev=1210098551&do=diff1210098551 Notes on document procedure to backup the fossology metadata from 2008.05.6 dicussion.. <danger> BTW, do we have an easy way to let users back up their FOSSology database? <danger> or is that documented anywhere? <taggart> danger: no, I raised this issue 6+ months ago text/html 2008-05-06T11:52:58-06:00 Mike Ruscio http://fossology.org/upload_from_the_web_server?rev=1210096378&do=diff1210096378 To upload to the Fossology data-base you must be logged in. To upload a file from the fossology web server using the graphical user interface, select Upload->From Server from the main menu. NOTE: If your site configuration uses separate agent machines, the material to be upload must be mounted on each machine and be accessible to the web user.