How to Edit the jira-config.properties File in Jira Data Center

Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.

Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Summary

This article covers how to specifically make changes to the jira-config.properties file located in the Jira HOME directory, as is also outlined in Advanced Jira application configuration.

Solution

You can also use the jira-config.properties file to customize Jira Data Center as long as you deployed it through the AWS Quick Start. See Use the jira-config.properties file to customize an AWS Quick Start deployment for instructions.

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 (Windows) /var/atlassian/application-data/JIRA (Linux)

You can also find the location of the Jira HOME directory by navigating to Administration ⚙ > System > System Info and looking for the File Paths section.

Please note that in new JIRA application installations, this file may not exist, so it will have to be created.

  • Custom values for remaining advanced configuration options (i.e. not stored in the Jira application database) are stored as individual key-value pairs in a file called jira-config.properties (located in the Jira application home directory).

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

    1. Shut down your Jira applications (for example, by executing either the /bin/stop-jira.sh or \bin\stop-jira.bat file in your Jira applications Installation directory, or by stopping the JIRA application service).

    2. Open the jira-config.properties file (located at the root of your Jira application home directory) in a text editor.

      This file may not exist if you are using a new installation or an upgraded installation where your previous JIRA application versions had never been customized. If this file does not exist, create it using a text editor.

    3. Edit the appropriate properties in this file.

      1. To determine the default value of a property whose value you wish to redefine, search for that property in the jpm.xml file, which is located in the atlassian-jira/WEB-INF/classes subdirectory of your Jira Installation Directory. The default value is defined in the <default-value/> sibling element of the relevant property's <key/> element.

      2. 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):

        • Copy the value of the relevant property's <key/> element from the jpm.xml file to the jira-config.properties file.

        • In the jira-config.properties file, add an '=' after that property's key, followed by your custom value.

      3. 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 your Jira applications.

    In new Jira application installations, this file may not initially exist and if so, needs to be created manually.

Example contents to demonstrate format

jira.projectkey.warning = testwarning jira.projectkey.description = testdescription
Updated on May 22, 2025
Platform
Data Center only
Product
Jira Software Data Center
On this pageSummarySolution

Still need help?

The Atlassian Community is here for you.
Ask the Community