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

JIRA has a number of advanced configuration options, each of which is defined as an individual property (or 'key') associated with a value. These key-value pairs are stored in one of three areas for use by JIRA:

The JIRA Database

The values of a small number of most commonly edited advanced configuration options are stored in the JIRA database. These values can be edited from the 'Advanced Settings' page of JIRA's administration area (accessed from the 'System' > 'General Configuration' menu > 'Advanced' button). Once any of these properties' values are changed, they become effective immediately. See Configuring Advanced Settings for details.

The jira-config.properties file

Custom values for JIRA's remaining advanced configuration options (i.e. not stored in the JIRA database) are stored as individual key-value pairs in a file calledjira-config.properties (located in the JIRA Home Directory). Typically, these options are of little interest to most JIRA system administrators. While these key-value pairs can be edited, JIRA must be restarted for any changed values to take effect. 

(info) In new JIRA installations, this file may not initially exist and if so, needs to be created manually.

The jpm.xml file

Default values for all* of JIRA's available advanced configuration options are stored in a file called jpm.xml (located in the <jira-application-dir>/WEB-INF/classes subdirectory of the JIRA Installation Directory). These default values are only used by JIRA if a property's value has not already been customised in either the JIRA database (via JIRA's 'Advanced Settings' page) or the jira-config.properties file.

(warning) The jpm.xml file should not be edited. To change an existing property's value for use by JIRA, override it by redefining that property in either:

    • The JIRA database (via JIRA's 'Advanced Settings' page).
      OR
    • The jira-config.properties file.

* JIRA recognises a small number of properties, which can be set in your jira-config.properties file but have no definition in the jpm.xml file. These properties:

    • typically represent advanced configuration options that are disabled when they are not defined in your jira-config.properties file and
    • when not specified in your jira-config.properties file, typically affect JIRA's behaviour differently to when they are defined in your jira-config.properties file with no value.

(warning) The information on this page does not apply to JIRA OnDemand.

Making changes to the jira-config.properties file

To make changes to the jira-config.properties file:

  1. Shut down JIRA (for example, by executing either the /bin/stop-jira.sh or \bin\stop-jira.bat file in your JIRA Installation Directory, or by stopping the JIRA service).
  2. Open the jira-config.properties file (located at the root of your JIRA Home Directory) in a text editor.
    (warning) This file may not exist if you are using a new JIRA installation or your existing JIRA installation was not customised after upgrading JIRA. If this file does not exist, create it using a text editor.
  3. Edit the appropriate properties in this file.
    (tick) Editing tips:
    • To determine the default value of a property whose value you wish to redefine, search for that property in the <jira-application-dir>/WEB-INF/classes/jpm.xml file (of your JIRA Installation Directory). The default value is defined in the <default-value/> sibling element of the relevant property's <key/> element.
    • To override a property's default value in jpm.xml (which is not already defined in your jira-config.properties file or available on the 'Advanced Settings' page):
      1. Copy the value of the relevant property's <key/> element from the jpm.xml file to the jira-config.properties file.
      2. In the jira-config.properties file, add an '=' after that property's key, followed by your custom value.
    • To disable a custom property's value in the jira-config.properties file, either 'comment out' the property with a preceding '#' symbol or remove the property from the file.
  4. Save your modifications to the jira-config.properties file.
  5. Restart JIRA.

See also

Setting Properties and Options on Startup — for changes like setting available memory, disabling email, enabling Jelly, etc.



See our Getting Help page for details.



Raise an issue for our developers.



See answers from the community.



Tweet, blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.