TeamCity 2019.2 Help

Configuring TeamCity Server Startup Properties

Various aspects of TeamCity behavior can be customized through a set options passed on a TeamCity server start. These options fall into two categories: affecting Java Virtual Machine (JVM) and affecting TeamCity behavior.

TeamCity internal properties

TeamCity has internal configuration properties which affect various aspects of the internal logic. These are normally meant for debugging, changing internal constants or enabling experimental behavior.

Please do not change the internal properties unless asked by the TeamCity support team.
If you have internal properties customized, make sure to note this when you turn to the TeamCity support.

Server administrators can review and edit internal properties in the TeamCity web UI: go to the Administration | Server Administration | Diagnostics page, select the Internal Properties tab, and click Edit internal properties.
Many properties do not require the server restart, but some do. When the restart is required we usually note that specifically.

The properties are stored in the <TeamCity Data Directory>/config/ file. The file is a Java properties file. If necessary, you can edit the file manually and add each required property <property_name>=<property_value> on a separate line.

An alternative but obsolete method of adding an internal property is to pass it as a -D<name>=<value> JVM option (see the section below).

JVM Options

If you need to pass additional JVM options to a TeamCity server (for example, -D options mentioned in Reporting Issues or any other options like -X...), the approach will depend on the way the server is run.

  • If you are using the .war distribution, please refer to the manual of your Web Application Server.

  • In all other cases, refer to the next section.

For general notes on the memory settings, refer to Setting Up Memory settings for TeamCity Server.

You will need to restart the server for the changes to take effect.

Standard TeamCity Startup Scripts

If you run the server using the runAll or teamcity-server scripts or as a Windows service, you need to set the options via the OS environment variables passed to the TeamCity server process:

  • TEAMCITY_SERVER_MEM_OPTS – server JVM memory options (for example, -Xmx750m)

  • TEAMCITY_SERVER_OPTS – additional server JVM options (for example, -Dteamcity.git.fetch.separate.process=false)

The process of setting an environment variable depends on your operating system. For example, in Windows, go to Control Panel\System and Security\System and then open the Advanced system settings | Environment Variables window.

Make sure the environment variables are set for the user whose account is used to run TeamCity or as global environment variables. You might need to reboot the machine after the environment change for the changes to have effect.