TeamCity Data Backup

note

We strongly urge you to make the backup of TeamCity data before making any upgrade. Please note that TeamCity server does not support downgrading.

Server Backup



warning

Before performing the backup procedures, you need to stop the TeamCity server.

The following is needed to be backed up:

1. <TeamCity data directory> You may refer to TeamCity Data Directory section on the directory structure.

   note

   Please note that you need to always back up the <TeamCity data directory>/system/version.dat file, and ensure it is saved/restored in sync with other data files and the database data.

   The <TeamCity data directory>/system/buildserver.* files store HSQLDB data. You should back them up if you use HSQLDB (a default setting).

2. Database data Database stores all information on the build results (except for artifacts and build logs), VCS changes, pinned builds, agents, build queue, user accounts, etc.

   • If you use HSQLDB (default, not recommended for production), the database is stored in the <TeamCity data directory>/system folder. All files from the directory can be backed up. Or refer to the HSQLDB backup notes.

   • If you use MySQL, please back up your database schema used by TeamCity.

     note

     MySQL database connection settings are specified in the <TeamCity data directory>/config/database.properties file. See also Installation.

3. Application files You do not need to back up TeamCity application directory (web server alone with the web application), provided you still have original distribution package and you didn't:

   • place any custom libraries for TeamCity to use

   • install any non-default TeamCity plugins

   • make any startup script/configuration changes If you feel you need to back up the application files:

   • If you use non-war distribution: back up everything under <TeamCity home directory> except for temp and work directories.

   • If you use war distribution, pursue the backup procedure of the servlet container used.

4. Log files If you need TeamCity log files (which are mainly used for problem solving or debug purposes), back up <TeamCity home directory>/logs directory.

   note

   You may also want to back up TeamCity Windows Service settings, if they were modified.

Build Agent's Data Backup



1. Build Agent configuration Back up the <Build_Agent_installation_folder>/conf/buildAgent.properties file. You may also wish to back up any other configuration files changed (Build Agent configuration is specified in <Build_Agent_installation_folder>/conf and <Build_Agent_installation_folder>/launcher/conf directories).

2. Log files If you need Build Agent log files (mainly used for problem solving or debug purposes), back up <Build_Agent_installation_folder>/logs directory.

   note

   You may also wish to back up Build Agent Windows Service settings, if they were modified.