Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More
Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More
Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More
Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

Downloads:

496,605

Downloads of v 5.0.3:

64,378

Last Update:

13 Nov 2020

Package Maintainer(s):

Software Author(s):

  • JetBrains

Tags:

TeamCity Build Agent

  • 1
  • 2
  • 3

5.0.3 | Updated: 13 Nov 2020

Downloads:

496,605

Downloads of v 5.0.3:

64,378

Maintainer(s):

Software Author(s):

  • JetBrains

Tags:

teamcity build agent ci continuous integration admin

TeamCity Build Agent 5.0.3

Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by JetBrains. The inclusion of JetBrains trademark(s), if any, upon this webpage is solely to identify JetBrains goods or services and not for commercial purposes.

  • 1
  • 2
  • 3

This Package Contains an Exempted Check

Not All Tests Have Passed

Hide Checks
Hide Checks

Validation Testing Passed

Verification Testing Exemption:

Requires Team City Server

Details

Scan Testing Successful:

No detections found in any package files

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install TeamCity Build Agent, run the following command from the command line or from PowerShell:

>

To upgrade TeamCity Build Agent, run the following command from the command line or from PowerShell:

>

To uninstall TeamCity Build Agent, run the following command from the command line or from PowerShell:

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)

2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade teamcityagent -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade teamcityagent -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode


- name: Install teamcityagent
  win_chocolatey:
    name: teamcityagent
    version: '5.0.3'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'teamcityagent' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '5.0.3'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller teamcityagent
{
    Name     = "teamcityagent"
    Version  = "5.0.3"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'teamcityagent':
  ensure   => '5.0.3',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.

4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved as a trusted package on 13 Nov 2020.

Description

TeamCity Build Agent for jetbrains.com/teamcity. It is a piece of software which listens for the commands from the TeamCity server and starts the actual build processes. Install requires at least serverUrl parameter, e.g. -params 'serverurl=http://...', also supported are agentName, agentDir, ownPort and possibly others. If looking to see what changes in the agent config files during the run use -v argument to choco.exe.

tools\chocolateybeforemodify.ps1 

$ErrorActionPreference = 'Stop' # stop on all errors

$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
# Don't use ConvertFrom-StringData as it corrupts Windows paths like C:\buildAgent
function Get-PropsDictFromJavaPropsFile ($configFile) {
    # Returns configProps ordered dict
    $config = Get-Content $configFile
    Write-Verbose "$config"
    $configProps = [ordered]@{}
    $config | %{if (`
                            (!($_.StartsWith('#')))`
                                -and (!($_.StartsWith(';')))`
                                -and (!($_.StartsWith(";")))`
                                -and (!($_.StartsWith('`')))`
                                -and (($_.Contains('=')))){
                                    $props = @()
                                    $props = $_.split('=',2)
                                    Write-Verbose "Props are $props"
                                    $configProps.add($props[0],$props[1])
                            }
                    }
    return $configProps
}
$installParametersFile = "$toolsDir/install-parameters.txt"
$installParameters = Get-PropsDictFromJavaPropsFile $installParametersFile
$installParameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$agentDir = $installParameters["agentDir"]
$agentName = $installParameters["agentName"]
$agentDrive = split-path $agentDir -qualifier

$workingDirectory = Join-Path $agentDir "bin"
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.stop.bat -Wait"
Sleep 2
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.uninstall.bat -Wait"
tools\chocolateyInstall.ps1 

$ErrorActionPreference = 'Stop'; # stop on all errors

if ($env:chocolateyPackageParameters -eq $null) {
	throw "No parameters have been passed into Chocolatey install, e.g. -params 'serverUrl=http://... agentName=... agentDir=... serviceAccount=... serviceAccountPassword=...'"
}

$parameters = ConvertFrom-StringData -StringData $env:chocolateyPackageParameters.Replace(" ", "`n")

## Validate parameters
if ($parameters["serverUrl"] -eq $null) {
    throw "Please specify the TeamCity server URL by passing it as a parameter to Chocolatey install, e.g. -params 'serverUrl=http://...'"
}

if ($parameters["agentDir"] -eq $null) {
    $parameters["agentDir"] = "$env:SystemDrive\buildAgent"
    Write-Host No agent directory is specified. Defaulting to $parameters["agentDir"]
}

if ($parameters["agentWorkDir"] -eq $null) {
    $agentDir = $parameters["agentDir"];
    $parameters["agentWorkDir"] = "$agentDir\work"
    Write-Host No agent work directory is specified. Defaulting to $parameters["agentWorkDir"]
}

if ($parameters["agentTempDir"] -eq $null) {
    $agentDir = $parameters["agentDir"];
    $parameters["agentTempDir"] = "$agentDir\temp"
    Write-Host No agent temp directory is specified. Defaulting to $parameters["agentTempDir"]
}

if ($parameters["agentSystemDir"] -eq $null) {
    $agentDir = $parameters["agentDir"];
    $parameters["agentSystemDir"] = "$agentDir\system"
    Write-Host No agent system directory is specified. Defaulting to $parameters["agentSystemDir"]
}

if ($parameters["agentName"] -eq $null) {
    $defaultName = $true
    $parameters["agentName"] = "$env:COMPUTERNAME"
    Write-Host No agent name is specified. Defaulting to $parameters["agentName"]
}

if ($parameters["ownPort"] -eq $null) {
    $parameters["ownPort"] = "9090"
    Write-Host No agent port is specified. Defaulting to $parameters["ownPort"]
}

if ($parameters["serviceAccount"] -eq $null) {
    $defaultServiceAccount = $true
    Write-Host No service account provided, will run as system account.
}

$agentZipArchiveName = "buildAgent.zip"
if ($parameters["downloadFullAgent"] -eq $true) {
    $agentZipArchiveName = "buildAgentFull.zip"
    Write-Host Will download full agent ZIP archive with plugins.
}

$packageName = "TeamCityAgent"
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

## Make local variables of it
$serverUrl = $parameters["serverUrl"];
$agentDir = $parameters["agentDir"];
$agentWorkDir = $parameters["agentWorkDir"].Replace("\","\\");
$agentTempDir = $parameters["agentTempDir"].Replace("\","\\");
$agentSystemDir = $parameters["agentSystemDir"].Replace("\","\\");
$agentName = $parameters["agentName"];
$ownPort = $parameters["ownPort"];
$serviceAccount = $parameters["serviceAccount"];
$serviceAccountPassword = $parameters["serviceAccountPassword"];
$agentDrive = split-path $agentDir -qualifier
$buildAgentDistFile = "$agentDir\conf\buildAgent.dist.properties"
$buildAgentPropFile = "$agentDir\conf\buildAgent.properties"

if($serviceAccount -ne $null)
{
    if($serviceAccount -notlike "*\*")
    {
        Write-Verbose "Service account has no '\' assuming local user"
        $serviceAccount = ".\$serviceAccount"
    }
}

# Write out the install parameters to a file for reference during upgrade/uninstall
# This doesn't currently preserve anything during an upgrade, it just helps locate the service control batch files
$parameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$parameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Out-File "$toolsDir/install-parameters.txt" -Encoding ascii

$currentConfig = $null
if((Test-Path -Path $buildAgentPropFile) -eq $true)
{
    Write-Verbose "Loading previous install settings"
    $currentConfig = Get-Content -Path $buildAgentPropFile
}

$packageArgs = @{
  packageName   = "$packageName"
  unzipLocation = "$agentDir"
  url           = "$serverUrl/update/$agentZipArchiveName"
}
Install-ChocolateyZipPackage @packageArgs

# Generic function to read Java properties file into ordered dict
function Get-PropsDictFromJavaPropsFile ($configFile) {
    # Returns configProps ordered dict
    $config = Get-Content $configFile
    Write-Verbose "$config"
    $configProps = [ordered]@{}
    # The 'if' block lines strip comments to avoid invalid/duplicate key issues
    $config | %{if (`
                            (!($_.StartsWith('#')))`
                                -and (!($_.StartsWith(';')))`
                                -and (!($_.StartsWith(";")))`
                                -and (!($_.StartsWith('`')))`
                                -and (($_.Contains('=')))){
                                    $props = @()
                                    $props = $_.split('=',2)
                                    # Use Write-Host or Write-Verbose, Write-Output appends to the return value and breaks things
                                    Write-Verbose "Props are $props"
                                    $configProps.add($props[0],$props[1])
                            }
                    }
    return $configProps
}

# Configure agent
if($currentConfig -ne $null)
{
    Write-Verbose "Keeping previous install settings"
    Set-Content -Path $buildAgentPropFile -Value $currentConfig
    $buildAgentProps = Get-PropsDictFromJavaPropsFile $buildAgentPropFile
}
else
{
    $buildAgentProps = Get-PropsDictFromJavaPropsFile $buildAgentDistFile
}

Write-Verbose "Build Agent original settings"
$buildAgentProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose

# Set values that require customization
$buildAgentProps['serverUrl'] = $serverUrl
$buildAgentProps['name'] = $agentName
$buildAgentProps['workDir'] = $agentWorkDir
$buildAgentProps['tempDir'] = $agentTempDir
$buildAgentProps['systemDir'] = $agentSystemDir
$buildAgentProps['ownPort'] = $ownPort

Write-Verbose "Build Agent updated settings"
$buildAgentProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$buildAgentProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Out-File $buildAgentPropFile -Encoding 'ascii'

# This rewrites the wrapper config file without comments, if you need the comments,
# don't supply an agentName or serviceAccount when installing to get the default config
if (-Not ($defaultName -eq $true -And $defaultServiceAccount -eq $true)) {
    $wrapperPropsFile = "$agentDir\launcher\conf\wrapper.conf"
    $wrapperProps = Get-PropsDictFromJavaPropsFile $wrapperPropsFile

    Write-Verbose "Java Service Wrapper original settings"
    $wrapperProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
    # Supplying a custom agentName allows multiple instances on a single machine
    if (-Not ($defaultName -eq $true -Or $agentName -eq "")) {
        $wrapperProps['wrapper.ntservice.name'] = "$agentName"
        $wrapperProps['wrapper.ntservice.displayname'] = "$agentName TeamCity Build Agent"
        $wrapperProps['wrapper.ntservice.description'] = "$agentName TeamCity Build Agent Service"
    }
    if($serviceAccount -ne $null){
        $wrapperProps['wrapper.ntservice.account'] = "$serviceAccount"
    }
    if($serviceAccountPassword -ne $null){
        $wrapperProps['wrapper.ntservice.password'] = "$serviceAccountPassword"
    }

    Write-Verbose "Java Service Wrapper updated settings"
    $wrapperProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
    $wrapperProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Out-File $wrapperPropsFile -Encoding 'ascii'
}

# TODO: catch failure and call chocolateyUninstall.ps1 or some other cleanup
$workingDirectory = Join-Path $agentDir "bin"
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.install.bat -Wait"
Sleep 2
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.start.bat -Wait"
tools\chocolateyuninstall.ps1 

$ErrorActionPreference = 'Stop'; # stop on all errors

$packageName = 'TeamCityAgent'
$zipFileName = 'buildAgent.zip'

$uninstalled = $false
Uninstall-ChocolateyZipPackage -PackageName $packageName `
                                -ZipFileName  $zipFileName

$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
# Don't use ConvertFrom-StringData as it corrupts Windows paths like C:\buildAgent
function Get-PropsDictFromJavaPropsFile ($configFile) {
    # Returns configProps ordered dict
    $config = Get-Content $configFile
    Write-Verbose "$config"
    $configProps = [ordered]@{}
    $config | %{if (`
                            (!($_.StartsWith('#')))`
                                -and (!($_.StartsWith(';')))`
                                -and (!($_.StartsWith(";")))`
                                -and (!($_.StartsWith('`')))`
                                -and (($_.Contains('=')))){
                                    $props = @()
                                    $props = $_.split('=',2)
                                    Write-Verbose "Props are $props"
                                    $configProps.add($props[0],$props[1])
                            }
                    }
    return $configProps
}
$installParametersFile = "$toolsDir/install-parameters.txt"
$installParameters = Get-PropsDictFromJavaPropsFile $installParametersFile
$installParameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$agentDir = $installParameters["agentDir"]
if (Test-Path $agentDir) {
    "Removing $agentDir"
    Remove-Item $agentDir -force -recurse
}

$uninstalled = $true

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
TeamCity Build Agent 5.0.3 64378 Friday, November 13, 2020 Approved
TeamCity Build Agent 5.0.2 904 Wednesday, November 11, 2020 Approved
TeamCity Build Agent 5.0.1 353 Tuesday, November 10, 2020 Approved
TeamCity Build Agent 5.0.0 186 Tuesday, November 10, 2020 Approved
TeamCity Build Agent 4.1.0 16943 Tuesday, July 14, 2020 Approved
TeamCity Build Agent 4.1.0-beta-2 280 Thursday, June 18, 2020 Approved
TeamCity Build Agent 4.1.0-beta-1 247 Monday, May 18, 2020 Approved
TeamCity Build Agent 4.0.2 55761 Thursday, November 28, 2019 Approved
TeamCity Build Agent 4.0.1 211 Thursday, November 28, 2019 Approved
TeamCity Build Agent 4.0.0 28838 Wednesday, June 12, 2019 Approved
TeamCity Build Agent 3.0.1 6966 Tuesday, January 22, 2019 Approved
TeamCity Build Agent 3.0.0 8808 Thursday, January 17, 2019 Approved
TeamCity Build Agent 3.0.0-beta-2 303 Thursday, January 17, 2019 Approved
TeamCity Build Agent 3.0.0-beta-1 305 Thursday, January 17, 2019 Approved
TeamCity Build Agent 2.3.0-beta-1 434 Wednesday, July 11, 2018 Approved
TeamCity Build Agent 2.2.1 203878 Friday, April 13, 2018 Approved
TeamCity Build Agent 2.1.2 19879 Thursday, October 19, 2017 Approved
TeamCity Build Agent 2.1.1 12440 Tuesday, August 1, 2017 Approved
TeamCity Build Agent 2.1.0 430 Wednesday, July 19, 2017 Approved
TeamCity Build Agent 2.0.1-beta-12 470 Wednesday, July 19, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-11 568 Friday, March 3, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-10 498 Thursday, March 2, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-09 495 Wednesday, March 1, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-08 460 Wednesday, March 1, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-07 483 Tuesday, February 28, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-06 551 Friday, January 13, 2017 Exempted
TeamCity Build Agent 2.0.1-beta-05 732 Friday, November 4, 2016 Exempted
TeamCity Build Agent 2.0.1-beta-04 526 Thursday, November 3, 2016 Exempted
TeamCity Build Agent 2.0.1-beta-03 545 Friday, October 28, 2016 Exempted
TeamCity Build Agent 2.0.1-beta-02 562 Tuesday, October 18, 2016 Exempted
TeamCity Build Agent 2.0.1-beta-01 521 Monday, October 17, 2016 Exempted
TeamCity Build Agent 2.0.0 34419 Friday, October 14, 2016 Approved
TeamCity Build Agent 1.2.1 534 Friday, October 14, 2016 Approved
TeamCity Build Agent 1.2.0 687 Friday, October 14, 2016 Approved
TeamCity Build Agent 1.1.0 9086 Tuesday, December 9, 2014 Approved
TeamCity Build Agent 1.0.9 665 Monday, September 29, 2014 Approved
TeamCity Build Agent 1.0.8 540 Monday, September 29, 2014 Approved
TeamCity Build Agent 1.0.7 553 Monday, September 29, 2014 Approved
TeamCity Build Agent 1.0.6 633 Thursday, July 3, 2014 Approved
TeamCity Build Agent 1.0.5 866 Thursday, March 13, 2014 Approved
TeamCity Build Agent 1.0.4 602 Wednesday, March 12, 2014 Approved
TeamCity Build Agent 1.0.3 633 Wednesday, March 12, 2014 Approved
TeamCity Build Agent 1.0.2 555 Tuesday, March 11, 2014 Approved
TeamCity Build Agent 1.0.1 507 Wednesday, March 5, 2014 Approved
TeamCity Build Agent 1.0.0 637 Thursday, February 20, 2014 Approved

Version 3.x of this package uses AdoptOpenJDK. Version 4.x depends on Chocolatey 0.10.14.

Discussion for the TeamCity Build Agent Package

Ground Rules:

  • This discussion is only about TeamCity Build Agent and the TeamCity Build Agent package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or TeamCity Build Agent, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus