Home

Welcome to the sw360portal wiki!

Documentation

1. For development, please see the README.md file of the project first.
2. Check the pages on the right widget of pages. Not every page there has a link on this page!
3. See the sections below

Using sw360

For using the sw360 as a user, please see the following basic workflows:

1. Basic workflows for creating a component, release and projects.
2. Workflow how FOSSology and sw360 play together.
3. Find information about the role and access model
4. If you are interested in the concept about moderation requests, read the documentation here.

Deployment: how to install and setup sw360

In order to install sw360, you can choose between two ways:

• Use the Vagrant-based installation. Please refer to the sw360 vagrant project and the included Readme file. Basic prerequisites are
• VirtualBox
• Vagrant
• Presumeably a git client
• You could install the sw360portal project natively on the machine. This will require more work in order to install the prerequisites. The above mentioned vagrant project documents very precisely what to do in order to install the sw360portal.

Portal deployment: next steps

Once the vagrant deployment is ready, a couple of additional steps need to be applied:

1. [Setup liferay / sw360](Deploy Liferay)
2. [Setup of connection with Fossology](Deploy FOSSology)
3. Setup Secure Deployment
4. [More information on how to user sw360vagrant on Windows](Deploy sw360 on Windows (with Vagrant))

Portal deployment: adminstration issues

After installing sw360portal more topics may include:

1. [How to export data and import it to a new instance](Deploy Export and Import)
2. [How to migrate an existing sw360portal to a new instance](Deploy Migrating to a new Server)
3. [Using costco to modify the couchdb database](Dev Database Migration using Costco)

Developing for sw360portal

The sw360portal is Java-based application consisting of two main parts:

1. A Liferay/based front end application that allows users to work with sw360
2. A Java-based servlet offering Thrift interfaces that allows the Liferay part and other applications to manage and store data
3. In the backend, couchdb is used for storing project, component, release and license information as well as attachments.

Basic topics

As basic introduction, the dev ops works as following:

1. We are issue-based, please do not hesitate to create issues - also for questions (and set the issue tag)
2. The issues are organised by milestones which represent releases. Milestone are meant to be useful packages of work done
3. We use the waffle board in order to organize our work
4. Contributions are made through pull requests
5. We do conversations directly on issues and pull requests

How to get into the sw360 development:

1. How to write a new portlet
2. Adding a new backend service
3. [Changing the data model](Dev Adding Fields to New Classes)
4. [Infrastructure overview](Dev Infrastructure Overview)

Developer Operations

1. [Definiton of done and code style](Dev DoD and Style)
2. [Creating a sw360 release](Dev Releasing SW360)
3. [Brief notes on the jgiven testing](Dev Testing Frameworks)
4. [For help with problems, you might want to check that](Dev Troubleshooting)

Particular topics and technical notes

1. [Filtering in portlets](Dev Filtering in Portlets)
2. [The FOSSology integration](Dev Fossology Integration)
3. [How moderation requests work](Dev Moderation Requests)
4. [Roles and access rights](Dev Role Authorisation Model)
5. [Attachment Types Description](Dev Attachment File Types)