• Browse
  • Pages
  • Blog
  • Labels
  • Attachments
  • Bookmarks
  • Mail
  • Advanced

  • What’s New
  • People Directory
  • Space Directory
  • Keyboard Shortcuts
  • Confluence Gadgets
• Log In
• Sign Up

1. Dashboard
2. TeamCity 7.x Documentation
3. TeamCity Documentation
4. Administrator's Guide
5. TeamCity Configuration and Maintenance
6. Configuring TeamCity Server Startup Properties
7. Information
8. Page Comparison

Configuring TeamCity Server Startup Properties

Version 4 by Yegor Yarko on Apr 27, 2012 19:23. << Changes from 3 to 4 compared with Version 5 by Yegor Yarko on Jul 11, 2012 13:34. Changes from 5 to 6 >>

Key This line was removed. This word was removed. This word was added. This line was added.

Comment:

Changes (1)

View Page History

...

Various aspects of TeamCity behavior can be customized through a set options passed on TeamCity server start. These options fall into two categories: affecting Java Virtual Machine (JVM) and affecting TeamCity behavior.
{note}You do not need to specify any of the options unless you are advised to do by TeamCity support team or you know what you are doing.{note}
In this section:
{toc}

h3. TeamCity internal properties {anchor:internal.properties}
TeamCity has some properties that are not exposed to UI and are meant for debug use only. If you need to set such a property (e.g. asked by TeamCity support), you can set it either as {{-D<name>=<value>}} JVM property (see below), or you can add TeamCity-specific properties in {{<TeamCity Data Directory>/config/internal.properties}} file. The file is Java [properties file| http://en.wikipedia.org/wiki/.properties], to add property put {{<property name> = <property value>}} on a separate line. If you do not have the file, just create a new one.

{anchor:JVMProperties}
h3. JVM Properties
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 run the server using Windows service, please refer to [#TeamCity Server is Run as Windows Service], if you are using {{.war}} distribution, use the manual of your Web Application Server. In all other cases, please refer to [#Server is Run Via Shell Script].

For general notes on the memory settings, please refer to [Setting Up Memory settings for TeamCity Server|Installing and Configuring the TeamCity Server#memory].

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

h4. Server is Run Via Shell Script
If you run the server using the {{runAll}} or {{teamcity-server}} scripts, you can set the options via {{TEAMCITY_SERVER_OPTS}} environment variable.

* {{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}})

h4. TeamCity Server is Run as Windows Service

Since *TeamCity 7.1* you will need to set environment variables as described in [#Server is Run Via Shell Script] to affect TeamCity run a a service.

For TeamCity 7.0 and previous versions please use the instructions below:

To edit JVM server options run Tomcat's service configuration editor by executing the command {code}tomcat7w.exe //ES//TeamCity{code} in {{<[TeamCity home|TeamCity Specific Directories#tcHomeDir]>\bin}} directory and then edit the Java Options on the _Java_ tab ([for more information see Tomcat 6 documentation|http://tomcat.apache.org/tomcat-6.0-doc/windows-service-howto.html]).

...

To change heap memory dedicated to the JVM change the "Maximum memory pool" setting.

\\
\\
{color:#003366}*See also:*{color}
{panel:borderStyle=dashed|bgColor=#FFFFFF}
*Concepts*: [TeamCity Data Directory]
*Administrator's Guide*: [Configuring Build Agent Startup Properties]
{panel}
\\
\\
\\
\\
\\
\\
\\

\\
\\
\\
\\
\\
\\
\\

\\
\\
\\
\\
\\
\\
\\

\\
\\
\\
\\
\\
\\
\\

\\
\\
\\
\\
\\
\\
\\

• Powered by Atlassian Confluence 3.5.16, the Enterprise Wiki
• Printed by Atlassian Confluence 3.5.16, the Enterprise Wiki.
•   |  Report a bug
•  |  Atlassian News