FOSSology Wiki

open source license compliance

User Tools

Site Tools


handson

Hands-On Training Support Page

About the Training

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 user interface provide you with a compliance workflow. License, copyright and export scanners are tools used in the workflow.

Analyzing open source license compliance requires expert knowledge. As a consequence the use of the tool requires understanding of license analysis problems and how they are covered by FOSSology. This training will therefore provide the following elements:

  • Challenges in real world examples at license analysis of open source components
  • Learning how to cope with license proliferation and custom license texts
  • Efficiently managing large open source components with heterogeneous licensing
  • Saving work with reusing license conclusions of open source packages when analyzing a newer version
  • Getting an overview about an example workflow for component analysis with FOSSology

The hands-on session allows and encourages for performing the presented functionality at the same time. Attendees use their computers to directly perform presented tasks on their own FOSSology application. As an open source project, anyone can easily install FOSSology using a pre-built docker image from docker hub or vagrant / virtualbox on most platforms.

This course will be valuable to anyone concerned with and involved in Open Source Management, including operational and legal executives, software development managers, open source program managers and developers. It requires basic understanding of software licensing. If not, it is recommended to have performed the training Compliance Training for Developers (LFC191) available here.

Organisation

Roughly, the training is comprised of the following elements:

  1. Motivation, What is the need today
  2. Introduction, What FOSSology is designed for
  3. Features, Walk trough most important features
  4. Installation Workshop, We try to get FOSSology running on your machine
  5. Hands On, Why not tying it out here

Supplemental Material

For the hands on training a few files a required, open source packages to show particular examples. The selection of the packages is just because their license situation serves as an example. the packages provided here are provided for easy access and for covering volatility of hyperlinks.

FOSSology Installation

Test Installation at AWS

There is a test installation at Amazon AWS for conveniently accessing the FOSSology. Important: not all elements of the hands-on exercises can be performed, as the configured users do not have admin rights, of course:

http://52.25.49.79/repo/

Note that this instance is for hands-on trainings only, A public instance is at http://52.26.97.143/repo/ (testuser/user).

Short Cut

A short cut in the sense of not really installing FOSSology is a ready made exported virtual machine. Steps:

  1. Download VitualBox (which can import .ova files) and install.
  2. Download our ready made FOSSology Virtual Machine (old versions here: FOSSology VM Aug 2016, FOSSology VM Oct 2016).
  3. Import this VM to VirtualBox: Menu 'File', then select 'Import Appliance'. Then select the *.ova file and import. Checking settings especially for assigned cores and main memory used might be useful. For simple tests, FOSSology runs with 1 core and 1GB of main memory.
  4. Start the newly imported virtual machine.
  5. Go to
http://localhost:8081/repo/

Normal Installation

As for the installation, there are three main ways to install FOSSology:

  • Using Docker: if docker is installed, FOSSology is on docker hub. Also, please check the readme file of the project for more details.
  • Using Vagrant and VirtualBox: just checkout or download the project and execute a classic vagrant up.
  • Install from source: The installation from source is straight forward as described on our GitHub developer pages.

Note 1: After having installed FOSSology, use the default username and password for logging in: 'fossy' and 'fossy'.

Note 2: In all cases, consider that FOSSology is a server application and requires as such, a person proficient with server administration of Linux applications for productive use. Not adapting the installation might lead to performance issues, since the out-of-the-box parameters for the database and Web server cannot cover smaller notebook computers and larger server installations at the same time.

Using Docker

There is a docker pre-built image for FOSSology on DockerHub, the general way to call this is:

docker run -p 8081:80 fossology/fossology

This presumes that docker is installed and up and running. There are the following sources for installing docker in particular:

Note 1: For accessing a docker container, docker creates a local network on your computer. The IP address is printed in the terminal output usually when starting docker. As such, this IP address must be used (instead of localhost). Moreover, the installation registers FOSSology under a path at the web server: repo/. This triaing path must be added to the URL. Running docker on a mac the resulting FOSSology URL looks like:

http://192.168.99.100:8081/repo/

Note: the actual IP address can be different on your docker setup!

Using Vagrant

The Fossology project repository contains also a vagrant file defining a virtual machine and installing fossology on this. The following steps:

  1. Install a hypervisor that works with vagrant, for example VirtualBox. The installation is done using an installaer on win and mac. For Linux you may consider package download instructions on this page.
  2. Install the provisioning framework Vagrant from vagrantup.com. They provide installers for win and mac and packages for debian and centos.
  3. Clone the FOSSology repository on github.com. Alternatively just could simply donwload the latest version as ZIP archive. Another alternative would be to download the version you prefer to have started up with vagrant
  4. Change into the project root folder and execute: vagrant up.

If everything went fine, the URL of the FOSSology server should be:

http://localhost:8081/repo/

Note: Depending on you network connection it will take some time to download the ubuntu OS image on which the FOSSology will be installed. If you are a vagrant user already, you might consider to use your won ubuntu-14.04 based box (any give other OSes a try) to install FOSSology on.

Install From Source

Installing from source is mainly for development. However, since the build and deploy of FOSSology is automated, it can be also considered for quick testing.

  • There is an explanation found on the Github developer wiki.
  • If you are familiar with the old source code install: Basically, the installation has not changed substantially, as such, also the older pages explaining the source code install are still valid.
  • If you would like to go deeper into the configuration of your installation, consider the system administrator documentation. A shell script exists (see readme here), adjusting most the important things for a server-oriented installation,.

Cannot Attend the Training?

In this unfortunate case, consider the documentation of the basic workflow in FOSSology.

Survey

handson.txt · Last modified: 2017/02/04 12:40 by michaelj