FOSSology Wiki

open source license compliance

User Tools

Site Tools


start

Fossology Documentation

Advancing open source license compliance

FOSSology is an open source license compliance software system and toolkit. As a toolkit you can run license, copyright and export control scans from the command line. As a system, a database and web ui are provided to give you a compliance workflow. In one click you can generate an SPDX file, or a ReadMe with the copyrights notices from your software. FOSSology deduplication means that you can scan an entire distro, submit a new version, and only the changed files will get rescanned. This is a big time saver for large projects.

Please note: FOSSology does not give legal advice.

Introduction

Please see the Contact Us page to subscribe to our mailing lists and/or join our irc channel. If you register you can also use the Forum on fossology.org.

Our source repository, developer documentation and issue tracker are on https://github.com/fossology/fossology

Want to try out FOSSology? Try our demo server: http://52.26.97.143/repo/ (user: testuser, password: test, this is a user w/o admin rights)

The latest release can be found here: https://github.com/fossology/fossology/releases

An archive of old packages for downloads are available from http://www.fossology.org/releases/. You can also find a source tarball there.

Features

What FOSSology is capable of today? Some things FOSSology cannot do, as there is the popular misconception that it currently offers source code scan for plagiarism (Considering its agent-based framework approach, it is prepared well for that, however, currently not supported). However, there are plenty of things that FOSSology is capable of (license review, license text handling, browsing files, searches, buckets, copyrights, user management, multi-tenancy ops with isolated groups) - the overview for features can be found here: Features.

User Documentation

A basic user documentation is on the projects home page. Please find here more detailed topcis documentation (work in progress):

* Frequently Asked Questions: Collected from user questions in e-mails and the mailing lists

* Supplemental page for the Hands-On training

Admin Documentation

FOSSology runs as a server application. As such, some topics require further documentation: (to be completed)

Developer Documentation

The main documentation place for developers can be found here: https://github.com/fossology/fossology/wiki

The following lists pages from earlier versions of FOSSology:

(to be completed)

Testing

The testing of FOSSology has two main areas:

  • Build/in software tests that can be executed during development and are also executed by the CI, such as travis or by a jenkins instance. See the Testing Overview for more details.
  • An system testing documentation that is checked for every new release of FOSSology

Project Internals

Information about the infrastructure: Infrastructure.

start.txt · Last modified: 2016/09/09 10:12 by michaelj