- Quick Setup Guide
- Download TeamCity
- Install and run on Windows
- Install and run on Linux and macOS
- TeamCity First Start
- Install TeamCity Server on Linux or macOS
- Download TeamCity Server
- Install from tar.gz
- Install TeamCity Server on Linux or macOS
- Download TeamCity Server
- Install from tar.gz
- Quick Setup Guide
- Download TeamCity
- Install and run on Windows
- Install and run on Linux and macOS
- TeamCity First Start
Quick Setup Guide
This article describes the evaluation setup of a TeamCity server and one build agent on the same machine, for the most popular operating systems.
To get a general idea of how to install TeamCity for evaluation, you can watch this video tutorial, or read the full guide below.
To install TeamCity for the production setup, read this section.
You can also use the TeamCity Server and Build Agent Docker images.
Download TeamCity
Download the free Professional Edition of TeamCity, which is a full-featured TeamCity bundled with 3 build agents with a limit of 100 build configurations.
After evaluation, you can switch to the Enterprise Edition. Read the details of our licensing policy and pricing.
Install and run on Windows
Run the downloaded .exe file and follow the instructions of the TeamCity Setup wizard. The TeamCity web server and one build agent will be installed on the same machine.
During the installation, you can:
- set the TeamCity Home Directory where TeamCity will be installed.
- choose whether the TeamCity server and agent will run as Windows services
- configure ports:
- Server port: 8111 is the default port. Note that it can be already occupied by other applications on your machine. If this port is already in use, you can change it during the installation. In the example below, we set the port to 7777 .
- Agent port: 9090 is the default for incoming connections from the server. If this port is already in use, you can set the ownPort property to a different value to change the port.
If you have installed TeamCity as a Windows service, follow the usual procedure of starting and stopping services.
Otherwise, to start or stop the TeamCity server and one default agent at the same time, launch the runAll script via a command line. The script is located in the \bin directory.
- to start the server and the default agent:
If you did not change the default port ( 8111 ) during the installation, the TeamCity web UI can be accessed at http://localhost via a web browser running on the same machine. Otherwise, use http://localhost: ( http://localhost:7777 in our example).
Install and run on Linux and macOS
- Make sure you have Java 8 or 11 installed (for example, use the bundled Amazon Corretto). Java 8 support will be discontinued in TeamCity Server 2023.04 (to be released in April 2023). If you use a non-bundled version of Java 8, we highly recommend that you migrate your server to Java 11. Open a command-line terminal and run the following command:
To start/stop the TeamCity server and one default agent at the same time, run the runAll script via a terminal. The script is located in the /bin directory.
- to start the server and the default agent:
By default, TeamCity runs on http://localhost:8111/ and has one registered build agent that runs on the same machine. If another application already uses this port, the TeamCity server (Tomcat server) will not start with the «Address already in use» errors in the server logs or server console.
To change the server port, locate the /conf/server.xml and modify the port in the XML node, for example:
TeamCity First Start
When you launch TeamCity in a browser for the first time, it will prompt you to complete the installation:
- Review the location of the TeamCity Data Directory, where all the configuration information is stored. Click Proceed.
- TeamCity stores the build history, users, build results, and some runtime data in an SQL database and allows you to select the database type.
For now, keep the default internal database. Click Proceed.
It will take some time for TeamCity to configure the necessary components. - On the next screen, accept the License Agreement to proceed with the launch. Click Continue.
- TeamCity displays the Create Administrator Account page. Specify the administrator credentials and click Create Account.
You are signed in to TeamCity: now you can configure your user settings and create and run your first build.
Install TeamCity Server on Linux or macOS
Before installing the TeamCity server, you might want to estimate your system requirements and read about supported platforms.
Download TeamCity Server
Go to the JetBrains website and download the .tar.gz distribution with the «portable» version of the TeamCity server.
Or, you can install it from a Docker image. All the information related to the TeamCity Server Docker images is described on Docker Hub.
Specifics of the .tar.gz distribution:
- It includes a Tomcat version tested to work fine with the respective version of TeamCity. You can use an alternative Tomcat version, but other combinations are not guaranteed to work correctly.
- It is possible to configure the installation by changing the startup script and JRE options.
- It comes bundled with a build agent distribution and a startup script which allows for easy TeamCity server evaluation with one agent.
- It comes bundled with the devPackage for the TeamCity plugin development.
Install from tar.gz
We recommend running the TeamCity server under a dedicated user account.
It is highly recommended running the TeamCity server under a dedicated user account.
To install the TeamCity server, unpack the TeamCity.tar.gz archive. You can use the tar xfz TeamCity.tar.gz command under Linux * and WinZip, WinRar, or similar utility under Windows.
* We advise using GNU tar or the gtar xfz command for unpacking. For example, Solaris 10 tar is reported to truncate long file names and may cause ClassNotFoundException when using the server after unpacking.
Ensure that JRE or JDK are installed and the JAVA_HOME environment variable is pointing to the Java installation directory (see recommended Java versions).
Install TeamCity Server on Linux or macOS
Before installing the TeamCity server, you might want to estimate your system requirements and read about supported platforms.
Download TeamCity Server
Go to the JetBrains website and download the .tar.gz distribution with the «portable» version of the TeamCity server.
Or, you can install it from a Docker image. All the information related to the TeamCity Server Docker images is described on Docker Hub.
Specifics of the .tar.gz distribution:
- It includes a Tomcat version tested to work fine with the respective version of TeamCity. You can use an alternative Tomcat version, but other combinations are not guaranteed to work correctly.
- It is possible to configure the installation by changing the startup script and JRE options.
- It comes bundled with a build agent distribution and a startup script which allows for easy TeamCity server evaluation with one agent.
- It comes bundled with the devPackage for the TeamCity plugin development.
Install from tar.gz
We recommend running the TeamCity server under a dedicated user account.
It is highly recommended running the TeamCity server under a dedicated user account.
To install the TeamCity server, unpack the TeamCity.tar.gz archive. You can use the tar xfz TeamCity.tar.gz command under Linux * and WinZip, WinRar, or similar utility under Windows.
* We advise using GNU tar or the gtar xfz command for unpacking. For example, Solaris 10 tar is reported to truncate long file names and may cause ClassNotFoundException when using the server after unpacking.
Ensure that JRE or JDK are installed and the JAVA_HOME environment variable is pointing to the Java installation directory (see recommended Java versions).
Quick Setup Guide
This article describes the evaluation setup of a TeamCity server and one build agent on the same machine, for the most popular operating systems.
To get a general idea of how to install TeamCity for evaluation, you can watch this video tutorial, or read the full guide below.
To install TeamCity for the production setup, read this section.
You can also use the TeamCity Server and Build Agent Docker images.
Download TeamCity
Download the free Professional Edition of TeamCity, which is a full-featured TeamCity bundled with 3 build agents with a limit of 100 build configurations.
After evaluation, you can switch to the Enterprise Edition. Read the details of our licensing policy and pricing.
Install and run on Windows
Run the downloaded .exe file and follow the instructions of the TeamCity Setup wizard. The TeamCity web server and one build agent will be installed on the same machine.
During the installation, you can:
- set the TeamCity Home Directory where TeamCity will be installed.
- choose whether the TeamCity server and agent will run as Windows services
- configure ports:
- Server port: 8111 is the default port. Note that it can be already occupied by other applications on your machine. If this port is already in use, you can change it during the installation. In the example below, we set the port to 7777 .
- Agent port: 9090 is the default for incoming connections from the server. If this port is already in use, you can set the ownPort property to a different value to change the port.
If you have installed TeamCity as a Windows service, follow the usual procedure of starting and stopping services.
Otherwise, to start or stop the TeamCity server and one default agent at the same time, launch the runAll script via a command line. The script is located in the \bin directory.
- to start the server and the default agent:
If you did not change the default port ( 8111 ) during the installation, the TeamCity web UI can be accessed at http://localhost via a web browser running on the same machine. Otherwise, use http://localhost: ( http://localhost:7777 in our example).
Install and run on Linux and macOS
- Make sure you have Java 8 or 11 installed (for example, use the bundled Amazon Corretto). Java 8 support will be discontinued in TeamCity Server 2023.04 (to be released in April 2023). If you use a non-bundled version of Java 8, we highly recommend that you migrate your server to Java 11. Open a command-line terminal and run the following command:
To start/stop the TeamCity server and one default agent at the same time, run the runAll script via a terminal. The script is located in the /bin directory.
- to start the server and the default agent:
By default, TeamCity runs on http://localhost:8111/ and has one registered build agent that runs on the same machine. If another application already uses this port, the TeamCity server (Tomcat server) will not start with the «Address already in use» errors in the server logs or server console.
To change the server port, locate the /conf/server.xml and modify the port in the XML node, for example:
TeamCity First Start
When you launch TeamCity in a browser for the first time, it will prompt you to complete the installation:
- Review the location of the TeamCity Data Directory, where all the configuration information is stored. Click Proceed.
- TeamCity stores the build history, users, build results, and some runtime data in an SQL database and allows you to select the database type.
For now, keep the default internal database. Click Proceed.
It will take some time for TeamCity to configure the necessary components. - On the next screen, accept the License Agreement to proceed with the launch. Click Continue.
- TeamCity displays the Create Administrator Account page. Specify the administrator credentials and click Create Account.
You are signed in to TeamCity: now you can configure your user settings and create and run your first build.