Page Comparison

Activation Key Parsing

Verifies the activation key is valid. 

If this check returns FAILED, the controller will shut down.

WhiteSource API Connectivity

Checks the connectivity with the WhiteSource application server.
Skipped if the Activation Key Parsing check returns a FAILED status.

If this check returns FAILED, the controller will shut down.

Activation Key Validation

Validates the content of the parsed activation key.
Skipped if the Activation Key Parsing or WhiteSource API Connectivity checks return a FAILED status.

If this check returns FAILED, the controller will shut down.

WhiteSource Credentials

Checks that the WhiteSource service user (generated as part of the integration) has regular and admin access to the integrated WhiteSource organization.
Skipped if the Activation Key Parsing or WhiteSource API Connectivity checks return a FAILED status.

Queue Implementation

Checks the WhiteSource application server queue implementation (ability to send and receive messages).
Skipped if the Activation Key Parsing or WhiteSource API Connectivity checks return a FAILED status.

SCM API Connectivity

Checks the connectivity with the SCM (Bitbucket, GitHub, or GitLab) API.
Skipped if the Activation Key Validation check returns a FAILED status.

Controller to Remediate Connectivity

Checks the connectivity from the wss-app container to the Remediate container.

Remediate to Controller Connectivity

Checks the connectivity from the Remediate container to the wss-app container.

GitHub App Permissions

Checks that the GitHub App has all the required minimal permissions and event subscriptions in place.

Only relevant for WhiteSource for GitHub Enterprise.

WS_ACTIVATION_KEY

Your generated activation key in the WhiteSource application

V

V

V

bolt.op.activation.key

21.7.2

WS_CONFIG_ACCOUNT_NAME

The account name that will hold the global whitesouce-config repository.

Default: “whitesource-config”

V

X

X

X

21.6.3

WS_CONFIG_REPO_NAME

The repository name of the global configuration repository.

Default: “whitesource-config”

V

X

X

X

21.6.3

WS_HTTPS_CERT_FILE_PATH

If using a certificate file - path to the certificate file

V

X

X

X

21.6.3

WS_HTTPS_KEY_FILE_PATH

If using a certificate file - path to the private key file

V

X

X

X

21.6.3

WS_KEYSTORE_FILE_PATH

If using a Java keystore - path to the keystore file.

V

X

X

X

21.6.3

WS_KEYSTORE_PASSWORD

If using a Java keystore - password for the keystore file

V

X

X

X

21.6.3

WS_CREATE_ISSUES

The ability to globally enable/disable Issues creation across all of your organization's repositories.

Default: true 

V

X

V

bolt4scm.create.issues

21.7.1

WS_CREATE_CHECK_RUNS

The ability to globally enable/disable build statuses across all of your organization's repositories. 

Default: true 

V

X

X

bolt4scm.create.check.runs

It is strongly recommended not to set this value to false, since the diff functionality relies on the check run, and this is one of the important means to update on the status of a scan. With this feature disabled there is no way of knowing what's going on if a scan failed, succeeded, found vulnerabilities, etc.

21.6.3

WS_REMEDIATE_WEBHOOK_URL

The destination of the Remediate network endpoint to intercept webhooks.

Default: http://remediate-server:8080/webhook

V

X

X

webhook.remediate.url

Must include the “/webhook” suffix

21.6.3

WS_UA_LOG_IN_CONSOLE

If set to true the UA logs will also be printed to the stdout, like the scanner logs.

X

V

X

X

The UA logs can be very long.

21.7.2

WS_LOG_DIRECTORY 

Configure the path to both the scanner and the UA log files. Using this property will also append a partial request token to the log filenames.

X

V

X

X

21.7.2

WS_REMEDIATE_SERVER_ONLY

Indicates whether a Remediate container is marked as server. The Remediate server enques jobs for the Remediate workers.

X

X

V

X

There can be only 1 Remediate server

21.7.1

WS_REMEDIATE_SERVER_URL

The url of the Remediate server. This indicates that the Remediate container is a worker and pulls jobs from the Remediate server.

X

X

V

X

Ignored if WS_REMEDIATE_SERVER_ONLY is specified.

21.7.1

WS_PROP_JSON_FILE_PATH

Path to the prop.json file

X

X

V

X

21.7.1

WS_CONTROLLER_DESTINATION_URL

The url of the Controller network endpoint

X

X

V

V

21.7.1