As a User
As a user you need to install the software and learn about the functionality:
- Installation: 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.
- For getting started, please have a look at the basic workflow (on the left) in order to exercise a basic usage pattern of FOSSology.
- Questions: Contact us.
- Reporting Issues: Submit and track issues on GitHub.
- Additional Project Documentation: Additional details on downloads, installation, automation and testing, licenses, and documentation for developers, users and administrators.
As a Developer
As a developer you are most likely also interested in installing the software.
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 firstname.lastname@example.org. 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.
So, you could
- 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 read the documentation.
- Enroll to the fossology-devel mailing list.
- Read a short litlle intro on how to start developing for FOSSology: "You could ..."
- Information for Developers: The wiki on GitHub.
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.
- The contributing guidelines for this Github repository.
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:
- Server URL: http://126.96.36.199/repo/
- Login user name: testuser
- Login password: test
Please keep this place clean and useful - just as you wish to find it!