Skip to end of metadata
Go to start of metadata

This page covers software-related environments TeamCity works with. For hardware-related notes, see this section.

In this section:

Platforms (Operating Systems)

TeamCity Server

Core features of TeamCity server are platform-independent. See considerations on choosing server platform.
TeamCity server is a web application that runs within a capable J2EE servlet container.

Requirements:

  • Java (JRE), see configuration notes. Supported are:
    • Oracle Java 8 and updates (included in the Windows .exe distribution). 32 or 64 bit (64 bit is recommended for production)
    • OpenJDK 8. 32 or 64 bit

For the .war distribution, note that the.war distribution is going to be discontinued, and it is highly recommended to use the .tar.gz distribution, which has Tomcat bundled. It is not advised to customize Tomcat settings unless absolutely necessary.
If you still want to use the .war distribution, note that:

    • TeamCity is tested under Apache Tomcat 7, earlier versions are not recommended. Since TeamCity 2017.2, Tomcat 8.5 is included in Windows .exe and .tar.gz distributions and is the recommended server.
    • Since TeamCity 2017.2, TeamCity supports J2EE Servlet 3.0+ and JSP 2.2+  container based on Apache Jasper.
    • Although TeamCity is reported to work with Jetty and Tomcat 6.x-7.x, note that Tomcat 6.x and Jetty 7.x implement Servlet 2.5 and are not supported since TeamCity 2017.2
    • Due to the bug in Tomcat 7.0.25 and another one in Tomcat 7.0.54, these versions cannot be used with TeamCity
    • TeamCity may not work properly if the Apache Portable Runtime is enabled in Tomcat.

Generally, all the recent versions of Windows, Linux and macOS are supported. If you find any compatibility issues with any of the operating systems please make sure to let us know.

The TeamCity server is tested under the following operating systems:

  • Linux (Ubuntu, Debian, RedHat, SUSE, and others)
  • macOS
  • Windows 7/7x64
  • Windows Server 2008, 2012, 2016
  • Server Core installation of Windows Server 2016
  • Windows 8, Windows 10
    under the Tomcat 7 web application server.

Reportedly works without known issues on:

  • Windows Server 2008 R2
  • Solaris
  • FreeBSD
  • IBM z/OS
  • HP-UX

Since TeamCity 2017.2 Windows XP/XP x64 is no longer officially supported.

Build Agents

The TeamCity Agent is a standalone Java application.

Requirements:

  • Java (JRE), see configuration notes. Supported are:
    • Oracle Java 6-8, (Java 8 is recommended and is included in the Windows .exe distribution). 32 or 64-bit.
    • OpenJDK 6-8 is supported, but Oracle JDK is recommended. 32 or 64-bit

TeamCity agent is tested under the following operating systems:

  • Linux
  • macOS
  • Windows 7/7x64
  • Windows 8, Windows 10
  • Windows Server 2003/2008, 2012, 2016
  • Server Core installation of Windows Server 2016

Reportedly works on:

  • Windows XP/XP x64
  • Windows 2000 (interactive mode only)
  • Solaris
  • FreeBSD
  • IBM z/OS
  • HP-UX

Stop Build Functionality

Build stopping is supported on:

  • Windows 7/7x64/8/10
  • Linux on x86, x64, PPC and PPC64 processors
  • macOS on Intel and PPC processors
  • Solaris 10 on x86, x64 processors

Windows Tray Notifier

Windows 7/7x64/8/10 with one of the supported versions of Internet Explorer.

Web Browsers

The TeamCity Web Interface is mostly W3C-compliant, so just about any modern browser should work well with TeamCity. The following browsers have been specifically tested and reported to work correctly in the recent versions of:

  • Google Chrome
  • Mozilla Firefox 
  • Safari under Mac
  • Microsoft Edge
  • Microsoft Internet Explorer 9+ (without the compatibility mode), since TeamCity 2017.2 Microsoft Internet Explorer 10+. Note that support for Microsoft Internet Explorer 10 will be discontinued in the next TeamCity version.
  • Opera 15+

Build Runners

TeamCity supports a wide range of build tools, enabling both Java and .Net software teams to build their projects.

Supported Java build runners

  • Ant 1.6-1.9 (TeamCity 10.0.x comes bundled with Ant 1.9.7, TeamCity 2017.1 - Ant 1.9.9.)
  • Maven versions 2.0.x, 2.x, 3.x (known at the moment of the TeamCity release). Java 1.5 and higher is supported. TeamCity comes bundled with Maven 2.2.1, 3.0.5, 3.1.1, 3.2.5.
  • IntelliJ IDEA Project runner (requires Java 8)
  • Gradle (requires Gradle 0.9-rc-1 or higher)
  • Java Inspections and Java Duplicates based on IntelliJ IDEA (requires Java 8)

Supported .Net platform build runners

  • MSBuild. Requires .Net Framework or Mono installed on the build agent. Microsoft Build Tools 2013, 2015 and 2017 (since TeamCity 10.0.4) are also supported.
  • NAnt versions 0.85 - 0.91 alpha 2. Requires .Net Framework or Mono installed on the build agent.
  • Microsoft Visual Studio Solutions (2003 - 2015 and 2017 (since TeamCity 10.0.4).  Requires a corresponding version of Microsoft Visual Studio installed on the build agent.
  • FxCop. Requires FxCop installed on the build agent.
  • Duplicates Finder for C# and VB.NET code based on ReSharper Command Line Tools. Supported languages are C# up to version 4.0 and VB.NET version 8.0 - 10.0. Requires .Net Framework 4.0+ installed on the build agent.
  • Inspections for .NET based on ReSharper Command Line Tools. Requires .Net Framework 4.0+ installed on the build agent.
  • .NET Process Runner for running any .NET application (requires .NET installed on the build agent)
  • NuGet runners (supported only for agents running Windows OS by default. Require NuGet.exe Command Line tool installed on the agents). Supported NuGet versions are 1.4+.  NuGet versions prior to 2.8.6 require .Net Framework 4.0+ installed on the build agent, NuGet 2.8.6 and later requires .NET 4.5.
    Since TeamCity 2017.1 NuGet runners support Linux and macOS when Mono is installed on the agent. Note that only NuGet CLI 3.2+ on Mono 4.4.2+ is supported. 
  • .NET CLI (dotnet) available since TeamCity 2017.2. Requires the .NET Core SDK  installed on build agents.

Other runners

  • Rake
  • Command Line Runner for running any build process using a shell script
  • PowerShell versions 1.0 through 5.0 are supported. 
  • Xcode versions 3-8 are supported (requires Xcode installed on the build agent)

Testing Frameworks

  • JUnit 3.8.1+, 4.x
  • NUnit 2.2.10, 2.4.x, 2.5.x, 2.6.x, 3.0.x are supported (dedicated build runner). 
  • TestNG 5.3+
  • MSTest 8.x, 9.x, 10.x, 11.x, 12.x,14.x, and since TeamCity 10.0.4 - 15.x and VSTest are supported by the Visual Studio Tests runner; requires the appropriate Microsoft Visual Studio edition or Visual Studio Test Agent installed on the build agent. TeamCity versions prior to 9.1.5 require the appropriate Microsoft Visual Studio edition installed on the build agent.

  • MSpec (requires MSpec installed on the build agent)

Version Control Systems

  • Git (Since TeamCity 2013.1.3 requires Git client installed on the server in order to perform maintenance of Git clones via "git gc" command, latest version is recommended)
  • Subversion (server versions 1.4-1.9 and higher as long as the protocol is backward compatible).
  • Perforce (requires a Perforce client installed on the TeamCity server). Check compatibility issues.
  • Team Foundation Server 2005, 2008, 2010, 2012, 2013, 2015, 2017 are supported. 
  • Mercurial (requires the Mercurial "hg" client v1.5.2+ installed on the server)
  • CVS
  • SourceGear Vault 6 and 7 (requires the Vault command line client libraries installed on the TeamCity server)
  • Borland StarTeam 6 and up (the StarTeam client application must be installed on the TeamCity server)
  • IBM Rational ClearCase, Base and UCM modes (requires the ClearCase client installed and configured on the TeamCity server)
  • Microsoft Visual SourceSafe 6 and 2005 (requires a SourceSafe client installed on the TeamCity server, available only on Windows platforms)

For support for other VCS please check external plugins available.

Checkout on Agent

The requirements noted are for agent environment and are additional to those for the server listed above.

  • Git (git client version 1.6.4+ must be installed on the agent, latest version is recommended)
  • Subversion (working copies in the Subversion 1.4-1.8 format are supported)
  • Perforce (a Perforce client must be installed on the TeamCity agent machine)
  • Team Foundation Server 2005-2015, and since TeamCity 10.0.4 - 2017 are supported. 
  • Mercurial (the Mercurial "hg" client v1.5.2+ must be installed on the TeamCity agent machine)
  • CVS
  • IBM Rational ClearCase (the ClearCase client must be installed on the TeamCity agent machine)

Labeling Build Sources

  • Git
  • Subversion
  • Perforce
  • Team Foundation Server
  • Mercurial
  • CVS
  • SourceGear Vault
  • Borland StarTeam
  • ClearCase

Remote Run on Branch

  • Git
  • Mercurial

Feature Branches

  • Git
  • Mercurial

VCS Systems Supported via Third Party Plugins

Cloud Agents Integration

Check also other non-bundled and third-party cloud integration plugins.

VCS Hosting Services Integration

Issue Tracker Integration

Links to issues of any issue tracker can also be recognized in change comments using Mapping External Links in Comments.

IDE Integration

TeamCity provides productivity plugins for the following IDEs:

  • Eclipse: Eclipse versions 3.8 and 4.2-4.6 are supported. Eclipse must be run under JDK 1.5+
  • IntelliJ Platform Plugin: compatible with IntelliJ IDEA 13.0.x - 2017.2.x (Ultimate and Community editions); as well as other IDEs based on the same version of the platform, including JetBrains RubyMine 6.3+, JetBrains PyCharm 3.1+, JetBrains PhpStorm/WebStorm 7.1+, AppCode 2.1+. See more information on compatibility.
  • Microsoft Visual Studio 2010, 2012, 2013, 2015, 2017 is supported by the TeamCity Visual Studio Add-in shipped as a part of ReSharper Ultimate. Installed .NET Framework is required. 

Remote Run and Pre-tested Commit

Remote Run and Pre-tested commit functionality is available for the following IDEs and version control systems:

IDE

Supported VCS

Eclipse

  • Subversion 1.7-1.8 via Subclipse and Subversive Eclipse integration plugins or SvnKit.
  • Subversion 1.4-1.7 via Subclipse and Subversive Eclipse integration plugins.
  • Perforce (P4WSAD 2009.2 - 2010.1, P4Eclipse 2010.1 - 2015.1)
  • Git (the EGit 2.0+ Eclipse integration plugin)
  • CVS
  • ClearCase (the client software is required)
  • see also

IntelliJ IDEA Platform *)

  • Subversion
  • Perforce
  • Git (remote run only)
  • Team Foundation Server (since TeamCity 2017.1; the plugin update is required)
  • ClearCase

Microsoft Visual Studio

  • Subversion 1.4-1.9 (the command-line client is required)
  • Team Foundation Server 2005 and later. Installed Team Explorer is required.
  • Perforce 2008.2 and later (the command-line client is required)

*) Supported only with the VCS integrations bundled with the IDEs by JetBrains

Code Coverage

IDE

Supported Coverage Tool

Eclipse

IDEA and EMMA code coverage

IntelliJ IDEA Platform

IDEA, EMMA and JaCoCo code coverage

Microsoft Visual Studio

JetBrains dotCover coverage. Requires JetBrains dotCover installed in Microsoft Visual Studio

Supported Databases

See more at Setting up an External Database

  • HSQLDB 1.8/2.x (internal, used by default) (warning) The internal database suits evaluation purposes only; we strongly recommend using an external database in a production environment.
  • MySQL 5.0.33+, 5.1.49+, 5.5+, 5.6+, 5.7+ (Please note that due to bugs in MySQL, versions 5.0.20, 5.0.22 and 5.1 up to 5.1.48 are not compatible with TeamCity)
  • Microsoft SQL Server 2005, 2008, 2012, 2014 and 2016 (including Express editions), SQL Azure; SSL connections support might require these updates.
  • PostgreSQL 8.2 and newer
  • Oracle 10g and newer (TeamCity is tested with driver version 12.1.0.1)