SW360 Documentation

Overview

SW360 is a software catalogue application that has been developed to facilitate the sharing of information related to software components used by an organization. Its primary objective is to manage software license information with the support of workflows. The application employs license scanners FOSSology, which is integrated to analyze the source code for licenses, copyrights, and other relevant information.

SW360 has been designed to seamlessly integrate with existing software artifact and project management infrastructures. It provides separate backend services for distinct tasks and a set of portlets to access these services. To ensure a smooth and hassle-free deployment, a complete deployment unit is available, which includes a Vagrant box or Docker container that contains a complete configuration of all services and portlets.

SW360 comprises the following main use case areas:

  • Project: Handling of project information with all contained Open Source SW components and other Third Party SW Components and Snippets.
  • Component/Releases: Handling of information and processes related to components, e.g. name, vendor, version, ECCN information, license compliance information
  • License: Handling of information regarding licenses, e.g. license texts, copyrights, acknowledgements, obligations etc.
  • Vulnerability: Collecting Security Vulnerability Management Information and matching them with components stored in the component service
  • License Compliance documentation: all relevant documents (e.g. Readme, source code bundle) can be created, supported by workflows.

Functionality

The SW360 is a software catalogue application with which you can:

  • Manage your components and projects
  • Send source packages to the clearing tool Fossology
  • Reuse cleared components and releases for your project
  • Import cleared components with clearing reports and other documents
  • Browse licenses and their obligations

SW360 is

  • Based on the Open Source Liferay portal server
  • Integrated with Fossology

In order to work with SW360, please note a fundamental setup in the data model when dealing with components:

  • A component is a list of releases with metadata.
  • A Release is a version of a component with metadata and specific attachments.
  • A project refers to a number of releases of components accordingly, not components.
  • A vendor is separate from a component and releases. The link to the vendor is set at the release. (think of Sun and Oracle where the owner changed with a new release)

Getting started

NameURLRemarks
Main home pagehttps://www.eclipse.org/sw360/main home page with general info
Project @ Githubhttps://github.com/eclipse/sw360where the music plays
Developer mailing listsw360-dev@eclipse.orgfor developers, discussion about developing
Slack Channelhttps://sw360chat.slack.com/the main chat spot, everybody is welcome
Slack Channel Invitation LinkSharable join link to jointhat should bring you in
sw360 developer meetingMeeting InfoEveryone is welcome!

User Guides

This guide provides an overview of SW360 and how to get started with using it. It covers the basic usage, and tips for configuring SW360 to work with your software development tools.

Administration Guides

SW360 Administration Guides

Deployment

SW360 Deployment Guides

Development

SW360 Development Information

Last modified March 29, 2023: upd(project): Major updates (3fc96db)