TeamCity Torrent plugin

With this plugin, users and build agents can download TeamCity build artifacts faster, especially in a distributed environment.

1. Downloading binaries

The latest build of the plugin is available on / can be downloaded from the public TeamCity server:

for TeamCity 2017.2.x

2. Building sources

First clone the repository with submodule:

git clone --recurse-submodules https://github.com/JetBrains/teamcity-torrent-plugin.git

if you already clone the repository without submodule you can fix it so:

git submodule update --init

Then you should add closed-api dependency to the project. Create lib folder in root project directory and place there common-impl.jar file from /webapps/ROOT/WEB-INF/lib

finally run the following command in project directory:

`mvn package`

(optionally you can add -DskipTests for skipping tests)

After successfully build bittorrent-plugin.zip will be placed in /target directory

3. Installing

Install the plugin as described in the TeamCity documentation.

4. Setting up the plugin

Once you restart the server, a new link, Torrent Settings, will appear in the Administration area. The plugin is disabled by default. You can enable it on this page. If the plugin works correctly and you checked both options for the server and agents on the Torrent settings page, then, once a large enough artifact is published, you should see the torrent icon near the name of the artifact. Clicking this icon should download the .torrent file, which you can open using your favorite torrent client.

More information is available in the related TeamCity blogpost.

5. Tech notes

For the plugin to work correctly, TCP ports in the 6881-6889 interval should be open on the TeamCity server and agents.
Torrent files are created only for large artifact (by default more then 10mb), which means small files cannot be downloaded via BitTorrent.
The plugin supports the following build configuration parameters allowing you to control the plugin behavior at the project or build configuration level:
- teamcity.torrent.peer.download.enabled (true by default): this parameter controls the usage of the BitTorrent protocol for artifacts downloading on agents
- teamcity.torrent.peer.seeding.enabled (true by default): this parameter controls seeding of artifacts from agents via the BitTorrent protocol
- teamcity.torrent.seeder.minFileSize (10M by default): this parameter controls artifacts size threshold; smaller artifacts won't be downloaded via the BitTorrent protocol