This process is typically conducted towards the end of Migrating JIRA to Another Server or splitting your JIRA instance across multiple servers.
If you wish restore a single project from your backup into an existing JIRA instance, refer to these instructions on restoring a project from backup instead.
Restoring JIRA from backup is a three stage process:
- (Optional) Disable email sending/receiving
- Restore data from XML to the database
- (Optional) Restore the attachments to the attachments directory (if attachments were backed up)
Before you begin
- When restoring data, all data in the existing JIRA database is deleted, including all user accounts. Before you begin, make sure you have the password to a login in the backup file that has the JIRA System Administrator global permission.
- If you are restoring data from a JIRA Cloud site to an installed JIRA server, please read Migrating from JIRA Cloud to JIRA Server.
1. Disabling email sending/receiving
If you are restoring production data into a test JIRA instance for experimentation purposes, you probably want to disable JIRA's email interaction features before you begin:
- Disable email notifications — if JIRA is configured to send emails about changes to issues, and you want to make test modifications to the copy, you should start JIRA with the
- Disable POP/IMAP email polling — if JIRA is configured to poll a mailbox (to create issues from mails), you will likely want to disable this polling on your test installation. This is done by setting the
Exactly how to set these flags is dependent on your particular application server, but for JIRA, this is done by setting the
DISABLE_NOTIFICATIONS environment variable before starting JIRA (note, use
startup.sh instead of
startup.bat if you are not using Windows):
You could also try un-commenting the
DISABLE_NOTIFICATIONS=" -Datlassian.mail.senddisabled=true -Datlassian.mail.fetchdisabled=true -Datlassian.mail.popdisabled=true" line from your
/bin/setenv.bat file (
/bin/setenv.sh if you are not using Windows) and then running startup.
2. Restoring XML data
These instructions assume that you are restoring JIRA data from an XML backup. If you used native database tools to back up your JIRA data, the restore process will be tool-specific and so these instructions (i.e. stage 2 of 3) do not apply to you.
- Log in as a user with the 'JIRA System Administrators' global permission.
Keyboard shortcut: 'g' + 'g' + type 'rest' > System. Select Import & Export > Restore System to open the Restore JIRA data from Backup page.
- In the 'File name' field, type the file name of the zipped XML backup file generated by JIRA.
Ensure that this backup file has been moved or copied to the location specified below this field.
- The Index Path field indicates where JIRA will restore the search index data from the zipped XML backup file. This location (which cannot be modified) matches the index path specified in the zipped XML backup file. If, however, this backup file does not specify an index path, JIRA will restore the search index to the
caches/indexessubdirectory of the JIRA Home Directory.
- The contents of the index directory may be deleted by the restore process.
- The index directory should only contain JIRA index data.
- Click the 'Restore' button and wait while your JIRA data is restored.
Once the data has been restored, JIRA will inform you that you have been logged out. This happens because all JIRA users which existed in JIRA prior to JIRA's data being restored will have been deleted and replaced by users stored in the JIRA export file.
It is recommended that you avoid passing through a proxy when performing an XML restore, especially if your JIRA instance is very large. Using a proxy may cause timeout errors.
3. Restoring attachments
If you created a backup of the attachments directory, you will need to restore the backup into a directory where JIRA can access it.
If you use a custom directory for storing your attachments, ensure that JIRA has read and write permissions to this directory and its subdirectories.
The process of restoring the attachments backup depends on the way it was created. Usually you can use the same tool to restore the backup as the one that was used to create it (see Backing up attachments).
If you are restoring the attachments into a different location (i.e. a different directory path) from where they were previously located (e.g. this will be the case when moving servers), please follow the instructions provided in Configuring attachments to change the location of the attachments directory so that JIRA can find the restored attachments.