Child pages
  • Backup Strategy

This documentation relates to an older version 2.0 of the Structure Plugin for JIRA. View the current documentation home.

Skip to end of metadata
Go to start of metadata

Structure data is stored separately from JIRA data and is not included in the general System Backup. To ensure that your Structure information is safe, it recommended to make Structure backup a part of your overall backup strategy.

Option 1. Part of JIRA Home Directory Backup

Structure stores all its data in structure/ sub-directory of the JIRA home directory – see Structure Files Location.

So if you already have backup strategy for the whole JIRA home directory, then you are also backing up Structure.

Option 2. File-based Backup

As noted above, all Structure data is in structure/ sub-directory of the JIRA home. You can use your operating system tools to back up the whole structure directory.

Hot backup (while JIRA and Structure are running) is possible, although in case of restore, the embedded Derby database might need some time to process transaction log files.

Hot backup is unsafe because there's a possibility that you will copy a database file at the same time it is changed by the database – so the backup copy will have an undefined intermittent state, which may make the whole backed up database corrupt. However, you can verify that the copied database is correct by opening it with Derby tools.

Cold backup is safer and preferred, but it can be done only by disabling Structure plugin, making a backup and enabling Structure again. (There's no need to stop JIRA.)

When running JIRA on Windows, you won't be able to do hot backup by normal file copying, because the files in structure directory will be open. You can use volume shadow copy tools from Microsoft to copy a snapshot of the files.

Option 3. XML backup

You can manually back up structure through Structure Backup menu.

If you have resources to develop your own mini-plugin for backup strategy, you can automatically back up Structure through API – use StructureBackupManager interface.

We currently have an open feature request for developing automatic backup and other periodic maintenance tasks. Feel free to watch/vote/comment.

Restoring From File Backup

In case of failure, you can restore Structure data from file backup by disabling Structure plugin, copying the whole contents of structure/ directory back in place, and enabling Structure again.

Restoring from XML Backup

Restoring from XML backup is error-proof but requires a bit more time. See Restoring Structure from Backup for instructions.

Incremental and Differential Backups

As Structure database is typically not large, full backup is recommended.

Structure XML backup/restore does not support incremental backup, but you can use your operating system tools for incremental or differential backup of the files in structure directory.