Documentation for JIRA 4.3. Documentation for other versions of JIRA is available too.

Skip to end of metadata
Go to start of metadata

The JIRA home directory contains key data that help define how JIRA works. You must have a JIRA home directory specified for your JIRA instance before you can start it. This document describes how to specify the location of the JIRA home directory for your JIRA instance.

One JIRA home per JIRA instance

Icon

You can only have one JIRA home per JIRA instance. If you have multiple JIRA instances, you will need to set up a JIRA home for each instance. A lock is placed on the root level of a JIRA home when created, to ensure that it is only used by one JIRA instance. If you have accidentally locked your JIRA home directory, you can unlock it by following the instructions in this FAQ.

You only need to specify the location of the root directory for your JIRA home. The sub-directories will be created automatically when JIRA is started or when you use a function in JIRA that requires a particular sub-directory.

How do I set my JIRA home?

There are a few methods available for specifying the location of your JIRA Home Directory in JIRA. However, please be aware of the notes below before your specify this location.

Recommended Methods

The recommended methods for specifying the location of your JIRA Home Directory in JIRA are to either:

  • Edit the jira-application.properties file (see the JIRA Installation Directory page to find where this file is located), add a 'jira.home' property and set it to your desired location for the JIRA home directory. Please use forward-slashes ("/"), not back-slashes ("\").
  • Set an environment variable named JIRA_HOME in your operating system whose value is the location of your JIRA home directory. To do this:
    • On Linux/Unix, do one of the following:
      • Enter the following command at a shell/console prompt before running JIRA:
        • export JIRA_HOME = /path/to/jira/home
      • Specify the command above in a script used to start JIRA.
    • On Windows, do one of the following:
      • Configure this environment variable through the Windows user interface (typically through 'My Computer' or 'Computer')
      • Enter the following command at command prompt before running JIRA:
        • set JIRA_HOME = X:\\path\\to\\jira\‌\home
          (where X is the drive letter where your JIRA home directory is located)
      • Specify the command above in a batch file used to start JIRA.

If you have specified different values for a 'jira.home' property in the jira-application.properties file and a JIRA_HOME environment variable, the value of the JIRA_HOME environment variable takes precedence.

Alternative Method

Alternatively, you can specify the location of your JIRA Home Directory as a parameter/property in your application server:

  • Configure a new web context property called 'jira.home' for your application server. For Tomcat (and JIRA Standalone), you will need to configure the server.xml file:
    Note that If you have specified a JIRA home location in jira-application.properties, it will override your web context property.

What location should I specify for my JIRA home?

You can specify any location on a disk for your JIRA home directory. Please be sure to specify an absolute path.

Please note that you cannot use the same JIRA home directory for multiple instances of JIRA. We recommend locating your JIRA Home Directory completely independently of the JIRA Installation Directory (i.e. not nesting one within the other) as this will minimise information being lost during major operations (e.g. backing up and restoring instances).

How do I change my JIRA home?

To change the location of your JIRA home directory,

  1. Set your JIRA home to the new location, using your preferred method as described in "How do I set my JIRA home?" (above).
  2. Restart JIRA.

Notes:

  • If you are using the Windows installer, you do not need to configure the JIRA Home Directory separately as you will be prompted to specify this location during the installation process.
  • If you are using JIRA Standalone, you do not need to do this — please see the JIRA Configuration Tool instead.
  • If you are using JIRA WAR-EAR, you need to set your JIRA home before you build JIRA.
  • No labels