Get Started - FOSSology

Get Started With FOSSology

As a User

As a user you need to install the software and learn about the functionality. End users should refer to the FOSSology Wiki for more information.

There are three main ways to install FOSSology:

Using Docker

If docker is installed, FOSSology is on docker hub. Also check the Readme 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.

Outdated Project Documentation Archive

As a Developer

As a developer you are most likely also interested in installing the software. Developers should refer to the FOSSology Github Wiki for more information.

There are many ways to contribute to FOSSology. If you are a developer and want to submit code, start by discussing what you want to do on our developer mailing list [email protected]. Submit your patches there or as a pull request. Once we know you a little better and trust your patches, we will give you commit access. You must agree with our licensing choice. All code is under GPL-v2. If you want your copyright to appear in the code, put it in your patch.

Clone the repo from Github and use the included vagrant scripts to start an instance on your server. Alternatively, you can do the make, make install combination, but make sure you have a look at the software projects wiki. For versions up to 2.6. there is the old Redmine-based documentation archive.

Read a short little intro on how to start developing for FOSSology: “You could …”

The Wiki on Github Information for Developers

Enroll to the fossology-devel mailing list

As for contributions, they will be reviewed by a number of persons. If you intend to make contributions, please consider the definition of done in the Github wiki area and the contributing guidelines for this Github repository.

Governance

Test Instance

For trying out FOSSology quickly, a test instance is also available. This instance can be deleted or reinstalled at any time, thus it is not suitable for serving as your productive version. The login data is as follows:

Please keep this place clean and useful – just as you wish to find it!