This page covers new TeamCity server installation. For upgrade instructions, please refer to Upgrade.
The installation procedure consists of:
This page covers:
After you obtained the TeamCity installation package, proceed with corresponding installation instructions:
If you cannot access TeamCity web UI after successful installation, please refer to Troubleshooting TeamCity Installation Issues section.
For the Windows platform, run the executable file and follow the installation instructions. You have options to install the TeamCity web server and one build agent that can be run as a Windows service.
If you opted to install the services, use standard Windows Services applet to manage the service.
If you did not change the default port (80) during the installation, the TeamCity web UI can be accessed via "http://localhost/" address in a web browser running on the same machine as the server is installed on. Please note that 80 port can be used by other programs (e.g. Skype, or other web servers like IIS). In this case you can specify another port during the installation and use "http://localhost:<port>/" address in the browser.
Please review software requirements before the installation.
Unpack TeamCity<version number>.tar.gz archive (for example, using tar xfz TeamCity<version number>.tar.gz command under Linux, or WinZip, WinRar or alike utility under Windows).
Ensure you have JRE or JDK installed and JAVA_HOME environment variable is pointing to the Java installation directory. Latest Oracle Java 1.6 update is recommended.
If TeamCity server is installed as Windows service, follow the usual procedure of starting and stopping services.
If TeamCity is installed into existing web server (.war distribution) please start the server according to it's documentation. Please make sure to configure TeamCity-specific logging-related properties
If TeamCity is installed using .exe or .tar.gz distributions, TeamCity server can be started and stopped by the scripts provided in the <TeamCity home>/bin directory.
To start/stop TeamCity server and one default agent at the same time, use the runAll script.
To start/stop only the TeamCity server, use teamcity-server script and pass the required parameters. Start the script without parameters to see usage instructions.
By default, TeamCity runs on http://localhost:8111/ and has one registered build agent that runs on the same computer.
See below for changing the server port.
If you need to pass special properties to the server, please refer to Configuring TeamCity Server Startup Properties.
TeamCity J2EE container distribution is tested to work with Tomcat 7 servlet container. (See also Supported Platforms and Environments#The TeamCity Server)
Starting up TeamCity server on a Mac is quite similar to starting Tomcat on Mac.
If you want to use another version of Tomcat web server instead of bundled one, you have the choices of whether to use .war TeamCity distribution or do Tomcat upgrade/patch for TeamCity installed from .exe or .tar.gz distributions.
Upon successful installation, TeamCity server web UI can be accessed via a web browser.
If TeamCity web UI cannot be accessed, please check:
One of the most common issues with the server installation is using a port that is already used by another program. See
If you use TeamCity server Windows installer you can set the port to use during installation.
Use the following instructions to change the port if you use .tar.gz distribution
To change the server's port, in the <TeamCity Home>/conf/server.xml file, change the port number in the HTTP/1.1 connector (here the port number is 8111):
To apply changes, you should restart the server.
If you run another Tomcat server on the same machine, you might need to also change other Tomcat server service ports (search for "port=" in the server.xml file).
If you want to use https:// protocol, it should be enabled separately and the process is not specific to TeamCity, but rather for the web server used (Tomcat by default). See also Using HTTPS to access TeamCity server
TeamCity server is a web application that runs in an J2EE application server (a JVM application). A JVM application requires a JRE installation to run.
TeamCity (both server and agent) requires JRE 1.6 (or later) to operate. Using latest Oracle JSDK 1.6 is recommended (download page). Please also note that TeamCity agent needs JDK (not JRE) to operate properly.
The necessary steps to prepare Java installation depends on the distribution used.
As a JVM application, TeamCity only utilizes memory devoted to the JVM. Memory used by JVM usually constitutes of: heap (configured via -Xmx), permgen (configured via -XX:MaxPermSize), internal JVM (usually tens of Mb), OS-dependent memory features like memory-mapped files. TeamCity mostly depends on heap and permgen memory and these settings can be configured for the TeamCity application manually by passing -Xmx (heap space) and -XX:MaxPermSize (PermGen space) options to the JVM running the TeamCity server.
To change memory settings, refer to Configuring TeamCity Server Startup Properties, or to the documentation of your application server, if you run TeamCity using .war distribution.
The recommended approach is to start with initial settings and monitor for the percentage of used memory (see also TW-13452) at the Administration | Diagnostics page. If the server uses more then 80% of memory consistently without drops for tens of minutes, that is probably a sign to increase the memory values by another 20%.
TeamCity can run under both 32 and 64 bit JVM.
If you choose to use x64 JVM please note that the memory usage is almost doubled when switching from 32 to 64 bit JVM, so please make sure you specify at least twice as much memory as for 32 bit JVM, see Setting Up Memory settings for TeamCity Server.
If you run TeamCity as a service and switch to x64 bit, you will also need to use x64 Tomcat executables, see more.
The default placement of the TeamCity data directory can be changed. See corresponding section: TeamCity Data Directory for details.
After successful server start, any TeamCity page request will redirect to prompt for the server administrator username and password. Please make sure that no one can access the server pages until the administrator account is setup.
After administration account setup you may begin to create Project and Build Configurations in the TeamCity server. You may also want to configure the following settings in the Server Administration section:
Skip to end of metadata Go to start of metadata