| Table of Contents | ||
|---|---|---|
|
...
A valid license for WhiteSource for Developers
A license key for WhiteSource Advise for IDE, available via one of the following options:
If you do not have direct access to the WhiteSource Application, obtain the license key from your WhiteSource Administrator.
If you have access to the WhiteSource Application, do as follows (NOTE: This option is only available when using version 20.11.1 or later of WhiteSource Advise):
Go to the WhiteSource Application.
Open the Profile page.
In the WhiteSource Advise - IDE Integration section at the bottom, select your organization.
Copy your personal license key to be used later in Activating WhiteSource Advise.
Java JDK 1.8 and up (see here for instructions) or OpenJDK 1.8 and up is installed
Either or both of the following:
Apache Maven Application is installed and the Maven path and all environment variables are set up (see here for instructions)
Gradle is installed
Eclipse is installed and you are familiar with its basic functionality.
When declaring a gradle.properties file, ensure it is declared in the project's top-level folder.
Supported Versions
The plugin supports Eclipse 2018-09 and above. The last tested version is 2020-12.
...
To install WhiteSource Advise, do as follows:
NOTE: If you previously installed the WhiteSource Advise plugin using the dropin folder, you must delete the org.whitesource.eclipse.plugin jar file from the dropin folder before performing this procedure.
Start Eclipse, specifying the preferred workspace.
From the menu bar, select Help > Eclipse Marketplace. The Eclipse Marketplace screen is displayed.
In the Search tab, in the Search box, enter whitesource and press Enter from your keyboard. The WhiteSource Advise plugin information is displayed.
Click Install.
Read and accept the license agreement's terms, and click Finish.
In the pop-up message, click Restart Now.
Activating WhiteSource Advise
...
Start Eclipse, specifying the preferred workspace.
From the menu bar, select WhiteSource > WhiteSource Advise Login. The Welcome to WhiteSource Advise dialog box is displayed.
In email, enter your organizational email (the email domain must be licensed to use Advise).
In License Key, enter your license key (See here for more information on how to obtain a license key).
Click Login.
...
Once you have activated WhiteSource Advise, it automatically scans Maven/Gradle projects for open source security vulnerabilities whenever such projects are opened or built. The scan results are displayed in the Markers tab and a dedicated WhiteSource tab.
If you do not want WhiteSource Advise to automatically scan your Maven/Gradle projects, you can disable this functionality. Do as follows:
...
From the Project Explorer pane, right-click a project and select Properties. The Properties dialog box is displayed.
...
In the Properties dialog box's Builders pane, clear WhiteSource Builder.
...
Manually Scanning Projects
...
Start Eclipse, specifying the preferred workspace.
From the menu bar, select Help > Eclipse Marketplace. The Eclipse Marketplace screen is displayed.
Click the Installed tab.
Scroll for the WhiteSource Advise plugin.
Click Update.
Read and accept the license agreement's terms, and click Finish.
In the popup message, click Restart Now.
Uninstalling WhiteSource Advise
...