This page last changed on May 28, 2009 by alui.

On this page:

JIRA Installation Directory

The 'JIRA installation directory' is the directory into which the JIRA application files and libraries have been unpacked (unzipped) when JIRA was installed. JIRA does not modify or store any data in this directory.

Important Files and Directories

The directories/files described below are found under the different sub-directories of the JIRA Installation directory, depending on whether you have installed JIRA Standalone or JIRA EAR/WAR. Please substitute the following directories for the <install-dir> placeholder below, as follows:
  • JIRA Standaloneatlassian-jira subdirectory
  • JIRA EAR/WARwebapp subdirectory (please note, if you want to edit any files in the webapp directory you will need to copy them to the edit-webapp subdirectory and edit the copies as described in JIRA WAR-EAR Configuration Overview. Copies of the jira-application.properties and entityengine.xml file are already available in the edit-webapp sub-directory).

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

This file tells JIRA where to find the JIRA Home Directory, as well as storing many other configuration settings . This file is modified by the administrator when Installing JIRA Standalone (not using Windows installer) or Installing JIRA WAR-EAR.

<install-dir>/WEB-INF/classes/osuser.xml

This file is modified when connecting JIRA to an external user management system such as an LDAP server or Atlassian's Crowd. For more information, refer to User and Group Management.

<install-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.

<install-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.

<install-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.

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 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 subdirectories and files within the JIRA home directory. (For information on specifying the location of the JIRA home directory, please see Setting your JIRA Home Directory .)

Tip: Another term for 'home directory' would be 'data directory'.

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:

  • Lucene indexes - see [JIRAKB:Indexing in JIRA]
  • OSGi framework caches

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

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.

Related Topics

Document generated by Confluence on Mar 27, 2011 18:49