Icon

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

 

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 in the <TeamCity Data Directory>/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 <TeamCity Data Directory>/config/backup-config.xml file. For example:

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

add timestamp 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.

Tip
  • If the directory where backup files are stored already contains a file with the name specified above, TeamCity won't run backup - you will need either to specify another name, or enable time stamp suffix option, which allows to avoid this.
  • Time stamp suffix has specific format: sorting backup files alphabetically will also sort them chronologically.

Anchor
backup_scope
backup_scope
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.

To reduce the resulting file size and the time spent on the backup, select the "basic" scope, which includes server settings, projects and builds configurations, plugins and database. However, you'll be able to restore only the settings which were backed up.

For the full backup suitable for most of the needs, it is recommended to use the Custom scope with all the items selected except for "" and then backup the <TeamCity Data Directory>/system/artifacts location as a usual file system.

Build artifacts are not included into the backup due to their size. It is recommended to either to backup the artifacts directories separately or use a redundant storage for storing the artifacts. Build logs are stored as a part of build artifacts, so there is no need to backup the build logs if you implement a separate backup of the artifacts locations.

...