This page describes how to restore JIRA data from a backup. This is the second step in either upgrading your server to a new JIRA revision, 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.
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.
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)
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 Standalone (i.e. Tomcat), it is done by setting the JAVA_OPTS environment variable before starting JIRA:
You could also try un-commenting the
JAVA_OPTS="-Datlassian.mail.senddisabled=true -Datlassian.mail.fetchdisabled=true line from your
/bin/setenv.sh file and then running startup.
2. Restoring XML data
Note: these instructions assume that you are restoring an XML backup. If you used native database tools to create your backup, the restore process will be tool-specific so these instructions do not apply to you.
- Log in as a user with the 'JIRA System Administrators' global permission.
- Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard.
- Under the 'Import & Export' sub-menu in the left-hand navigation column, click the 'Restore Data from XML' link. This will display the 'Restore data from Backup page:
- In the 'File name' field, fill in the file name of the ZIP or XML backup file generated by JIRA.
- The Index Path field shows the location where JIRA will restore the search index data from the XML backup file and it cannot be modified. This location matches the index path specified in the XML backup file. However, if the XML backup does not specify this 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.
- JIRA will come back, informing you that you have been logged out. This is done because all the users from the previous JIRA instance have been deleted and replaced with users from 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.