Specifying a backup schedule

You can configure Bamboo to automatically create a backup each night, rather than doing a manual export every time.

Before you begin,

  • Bamboo will be unavailable while the backup process completes. The export itself may take a long time to complete, depending on the number of builds and test. We recommend running your backups at a time of day or night when usage is low.
  • Backups may require large amounts of disk space, depending on the number of builds and tests. Please make sure you have enough disk space in your desired backup location before proceeding.
  • Bamboo will not export if plans are currently being built (see Using the Bamboo dashboard).

Specifying a backup schedule

To specify a backup schedule:

  1. Click the  icon in the Bamboo header and choose Overview.
  2. Click Scheduled Backups in the left navigation column (under 'System').
  3. Click Edit to modify the schedule settings:

    Setting Notes
    Disable scheduled backups This check box must be cleared for automatic backups to be performed.
    Backup Artifacts Select if you want to include build artifacts in your scheduled backups.
    Backup path Specify the directory where you want to store your backups. Each backup will be stored as a single file. It may be necessary to modify the Bamboo bamboo.paths.set.allowed system property to do this.
    Note that:
    Bamboo restricts the editing of certain file path settings for security reasons (see Bamboo Security Advisory 2010-05-04). If you must configure Bamboo to permit modification to its file path settings, start Bamboo with the system property bamboo.paths.set.allowed=true. The procedure for configuring a Bamboo system property is described on Configuring system properties.
    Once you have configured your file path setting, we recommend removing or disabling the bamboo.paths.set.allowed system property and restarting Bamboo. If your Bamboo instance is accessible to anyone outside your organisation, then this will minimise the risk of Bamboo being compromised by security-related attacks.
    Backup file prefix Specify the first part of the filename for all your backup files.
    Backup file date pattern Specify the date/time format for identifying your individual backup files. This will be appended to Backup file prefix to form the complete filename for your backup files.

    Use the Schedule Editor to choose the frequency with which backups will be performed. See Cron-based scheduling for more information about the Schedule Editor.

  4. Click Save. Your first backup will run when your server's clock matches the specified time.

Disabling a backup

If you disable schedule backups, your schedule details will be retained but no automatic backups will be performed.

To disable a scheduled backup:

  1. Click the  icon in the Bamboo header and choose Overview.
  2. Click Scheduled Backups in the left navigation column. The 'Scheduled Backup Details' page will be displayed, showing details about the status of scheduled backups or any currently configured backup.
  3. Click Edit to edit the current 'Scheduled Backup Details'.
  4. Select the Disable scheduled backups check box.
  5. Click Save.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

7 Archived comments

  1. User avatar


    is there any possibility to use in the date pattern the day of week ?

    Mon for example ?

    25 Oct 2012
  2. User avatar


    What exactly is in the backup?  Why would a database backup (sql server for example) not be sufficient.  (I'm arguing with server admin about this)

    18 Sep 2013
    1. User avatar

      James Dumay [Atlassian]

      Hi Gretchen,

      The backup includes build artifacts, logs and the contents of the database.

      Backing up the database is not enough as it does not include the artifacts and build logs.


      19 Sep 2013
  3. User avatar

    Tom Gardner

    Is it possible to not use the date in the filename of the export?

    Our backups are copied, rotated and named via scripts that run after the backups have been taken, so I need each backup to overwrite the previous. I can do this with the sql dump but Bamboo won't let me leave the Backup file date pattern field blank.

    01 Nov 2013
    1. User avatar

      Tom Gardner

      If anyone else is interested I got around this by just using "-" as the date pattern. It's a little messy to have a file ending "-.zip" but it works.

      01 Nov 2013
      1. User avatar

        Christopher Fitzner

        Using a "-" to trick bamboo into keeping only 1 backup has the side affect of compromising the backup during the backup period.  Our backup takes 3 hours.  So for 3 hours every night using a "-" as the pattern, we don't have a good backup file.  This is fine if you take snapshots of the backup file and store it elsewhere.  Be careful to take the snapshot when its not in a backup period however.

        BAM-16071 - Scheduled backup should only overwrite previous backup when the process completes Open

        23 Jul 2015
  4. User avatar

    Mike Friedrich

    Here is the allowed format for the Backup file date patternhttp://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

    12 Dec 2014
Powered by Confluence and Scroll Viewport