TeamCity 2019.1 Help

Configuring Build Agent Startup Properties

In TeamCity a build agent contains two processes:

  • Agent Launcher – a Java process that launches the agent process

  • Agent – the main process for a Build Agent; runs as a child process for the agent launcherWhether you run a build agent via the agent.bat|sh script or as a Windows service, at first the agent launcher starts and then it starts the agent.

On this page:

Agent Properties

For both processes above you can customize the final agent behavior by specifying system properties and variables for the agent to run with.

Build Agent Is Run Via Script

Before you run the <Agent Home>\bin\agent.bat|sh script, set the following environment variables:

  • TEAMCITY_AGENT_MEM_OPTS – set agent memory options (JVM options)

  • TEAMCITY_AGENT_OPTS – additional agent JVM options

Build Agent Is Run As Service

In the <Agent Home>\launcher\conf\wrapper.conf file, add the following lines (one per option):

wrapper.app.parameter.<N>

Agent Launcher Properties

It's rare that you would ever need these. Most probably you would need affecting main agent process properties described above.

Build Agent Is Run Via Script

Before you run the <Agent Home>\bin\agent.bat|sh script, set the TEAMCITY_LAUNCHER_OPTS environment variable.

Build Agent Is Run As Service

In the <Agent Home>\launcher\conf\wrapper.conf file, add the following lines (one per option, the N number should increase):

wrapper.java.additional.<N>

See also:

Concepts: Agent Home Directory

Administrator's Guide: Configuring TeamCity Server Startup Properties