...
Table of Contents |
---|
Overview
Info |
---|
Proxy settings are relevant for requests for WhiteSource servers only. Proxy for remote repository requests is not supported. |
This topic describes how the JFrog Artifactory plugin integrates with WhiteSource. The plugin adds additional information to the Artifactory artifacts and updates WhiteSource. Once invoked, all the artifacts' metadata on the Artifactory will be uploaded to the WhiteSource inventory.
...
Download the zip file and extract it.
Replace the
whitesource-artifactory-plugin.properties
andwhitesource-artifactory-plugin.groovy
files under${ARTIFACTORY_HOME}/var/etc/artifactory/plugins
Create a new
lib
folder under${ARTIFACTORY_HOME}/var/etc/artifactory/plugins
.Place the new
whitesource-artifactory-plugin-VERSION.jar
file in theplugins/lib
directory.Update the
whitesource-artifactory-plugin.properties
file with the appropriate parameters (see Cron Scheduling Example and General Parameters).Schedule the cron job in the
whitesource-artifactory-plugin.groovy
file (see Cron Scheduling Example).Restart Artifactory.
...
Attribute | Type | Description | Required | Additional Information | ||
---|---|---|---|---|---|---|
wssUrl | String | URL for sending the request. Use the ‘WhiteSource Server URL' which can be retrieved from your Profile page on the 'Server URLs' panel. Then, add the '/agent’ path to it. For example: "https://saas.whitesourcesoftware.com/agent". | No. | |||
apiKey | String | Unique identifier of the organization. This can be retrieved from the Integration page in your WhiteSource account. | Yes | |||
userKey | String | Unique identifier of the user. This can be generated from the Profile page in your WhiteSource account. | Yes | Supported since version 18.5.1 | ||
productName | String | Represents the Artifactory instance and product in WhiteSource. Comment this field to map the repository to the product in WhiteSource (project will also represent the repository). | No | |||
checkPolicies | Boolean | Whether or not to send the check policies request to WhiteSource. | No | |||
forceCheckAllDependencies | Boolean | Used only if
| No | Supported since version 1.0.3 | ||
updateWss | Boolean | Whether or not to send an update to WhiteSource. | Yes | Supported since version 1.0.6 | ||
forceUpdate | Boolean | Whether or not to update the organization inventory regardless of policy violations. | No. The default value is false. | Supported since version 1.0.3 | ||
repoKeys | Array | The list of the repositories to scan. | Yes | |||
useProxy | boolean | Whether or not to use proxy settings. | Yes | |||
proxyHost | String | Proxy host URL. | No | |||
proxyPort | Integer | Proxy port. | No | |||
proxyUser | String | Proxy user name if it exists. | No | |||
proxyPass | String | Proxy password if it exists. | No | |||
archiveIncludes | String | Comma separated list specifying the types of files that will be extracted. | No. | Supported since version 1.0.3 | ||
archiveExtractionDepth | String | Drill down hierarchy level in archive files. | No, the default value is 2. | Supported since version 19.4.2 | ||
includesRepositoryContent | String | Comma separated list specifying which files to include in the scan once the archive is extracted according to the parameters in:
| No | Required since version 1.0.3 | ||
triggerBeforeDownload | Boolean | Whether or not to trigger the downloading of WhiteSource policy-approved artifacts from local repositories. | No, the default value is true. | Supported since version 18.10.3 | ||
triggerBeforeRemoteDownload | Boolean | Whether or not to trigger the downloading of WhiteSource policy-approved artifacts from remote repositories. | No, the default value is true. | Supported since version 21.12.1 | ||
triggerAfterCreate | Boolean | Whether or not to trigger the When a new artifact is uploaded to Artifactory, WhiteSource policies are triggered and additional data is added to the property tab of the artifact. | No, the default value is true. | Supported since version 18.10.3 |
Info |
---|
The extraction depth of the Artifactory Plugin for archived files is currently set to the first level. The Unified Agent has an extraction depth of up to seven levels. |
Cron Scheduling Example
This example demonstrates how to configure a schedule for scanning the Artifactory repositories.
...