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

Skip to end of metadata
Go to start of metadata

On this page:

JIRA Installation Directory

The 'JIRA Installation Directory' is the directory into which the JIRA application files and libraries have been extracted, either:
  • by the Windows or Linux installers, or
  • by extracting the contents of a JIRA Standalone or WAR distribution installation archive file (i.e. a .tar.gz or .zip file).

JIRA does not modify or store any data in this directory.

Important Files and Directories

Icon

The directories/files described below are found under different sub-directories of the 'JIRA Installation directory', depending on whether you have installed JIRA Standalone or JIRA WAR. Please substitute the following directories for the <jira-application-dir> placeholder below, as follows:

  • JIRA Standaloneatlassian-jira subdirectory of the 'JIRA Installation directory'.
  • JIRA WARwebapp subdirectory of the 'JIRA Installation directory'.
    (info) Please Note: To edit files in this webapp directory, first copy them to the edit-webapp subdirectory (if they are not already present in edit-webapp) and edit the copies in edit-webapp. Refer to the 'Webapp Layout' section of the JIRA WAR Configuration Overview for details. Copies of the jira-application.properties and entityengine.xml file are already available in the edit-webapp sub-directory.

<jira-application-dir>/WEB-INF/classes/jira-application.properties

This file tells JIRA where to find the JIRA Home Directory.
(warning) Be aware that your JIRA Home Directory defined in this file can be overridden. See Setting your JIRA Home Directory for more information.

<jira-application-dir>/WEB-INF/classes/jpm.xml

This file stores the default values for JIRA's advanced configuration settings and should not be modified. The default values of properties in this file are customised (i.e. overridden) by redefining them in either the jira-config.properties file (in your JIRA Home Directory) or the JIRA database (via the JIRA administration area). See Advanced JIRA Configuration for more information.

<jira-application-dir>/WEB-INF/lib/

This is the directory where plugins built on Atlassian's Plugin Framework 1 (i.e. 'Plugins 1' plugins) are stored. If you are installing a new 'Plugins 1' plugin, you will need to deploy it into this directory.
'Plugins 2' plugins should be stored in the JIRA Home directory.

<jira-application-dir>/WEB-INF/classes/log4j.properties

JIRA's logging configuration file. See Logging and Profiling.

The actual log files generated by JIRA can be found in the following locations:

  • JIRA application logbin/atlassian-jira.log
  • Application server log — generally the application server log file can be found under the logs directory. However, this can vary depending on the application server you are running. Please see Where are the application server logs? for further details.

<jira-application-dir>/WEB-INF/classes/entityengine.xml

This file configures the OFBiz Entity Engine which JIRA uses to store persist data in a datasource. See Configuring the Entity Engine for JIRA.

Icon

The sub-directories/files described below are found under the root of the JIRA Installation directory.

conf/server.xml

This file is used for JIRA SSL configuration. See Running JIRA over SSL or HTTPS.

Memory Settings

The file used to edit JAVA_OPTS memory settings will depend on the method used to install JIRA, as well as the operating system used for your installation.

For example, if you are running JIRA on Tomcat in Windows (manual startup), you would update the following file:
bin\setenv.bat
whereas for JIRA on Tomcat in Linux/Unix, you would update this file:
bin/setenv.sh

See Increasing JIRA Memory for further details.

JIRA Home Directory

The 'JIRA Home Directory' contains key data that help define how JIRA works. This document outlines the purpose of the various files and subdirectories within the JIRA Home Directory.

If JIRA was installed using the automated Windows or Linux installers, the default location of the JIRA Home Directory is:

  • C:\Program Files\Atlassian\Application Data\JIRA (on Windows) or
  • /var/atlassian/application-data/jira (on Linux)

If you install JIRA from an archive file, the JIRA Home Directory can be any suitable location that is accessible by your JIRA installation. Typical example locations might be:

  • C:\jira\home (on Windows) or
  • /var/jira-home (on Linux or Solaris)

(warning) However, avoid locating the JIRA Home Directory inside the JIRA Installation Directory.

(tick) For information on specifying the location of the JIRA Home Directory, please see Setting your JIRA Home Directory.

Important Files

dbconfig.xml

This file (located at the root of your JIRA Home Directory) defines all details for JIRA's database connection. This file is typically created by running the JIRA Setup Wizard on new installations of JIRA or by configuring a database connection using the JIRA Configuration Tool.

You can also create your own dbconfig.xml file. This is useful if you need to specify additional parameters for your specific database configuration, which are not generated by the Setup Wizard or JIRA Configuration Tool. For more information, refer to the 'manual' connection instructions of the appropriate database configuration guide in the Connecting JIRA to a Database section.

jira-config.properties

This file (also located at the root of your JIRA Home Directory) stores custom values for most of JIRA's advanced configuration settings. Properties defined in this file override the default values defined in the jpm.xml file (located in your JIRA Installation Directory). See Advanced JIRA Configuration for more information.

(info) In new JIRA installations, this file may not initially exist and if so, will need to be created manually. See  Making changes to the jira-config.properties file for more information. This file is typically present in JIRA installations upgraded from version 4.3 or earlier, whose advanced configuration options had been customised (from their default values).

Important Subdirectories

data

This directory contains application data for your JIRA instance, including attachments (for every version of each attachment stored in JIRA).

export

JIRA will place its automated backup archives into this directory.

log

JIRA will place its logs into this directory. (Note: if the JIRA home directory is not configured, then the logs will be placed into the current working directory instead).

The logs will only start showing up once the first log message is written to them. For example, the internal access log will not be created util JIRA starts writing to it.

You can change the location of the log file using log4j.properties as described in the documentation on Logging and Profiling.

plugins

This is the directory where plugins built on Atlassian's Plugin Framework 2 (i.e. 'Plugins 2' plugins) are stored. If you are installing a new 'Plugins 2' plugin, you will need to deploy it into this directory under the installed-plugins sub-directory.

'Plugins 1' plugins should be stored in the JIRA Installation Directory.

This directory is created on JIRA startup, if it does not exist already.

caches

This is where JIRA stores caches including:

These files are vital for JIRA performance and should not be modified or removed externally while JIRA is running.

(info) Note:

See Search Indexing for further details.

tmp

Any temporary content created for various runtime functions such as exporting, importing, file upload and indexing is stored under this directory.

You can remove files from this directory while JIRA is running, but we recommend that you shut down JIRA first before altering the contents of this directory.