Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • build.gradle

  • build.gradle.kts

  • cargo.toml

  • dependencies.scala

  • pom.xml

  • setup.py

  • requirements.txt

  • Gemfile.lock

  • package.json

  • package-lock.json

  • bower.json

  • go.mod

  • Gopkg.lock

  • Godeps.lock

  • vendor.conf

  • gogradle.lock

  • glide.lock

  • composer.json

  • build.sbt

  • packages.config

  • packrat.lock

  • paket.dependencies

  • Pipfile

  • Podfile

  • pyproject.toml

  • poetry.lock

  • pubspec.yaml

  • environment.yml

  • yarn.lock

  • Any metafile with one of the following extensions: 

    • asp

    • aspx

    • config

    • csproj

    • do

    • htm

    • html

    • jsp

    • shtml

    • tf

    • xhtml

...

Environment Variables

Description

Controller

Scanner

Remediate

prop.json property

Notes

Supported from version

WS_ACTIVATION_KEY

Your generated activation key in the WhiteSource application

V

V

V

bolt.op.activation.key

The property should still exist in the prop.json file, its value is disregarded.

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

WS_HOST_RULES_PRIVATE_KEY

The PGP private key generated for the Private Regestry support

Example of usage for the GitHub Enterprise

XV

V

V

X

Cannot be used at the same time with WS_HOST_RULES_PRIVATE_KEY_FILE_PATH

21.9.1

WS_HOST_RULES_PRIVATE_KEY_FILE_PATH

The PGP private key generated for the Private Regestry support

Example of usage for the GitHub Enterprise

XV

V

V

X

This file should be mapped to the running containers.

Cannot be used at the same time with WS_HOST_RULES_PRIVATE_KEY

21.9.1

WS_GIT_CONNECTOR

Enable cloning project files through Git shell commands.

To enable, set value to true

Default: false 

X

V

X

X

By default, the Scanner uses JGit library for any Git-related operations.

21.9.1

LOG_FORMAT

If set to json then Remediate will be configured to output JSON log messages.

X

X

V

X

...