Versions Compared

Key

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

...

Backup Center is your loyal tool for your saving Jira cloud site historical snapshot automatically. Atlassian doesn't officially provide data rollback based on a customer request. Thus, it's essential to take your site backup regularly. For example, backup Backup Center will help you when any of site data was lost by a user operation. Backup Center allows you to automatically take a snapshot periodic snapshots of your entire Jira cloud site data. You can save the backup files to our storage, or to your own to your own FTP networked storage, according to your schedule and preferences. The saved backup files can be used at any time to restore the information of past snapshot onto your Jira cloud site.

Installing the Backup Center App

To install the app go to as an Admin to settings and click Apps (on the left menu) and then Manage Apps.

...

Search for Backup Center app and install it.

Once the installation is complete, or whenever you select the installed app from the list going forward, you can reach the app configuration menu on the left, under BACKUP CENTER.

...

Configure your backup

From the Apps menu, select Configuration to setup the connectivity and storage parameters.

Setting Atlassian credentials

In order to use the Backup for Jira Cloud app you need to enter an Atlassian API token - this token is required in order to enable the app access to backup functionality. To obtain a token, go to the Atlassian website page - HERE.

Click the button Create API token. In the popup that appears enter a name for your token.

...

When you click Create, you should have access to your token.

...

Click Copy to copy the token string to your clipboard. Then, paste it in the app configuration Atlassian API Token field. If at any point in the future you want to change the token, you can create a new one and use it. Always make sure you keep your key securely.

Essentially, you can now click the button Save and this is all that you need to you to get the app to start creating basic backup snapshots and keep the 10 most recent ones. The rest of the configuration steps allows you to tailor your backup in more details to your needs.

Image Removed

In the Email address field, enter your Jira user email address.

Storage configuration

The default Managed storage space for the backup was created for you by the app. This cloud storage keeps your most recent backup snapshot files, up to the number of files that you configured, or up to the storage quota allocated for you. Currently the storage quota is 20GB. Note that this quota may be reached eventually if you specify a very large number of backup files to preserve. If you reached the quota you can reach Addon Experts Center for a paid increase of storage. Also note that you can download backup files from the storage and delete them as you wish.

Alternatively you can use your own, network connected, FTP storage server to store your backup files. We support the FTP, FTPS and SFTP protocols. To use such a configuration make sure you have a server ready, and get the following parameters that are necessary to define the secure access and communication method. Once you have the information about that storage, enter the information bellow.

  • Protocol Type: the backup can use FTP, FTPS or Secure FTP.

  • Storage target: the server to which the backup is delivered. You can use an IP address or a domain name.

  • Storage port: the network port that the backup is using. Default is the standard port 21 for FTP.

  • Storage username and password: your FTP server credentials.

Image Removed

In order to configure the backup network you need to set the following:

Atlassian Credentials

Atlassian API token - This token identifies your instance and allows the app to work securely. In order to get a token you can go to this Atlassian page. Make sure to keep your token stored securely.

Email address

Storage Service

You will need to ask your environment administrator to set a networked accessible FTP storage for you in order to store your backup files. Your application will need to have access to that storage with username and password. Once you have the information about that storage, enter the information bellow.

Protocol Type: the backup can use FTP, FTPS or Secure FTP.

Storage target: the serve to which the backup is delivered. You can use IP address of domain.

Storage port: the network port that the backup is using. Default is the standard port 21 for FTP.

Storage username and password: your FTP server credentials.

Once you defined all parameters click Save. When the setup is successful, you should see a confirmation popup.

...

Creating Backup Schemes

Once the networking and storage is set, you can configure actual backups. On the left menu, under JIRA BACKUP CENTER, click Backup Schedules.

...

To define a new scheme, click on the “+” button in your app page.

...

In the popup Schedule backup, you can set the following:

Backup name:

Backup type: You can select two type of backup: Basic and Extended. Basic backup includes the following: Extended backup includes the Basic and in addition attachments, avatar images and logos.

Days of the week: You can select the one or more day of the week, the time of the day the backup is trigger.

You can also select the number of backup files to keep

Storage link - this is the folder where your backup is kept. Typically, your IT will configure a folder for the FTP server storage. The best practice would be to specify a folder that will be relative to this “FTP root” folder, such as “my_backups". Note: is you use a folder starting with “/”, the system interprets is as a Unix root based folder, which may or may not be setup by your IT as accessible.

When you click Save, a confirmation popup is displayed.

...

Your scheme now appears as a line at the top of the page.

...

You can go ahead and create additional schemes. You can also edit each scheme by clicking the pencil icon.

(explain Status)

Note that If you want, instead of waiting to a scheduled backup, you an perform an immediate backup by clicking Backup now at the right of the scheme line. The actual backup may take several minutes. The latest successful backup date always appear in the scheme line.

...

Managing Backup Files

All backup files, from all the scheme are listed, with their name, extended with date and time, and size. You can delete a file by clicking the X button, and confirming the delete warning. Note that a deleted backup file is not recoverable. Remember as well that older backup file will be deleted automatically in a rolling fashion, based on your specifying how many old files to keep.

...

Image Removed

Restoring Backup Files

The backup restore is done through the existing Jira clout Import mechanisms, as described here. Once you decided on the backup file to be imported, follow those Atlassian instructions carefully.

NOTE THAT A RESTORE IS GOING TO OVERWRITE YOUR EXISTING SITE DATA. MAKE SURE YOU UNDERSTAND AND FOLLOW THE INSTRUCTION CAREFULLY.

A good practice before an import attempt it to backup your Jira cloud site information before the import. It is also best to import the information to a secondary cloud instance. Importing to this “staging” site first will help you ensure that the restore is working well, as well as verify that the data you imported includes what you expected.

When you restore a Basic Backup, you will need to click Import Data and select the file from your local storage.

The file will then upload into Jira (you should see a progress bar) and will get processed. If everything is correct you should be redirected to a new page, with a confirmation

We've checked your file for issues, and everything looks good.

A click on Run Import will open a Running Import screen. You should then see an import progress status step after step

...

When done, you should get an Import complete confirmation

Your data file was successfully imported to Jira Cloud.

Follow Atlassian's verification instructions in that page, to ensure the health of your updated site.

Add extended backup

Troubleshooting

Question -I got an ERROR indicator in my backup. What should I do?

Answer - Backups may fail due to one of the following:

  • Connection to storage failed

  • Not enough storage existed for saving the backup file

  • 48 hour limitation between Extended backups.

Question - when I define a link I get an error response starting with Failed to create directories for path.

Answer - the folder you are trying to use for the link cannot be created, possibly due to permission setup. Check with the IT person that installed your FTP server.The app has the following features:

  • Periodical backup of your Jira site on storage ready for you

  • Set the properties and timing of the backup

  • Project are saved as well as Assets

  • Ability to use your on storage on FTP/S server, MS SharePoint or AWS S3

  • Download backup files to your on device

  • Restore specific projects and/or issues that you choose from any saved backup

  • Restore Assets.

How does Backup Center work?

  • In a configuration page you set the backup configuration, times, the number of files to keep, and which storage to use. You have free 20GB of free space, or if you prepare your own set S3 or SharePoint

  • Project information as well as assets are saved

  • Backup will now commence automatically

  • A control panel shows you your backup schedule, status and existing backup snapshots.

  • You can view your backup files, download them or select the one to restore.

...

Table of content of this guide:

Child pages (Children Display)