Icon

You are viewing the documentation of TeamCity 9.x, which is not the most recently released version of TeamCity.
View this page in TeamCity 10.x documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.

 
Skip to end of metadata
Go to start of metadata

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.

Icon

You do not need to specify any of the options unless you are advised to do by the TeamCity support team or you know what you are doing.

In this section:

TeamCity internal properties 

TeamCity server has some configuration properties that are not exposed in the UI. These are regularly meant for debugging, changing internal constants or enabling experimental behavior. If you need to set such a property (e.g. asked by TeamCity support), add it to the <TeamCity Data Directory>/config/internal.properties file. The file is a Java properties file. Create the file and add a required property <property name>=<property value> on a separate line. Many properties do not require server restart, however some do.

If you have internal properties customized, make sure to note this when you turn to TeamCity support.

Once you create the file, you can 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.

An alternative way to add an internal property is to pass it as a -D<name>=<value> JVM option (see below).

JVM Options

If you need to pass additional JVM options to a TeamCity server (e.g. -D options mentioned at Reporting Issues or any non-"-D" options like -X...), the approach will depend on the way the server is run. If you are using the .war distribution, use the manual of your Web Application Server. In all other cases, please refer to the #Standard TeamCity Startup Scripts section below.

For general notes on the memory settings, please 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 (e.g. -Xmx750m -XX:MaxPermSize=270m)
  • TEAMCITY_SERVER_OPTS — additional server JVM options (e.g. -Dteamcity.git.fetch.separate.process=false)

Please 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.



See also:

 

 

 

 

 

  • No labels