TeamCity 8.0 Help

Creating Backup from TeamCity Web UI

TeamCity allows creating a backup of TeamCity data via the Web UI. To create a backup file, navigate to the TeamCity Backup page of the Administration section, specify backup parameters, as described below and start backup process.

Option

Description

Backup file

Specify the name for the backup file, the extention (.zip) will be added automatically. By default, TeamCity will store the backup file under < >/backup folder. For security reasons you cannot explicitly change this path in the UI. To modify this setting specify an absolute or relative path (the path should be relative to TeamCity Data Directory) in the < >/config/backup-config.xml file. For example:

<backup-settings> ... <general> <backup-dir path="C:/TC-Backups"/> </general> ... </backup-settings>

add time stamp suffix

Check this option to automatically add time stamp suffix to the specified filename. This may be useful to differentiate your backup files, if you don't clean up old backups.

Backup scope

Specify what kind of data you want to back up. The contents of the backup file depending on the scope is described right in the UI, when you select a scope. Note, that the size of the backup file and the time the backup process will take depends on the scope you select. You can select the "basic" scope, which includes server settings, projects and builds configurations, plugins and database, to reduce the resulting file size and the time spent on backup. However, you'll be able to restore only those settings which were backed up.

When you start backup, TeamCity will display its status and details of the current process including progress and estimates.

On the History tab of Administration | TeamCity Backup page you can review the list of created backup files, their size and date when the files were created. Note that only backup files created from web UI are shown here. If you have perfomed backup by means of maintainDB utility, they are not displayed on the History tab.

Last modified: 20 April 2023