Skip to end of metadata
Go to start of metadata

Please read the general information about External Update Agents before any Teamcity specific documentation.

General information 

The plugin integrates automatic open source management with Jetbrains TeamCity

Once set up, all usage of open source software in the organization will be continuously and automatically in sync with White Source.

  • New projects will be created
  • Existing projects will be updated
  • Policies will be enforced on every action, failing the build if necessary.

The plugin currently support projects built using maven, ant, and shell scripts.


The plugin is licensed under the Apache 2.0 license. Source code and issues are hosted on github .

How it works

On execution, the plugin will determine which open source is currently used by your project and send it to White Source.

No source code is scanned. Only descriptive information is sent over the wire.

Normal flow

White Source uses the collected information to create new projects or update existing ones.

Policy check flow

The plugin will check each new library against the organizational policies. If any library should be automatically rejected by some policy the build will fail. Otherwise your account will be updated.

An informative report of the results will be generated regardless of the outcome.

Installing the plugin

Download the plugin 

Copy the packaged file into Teamcity's plugin folder located at $TEAMCITY_USER_HOME/.BuildServer/plugins

Restart the server

More information about installing plugins in Teamcity could be found here.

Using the plugin


Start by configuring the global settings, this settings will be applied to every project in your TeamCity. Then setup which jobs should interact with White Source.

Global Settings

Once the plugin is installed go to Administration -> Server Configuration -> White Source.

Organization token

A unique identifier of the organization. You can get yours in the Admin Integration API page.

Policy check

Check that the introduced open source libraries conform with organization policies.

Check only new libraries - Check that the newly introduced open source libraries conform with organization policies.

Force check all libraries - Check that all introduced open source libraries conform with organization policies. 

Disable - Disable policies check when updating WhiteSource.

Force update

Updates organization inventory regardless of policy violations.

Fail on error

Indicates whether to fail the build on a general error (e.g. network error).

Proxy server

Optional. If your TeamCity is behind a firewall you should configure it here in order to allow communication with the White Source servers.

Job specific settings

You should enable the plugin for each job you want to use to update White Source.


Only supported runner types will have this options visible.


Maven runner

Generic configuration

Build runners that have no concise system for managing dependencies require a different configuration.

What we're looking for is descriptive information about each library used. What we need to know is which libraries to include and where we can find them, that is the sole purpose of the configuration.

Build log

The plugin is executed when the runner finish. Sample log section:


Screen casts

Install the plugin and import data into White Source.

Apply policy check before updating White Source.

Change log

Version 1.1.7

  • Add 'fail on error' functionality - fails the build even in case of inventory force update, or other general errors.

Version 1.1.6

  • Add force update functionality.

Version 1.1.5

  • Add support for force check all dependencies (old and new) according to the organization policies

  • Bug Fix - use global settings in maven runner.

Version 1.1.4

  • Add connection timeout parameter.
    Connection timeout is measured in minutes. Default value is 60 minutes.

Version 1.1.3

  • Automatic proxy detection + minor bug fixes.

Version 1.1.2

  • Product identification in agent api
  • Improved proxy configuration
  • Option to change service url

Version 1.1.1

Minor changes:

  • Communication with White Source servers is now encrypted using SSL by default.
  • Several bug fixes in policy check report
  • Code refactor

Version 1.1.0

First release of the plugin.

  • None