Installation Quick Start
This page covers the evaluation setup of a TeamCity server with a default build agent running 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 our video tutorial:
For more details about the production setup, see the Installation and Upgrade section.
Download the free Professional Edition of TeamCity, the full-featured TeamCity bundled with 3 build agents with a limit of 100 build configurations (or 20, for versions earlier than TeamCity 2017.2).
After evaluation, you can switch to the Enterprise Edition: Licensing Policy provides details. The pricing is available on the JetBrains website.
Earlier versions are available here page.
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 installation, you can configure:
TeamCity Home Directory where TeamCity will be installed
whether the TeamCity server and agent will run as Windows services
80is the default port, which can be already used by other applications (for example, Skype). Change the server port if it is already in use. In the example below, we've set the port to
9090is the default for incoming connections from the server. If this port is already in use, you'll be asked to change it by setting the
ownPortproperty to a different value.
If the TeamCity server is installed as a Windows service, follow the usual procedure of starting and stopping services.
Otherwise, to start/stop the TeamCity server and one default agent at the same time, use the
runAll script, provided in the
<TeamCity Home>\bin directory:
to start the server and the default agent, use.\runAll.bat start
to stop the server and the default agent, use.\runAll.bat stop
If you did not change the default port (
80) during the installation, the TeamCity web UI can be accessed at
http://localhost in a web browser running on the same machine where the TeamCity server is installed. Otherwise, use
http://localhost:8111 in our case).
on Linux and OS X
Make sure you have Java 8 installed (for example, use bundled Amazon Corretto).
Open a command-line terminal and run the following command:java -version
Make sure the
JAVA_HOMEenvironment variable is pointing to the Java installation directory. Run the following command in the command-line terminal:echo $JAVA_HOME
TeamCity<version number>.tar.gzarchive to unpack TeamCity bundled with Tomcat servlet container.
Unpack the archive. For example, under Linux usetar xfz TeamCity<version number>.tar.gz
The archive can be used on Windows as well.
After the archive is unpacked, the TeamCity web server and one build agent will be available on the current machine.
Note that for production purposes it is recommended to set up the TeamCity server and agent on separate machines.
To start/stop the TeamCity server and one default agent at the same time, use the
runAll script, provided in the
<TeamCity Home>/bin directory.
to start the server and the default agent, use./runAll.sh start
to stop the server and the default agent, use./runAll.sh stop
By default, TeamCity runs on
http://localhost:8111/ and has one registered build agent that runs on the same computer. If another application uses the same port as the TeamCity server, 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
<TeamCity Home>/conf/server.xml and modify the port in the
<Connector> XML node, for example:
Start TeamCity for the First Time
On the first TeamCity start:
Review the location of the TeamCity Data Directory, where all the configuration information is stored. Click Proceed.
TeamCity stores 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.