Preventing users from accessing JIRA during backups

For production use, it is strongly recommended that for regular backups, you use native database backup tools instead of JIRA's XML backup service.

When JIRA is in use, XML backups are not guaranteed to be consistent as the database may be updated during the backup process. JIRA does not report any warnings or error messages when an XML backup is generated with inconsistencies and such XML backups will fail during the restore process. Native database backup tools offer a much more consistent and reliable means of storing (and restoring) data.

If you perform an XML backup (e.g. when upgrading JIRA via a test environment or migrating JIRA to another server), you can follow one of these methods to prevent users from accessing JIRA and minimise inconsistencies in the backup file:

  • Recommended method:
    • If you have an Apache or other web/proxy server sitting in front of JIRA, then you can stop Apache from proxying to JIRA, and serve a static HTML page with a nice message along the lines of "JIRA is undergoing maintenance". Note:
      • The administrator must be able to access JIRA directly (not through Apache) to perform the XML backup.
      • This method does not require JIRA to be restarted.
  • Alternative method 1:
    1. Shut down JIRA, configure it to listen on a different port and restart. Do this by editing the server.xml file (or the jira.xml file in your Apache Tomcat installation running JIRA WAR). Change the following section:

      • Note: If you have enabled HTTPS, then you would need to edit the HTTPS Connector section as well.
    2. Restart JIRA and do the XML backup.
    3. Shut down JIRA, change all the settings back, then re-start JIRA.
  • Alternative method 2:
    • If you have a firewall in front of JIRA, you could stop requests from getting through or change the port number that it uses. Note:
      • The administrator will need to log in to JIRA on the temporary port number (or access it from behind the firewall), to perform the XML backup.
      • This method does not require JIRA to be restarted.

Before you start:

Whichever method you choose, we recommend setting an Announcement Banner to warn your users that JIRA will be unavailable for a period of time.

Was this helpful?

Thanks for your feedback!

6 Archived comments

  1. User avatar

    Matt Doar (ServiceRocket)

    What about for Confluence?

    16 Jan 2008
    1. User avatar

      huasoon

      There are some scheduled jobs within Confluence that might modify the indexes that is residing outside the database.

      08 Oct 2008
  2. User avatar

    Joe Caputo

    Atlassian should update this page to also include instructions on how to disable the mail handlers that create/comment on tickets.

    26 Apr 2012
  3. User avatar

    Anonymous

    What if you want read-only access while you are doing a migration? I can't chuck my users off completely for 2 hours while my new server churns through importing the XML script!

    19 May 2013
  4. User avatar

    Omar Shehab

    What if I want to migrate from an OnDemand JIRA to a hosted JIRA? Anyway to freeze the OnDemand instance?

    24 Jun 2013
  5. User avatar

    Pascal Querner

    How is an admin able to access JIRA without apache in place? 

    16 Jul 2015
Powered by Confluence and Scroll Viewport