Advanced JIRA application configuration

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. To access the values for editing, see Configuring JIRA options.

Once any of these properties' values are changed, they become effective immediately.

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 called jira-config.properties (located in the JIRA application 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.

Example contents to demonstrate format
jira.projectkey.warning = testwarning
jira.projectkey.description = testdescription

(info) In new JIRA installations, this file may not initially exist and if so, needs to be created manually. For more information about editing the jira-config.properties file, see How to edit the jira-config.properties file.

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 application installation directory). These default values are only used by JIRA if a property's value has not already been customized 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 because any values that you customize in it will not be migrated automatically during subsequent JIRA upgrades. To change the value of a property for an advanced configuration option in JIRA, override the value of this property by redefining it in either:

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

* JIRA recognizes 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 behavior differently to when they are specified in your jira-config.properties file with no value.

Making 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 application installation directory, or by stopping the JIRA service).
  2. Open the jira-config.properties file (located at the root of your JIRA application home directory) in a text editor.
    (warning) This file may not exist if you are using a new JIRA installation or an upgraded JIRA installation where your previous JIRA version(s) had never been customized. 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, etc.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport