Plugin Setup Guide

To install the SPDX Eclipse Plugin to your existing Eclipse instance, you must be running one of the following Distros:

Distro/Version
Debian 6.0 "Squeeze"/7.0 'Wheezy"
Ubuntu 12.04/12.10/13.04/13.10/14.04
Fedora 18/19/20
RHEL6.x/CentOS

Install Prerequisite Software	Install SPDX Eclipse Plugin	Upgrade SPDX Eclipse Plugin

Install Prerequisite Software

To simplify the configuration process, please install or ensure the following applications/services have been installed on your in the local machine by stepping through the listed command(s) or bulleted instructions:

#### Java Development Kit (JDK) -- Version 1.8 The JDK provides a full featured environment for developing and deploying java code using a Java Standard Edition (JavaSE) platform, which includes a Java run-time environment (JRE). To install the JDK follow the instructions below: > Download the Java Platform (JDK) 8u40 `.tar.gz` archive binary from the [Java SE Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html?ssSourceSiteId=ocomen) webpage onto your local machine.

Then change directory to the location where you would like the JDK to be installed and move the .tar.gz archive binary to that current directory.

Once placed in the desired location, run the following command to unpack the tarball and install the JDK:

tar zxvf jdk-8u40-linux-x64.tar.gz
For more information on the JavaSE version 8, visit the Java Platform Standard Edition 8 Documentation webpages.
After installing, remember to remove the original .tar.gz file to save on disk space.

Apache Web Server

To utilize FOSSology through it's web UI you will need to have a web server application installed and listening on localhost, port 80. See the Apache download webpage for further installation information.

sudo apt-get install apache2

Postgresql Database

The SPDX Eclipse Plugin (and FOSSology in general) utilizes a relational database for accessing, storing and updating scanned licensing information. See the Postgresql install guides for further information.

sudo apt-get install postgresql

MySQL

DoSOCS utilizes a MySQL relational database for caching recently scanned SPDX documents. This functionality significantly improves the efficiency and performance of scanning numerous and/or large files. To install and configure an instance of MySQL, execute the following set of commands:

sudo apt-get install mysql-sever-5.6
- During the install, you should be prompted to set the password for root and it's highly recommended that you take this chance to do so. After the install is finished, verify you can log in to the MySQL database by running the next command
mysql -u root -p
- This will prompt you for root's password and should log you in successfully. Log out with \q and run the next command to ensure the MySQLdb module is installed
sudo apt-get install python-mysqldb

Perl Text::Template

FOSSology uses perl's text template capabilities to consistently format documents used for licensing information processing and output. Install perl's text template by following the commands below:

sudo perl -MCPAN -e shell
cpan[1]> install Text::Template
- To exit the CPAN shell type 'q' or 'quit' and press enter

A Text Editor

A text editor will be needed to modify configuration files during the installation process. Using other text editors besides vim is permitted as this should not affect the FOSSology+SPDX Eclipse Plugin install.

sudo apt-get install vim

Git

To ensure that you will be able to properly install the DoSOCS application, please run the following command to install git:

sudo apt-get install git

Python v2.7

To install python2.7 run the following command:

sudo apt-get install python2.7

FOSSology

To install a local instance of FOSSology application, locate and click on the 'Install/Upgrade' link corresponding to the 'Distro/Version' running on your machine at the FOSSology 2.6 installation webpage, and follow the directions listed.

For additional information on FOSSology installation and configuration visit the FOSSology Wiki.

DoSOCS

Download and install the DoSOCS Application by performing the steps outlined in the Installation section of the README.md file, located within the DoSOCS Github repository.

Install SPDX Eclipse Plugin

To install the SPDX Eclipse Plugin, please perform the following steps:

Step #1

Navigate to the Plugin Versions page and select the a folder that corresponds to the version of the SPDX Eclipse Plugin you would like to install.

Step #1

Step #2

Click on the .jar file located in the directory you selected. Such as the file org.spdx.spdxeclipse_1.0.0.0.jar located in the screenshot below.

Step #2

Step #3

Click on the View Raw link located in the center of the screen as outlined in the screenshot below. Clicking this link will download the .jar file to your designated downloads folder location for your internet browser.

Step #3

Step #4

Find the location of the /Plugins folder for your Eclipse instance. This location varies per machine.

Step #5

Once you've located the /Plugins folder directory, run the following command via command line on that folder:

chmod 744 { Enter directory to /Plugins folder }

Step #6

Copy the downloaded .jar file to the /Plugins folder via command line using the following command:

sudo cp { Enter directory to .jar file } { Enter directory to /Plugins folder }

Step #7

Shutdown and restart or just restart your Eclipse instance. Once Eclipse has been restarted, the SPDX has been successfully installed and you may utilize the functionality it offers.