Agent Home Directory

Build Agent Home Directory is the directory where the agent has been installed.

The Build Agent can be installed into any directory. If you use TeamCity .tar.gz distribution or .exe distribution opting for Build Agent installation, the agent will be placed into < TeamCity Home >/buildAgent. The default directory suggested by .exe or Java Web Start agent installation is C:\BuildAgent.

The agent stores all related data under it's directory and the only place that requires installation/uninstallation into OS is integrating into system's automatic start (e.g. service settings under Windows). See Setting up and Running Additional Build Agents for details.

Agent Directories

The agent consists of:

• agent binaries (stored under bin, launcher and lib directories). The binaries can be automatically updated from the server to match the server version.

• agent plugins and tools (stored under plugins and tools directories). These are parts of agent binary installation and are managed by the agent itself, updating automatically whenever necessary from the TeamCity server.

• agent configuration (stored under conf and launcher\conf directories). Unique piece of information defining the agent settings and behavior.

• Agent Work Directory (stored under work directory by default, configurable via agent configuration).

• agent auxiliary data (stored under system,

  temp, backup, update directories). The data necessary during agent running.

• agent logs (stored under logs directory) - The directory storing internal agent logs that might be necessary for agent issues investigation.

Agent Files Modification

Agent configuration is the only directory designed to have files that might be edited by the user. All the other directories should not be edited by the user.

Content of agent work directory can be deleted (but only entirely). This will result in clean checkout for all the affected builds.

Content of directories storing agent auxiliary data can be deleted (but only entirely and while the agent is not running). Deletion of the data can result in extra actions during next builds on this agent, but this is meant to have only performance impact and should not affect consistency.

Important Agent Files and Directories

• /bin

  • agent.bat — batch script to start/stop the build agent from console under Windows

  • agent.sh — shell script to start/stop the build agent under Linux/Unix

  • service.install.bat — batch file to install the build agent as a Windows service. See also Setting up and Running Additional Build Agents.

  • service.start.bat — starts build agent using installed build agent service

  • service.stop.bat — stops installed build agent service

  • service.uninstall.bat — batch file to uninstall currently installed build agent Windows service

• /conf/ — this folder contains all configuration files for build agent

  • buildAgent.properties — Build Agent Configuration. This file would be generated by TeamCity server .exe installer, build agent .exe installer and build agent Java Web Start agent installer.

  • buildAgent.dist.properties — sample configuration file. You can rename it to 'buildAgent.properties' to create initial agent configuration file.

  • teamcity-agent-log4j.xml — build agent logging settings. For details please refer to comments inside the file or to the log4j manual

• /launcher/conf/

  • wrapper.conf.template — sample configuration file to be used as template for creating original configuration

  • wrapper.conf — current build agent Windows service configuration. This is Java Service Wrapper configuration java properties file. For details, please see comments inside the file or Java Service Wrapper documentation.

• /logs

  • launcher.log — log of build agent launcher

  • teamcity-agent.log — main build agent log

  • wrapper.log — log from Java Service Wrapper. Available only if build agent is running as windows service

  • teamcity-build.log — log from build

  • upgrade.log — log from build agent upgrade process

  • teamcity-vcs.log — agent-side checkout logs

• /temp — temporary folder; path may be overridden in the buildAgent.properties file

  • agentTmp — temporary folder that is used by the build agent to store build-related files during the build. Is cleaned after each build.

  • buildTmp — temporary folder that is set as default temp directory for build process and is cleaned after each build

  • globalTmp — temporary folder that is used by the build agent for own temporary files. Is cleaned on agent restart.