Icon

You are viewing the documentation of TeamCity 9.x, which is not the most recently released version of TeamCity.
View this page in TeamCity 10.x and 2017.1 documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.

 
Skip to end of metadata
Go to start of metadata

TeamCity provides several ways to back up its data:

Restoring data from backup is performed using the maintainDB tool.

Icon

We strongly urge you to make the backup of TeamCity data before upgrading. Note that TeamCity server does not support downgrading.

Backing up Data

TeamCity allows backing up the following data:

  • Data stored in the database
  • Server settings,
  • Custom plugins (installed under <TeamCity Data Directory>\plugins) and and database drivers (from <TeamCity Data Directory>/lib directory)
  • Build logs
  • Personal changes

The data to be backed up can be configured using the backup scope options when using the TeamCity Web UI or via additional parameters for the maintainDB command-line tool.

The following data is not included into backup:

  • build artifacts (because of their size). These include explicit build artifacts and internal artifacts storing coverage report, finish build parameters, settings digest, etc. If you need the build artifacts, please also backup content of artifacts directories manually. 

  • for backup taken from UI: running builds and build queue state.  If you want to backup these, use the command line maintainDB tool while the TeamCity server is not running.
  • TeamCity application manual customizations under <TeamCity Home>, including used server port number which are stored in <TeamCity Home>/conf/server.xml file.
  • TeamCity application logs (they also reside under <TeamCity Home>/logs)
  • Any manually created files under <TeamCity Data Directory> that do not fall into previously mentioned items.

The recommended approach is either to perform the backup process described under Manual Backup and Restore or run a backup from the web UI regularly (e.g. automated via REST API) with the "Basic" level - this will ensure backing up all important data except build artifacts and build logs.

Build artifacts and logs (if necessary) can be backed up manually by copying files under .BuildServer/system/artifacts and, prior to TeamCity 9.0.BuildServer/system/messages.

Since TeamCity 9.1, if logs are selected for backup, TeamCity will be searching for them in all artifact directories currently specified on the server.

Note that for large production TeamCity installations export and import of the data from/to the database may not be an optimal solution and maintaining database backup via replication might be a better option; e.g. see the corresponding documentation for MySQL database.



See also:

Installation and Upgrade: Upgrade