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.
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:
8111is 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
9090is the default for incoming connections from the server. If this port is already in use, you will be prompted to change it by setting the
ownPortproperty to a different value.
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
<TeamCity Home>\bin directory.
to start the server and the default agent:.\runAll.bat start
to stop the server and the default agent:.\runAll.bat stop
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:7777 in our example).
Install and run on Linux and macOS
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 the Tomcat servlet container.
Unpack the archive. For example, under Linux use:tar xfz TeamCity<version number>.tar.gz
After the archive is unpacked, the TeamCity web server and one build agent will be available on the current machine.
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
<TeamCity Home>/bin directory.
to start the server and the default agent:./runAll.sh start
to stop the server and the default agent:./runAll.sh stop
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
<TeamCity Home>/conf/server.xml and modify the port in the
<Connector> 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.