Child pages
  • Download - Installation - Upgrade
Skip to end of metadata
Go to start of metadata

Installation packages

You can choose one of the installation packages:

  • TeamCity-xxx.war - for installation into existing J2EE container
  • TeamCity-xxx.tar.gz - contains Tomcat J2EE container for Linux installation
  • TeamCity-xxx.exe - Windows installer

Upgrade

Upgrading using Windows installer

  • shutdown server
  • shutdown agent if it was installed from the TeamCity installer
  • locate .BuildServer folder on the disk and backup it (usually this folder is created in the home directory of the user under which the TeamCity server is running)
  • if you installed custom plugins backup them
  • uninstall previous installation using 'Add or Remove Programs' system applet
  • run the new installer and follow its' steps (when asked specify .BuildServer folder used by previous installation)
  • if you use MySQL (see how to enable) put MySQL Connector jar to the <TeamCity installation folder>/webapps/ROOT/WEB-INF/lib directory.
  • If your database configuration differs from default HSQLDB settings, you'll have to configure database in a separate database.properties file. This file should be located in the TeamCity data config directory (defaults $HOME\.BuildServer\config). After the first run of TeamCity template files database.mysql.properties and database.hsqldb.properties are be placed to this directory for reference. Copy one of them to database.properties and edit settings according to your database configuration.
  • if you use custom plugins, put their jars to <TeamCity installation folder>/webapps/ROOT/WEB-INF/lib for server-side plugins and to <TeamCity installation folder>/webapps/ROOT/update/plugins for build agent plugins
  • startup the TeamCity server (and agent if it was installed with the installer)

Manual Upgrading on Linux and for WAR distribution

  • shutdown server
  • backup old TeamCity files (either whole TeamCity directory or [TOMCAT_HOME]/webapps/TeamCity/* in case of war file installation)
  • remove old installation files (either whole TeamCity directory or [TOMCAT_HOME]/webapps/TeamCity/* in case of war file installation)
  • unpack new archive in place of previous installation
  • if you use MySQL (see how to enable) put MySQL Connector jar to the <TeamCity installation folder>/webapps/ROOT/WEB-INF/lib directory.
  • If your database configuration differs from default HSQLDB settings, you'll have to configure database in a separate database.properties file. This file should be located in the TeamCity data config directory (defaults $HOME\.BuildServer\config). After the first run of TeamCity template files database.mysql.properties and database.hsqldb.properties are be placed to this directory for reference. Copy one of them to database.properties and edit settings according to your database configuration.
  • if you use custom plugins, put their jars to ROOT/WEB-INF/lib for server-side plugins and to ROOT/update/plugins for build agent plugins
  • specify additional System Properties for Running the Server, if needed
  • startup the server

All the configuration data and database scheme will by updated by our converters upon first startup after the upgrade.

Installation

Installing Server using Windows Installer

Just run TeamCity-xxx.exe and follow installer instructions. You may either install or skip build agent installation on the machine with server (you'll be able to add more agents when server is running).

Installing Server with bundled Tomcat

  1. Unpack TeamCity-xxx.tar.gz archive (in Linux, use tar xfz TeamCity-xxx.tar.gz) command, in Windows, use WinZip, WinRar or similar utility.
  2. Go to TeamCity/bin directory and run runAll.bat for Windows, and sh runAll.sh start for Linux. If desired, you may specify additional System Properties for Running the Server in this script.

As a result, you should get a Team Server server up and running on http://localhost:8111/ and one registered build agent, which runs on the same computer.

If you wish to disable this default agent, comment agent startup lines in runAll.(sh|bat) file.

Installing Server as WAR

  1. Copy the downloaded TeamCity-xxx.war file into the web applications directory of your J2EE container under TeamCity.war name.
  2. Restart the server. If desired, you may specify additional System Properties for Running the Server in container startup script.

Installing and Starting Agents

Build agents are installed through the Team Server web interface. To do this, you should go to the Agents web page,
click "Install Build Agents" link and choose a possible build agent distribution.

Build agent installation using Windows installer

  1. Open the server's web interface and go to the "Agents" page.
  2. Click the "Install Build Agent" link and choose "Via MS Windows Installer" option.
  3. Follow installer instructions

Build agent installation using Java Web Start

  1. On the agent computer, set up JAVA_HOME environment variable to point to JDK 1.5+ installation directory.
  2. Open the server's web interface and go to the "Agents" page.
  3. Click the "Install Build Agent" link and choose "Via Java Web Start" option.
    The agent will be installed into the following folder: <installation path>\buildAgent
  4. To start the agent, run the file:
    <installation path>\buildAgent\bin\agent.bat or agent.sh for Unix and MacOS
  5. If needed, you may install build agent windows service instead of manual agent startup

Manual build agent installation from buildAgent.zip

  1. On the agent computer, set up JAVA_HOME environment variable to point to JDK 1.5+ installation directory.
  2. Open the server's web interface and go to the "Agents" page.
  3. Click the "Install Build Agent" link and choose "download zip file" option.
  4. Unpack agent archive
  5. Copy buildAgent/conf/buildAgent.dist.properties file to buildAgent/conf/buildAgent.properties
  6. In buildAgent/conf/buildAgent.properties file specify name of the agent, and URL of the TeamCity server
  7. To start the agent, run the file:
    <installation path>\buildAgent\bin\agent.bat or agent.sh for Unix and MacOS
  8. If needed, you may install build agent windows service instead of manual agent startup

Build Agent Windows Service

On windows, you may want to use build agent windows service. To install this service, go to buildAgent/bin directory and run agentd.exe -install. There are also options -uninstall, -start, -stop.

Build Agent configuration

Build agent configuration file is stored at buildAgent/conf/buildAgent.properties. You may review and alter it, if needed.
See TeamCity FAQ for details about build agent configuration.

IDE Plugins

Various TeamCity IDE plugins can be downloaded from "My Settings" page of the TeamCity web interface.
The installation instructions for the plugins are provided in TeamCity help.

  • No labels