Edit the jira-config.properties file in Jira server
Purpose
This article covers how to specifically make changes to the jira-config.properties
file located in <jira-home> directory as is also outlined in Advanced JIRA application configuration.
You can also use the jira-config.properties
file to customize Jira Data Center as long as you deployed through the AWS Quick Start. See Use the jira-config.properties file to customize an AWS Quick Start deployment for instructions.
For more information about deploying Jira Data Center through the AWS Quick Start, see Getting started with Jira Data Center on AWS.
Solution
Please note, in new JIRA applications 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:- 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). 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.
Edit the appropriate properties in this file.
- 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. - To override a property's default value in
jpm.xml
(which is not already defined in yourjira-config.properties
file or available on the 'Advanced Settings' page):- Copy the value of the relevant property's
<key/>
element from thejpm.xml
file to thejira-config.properties
file. - In the
jira-config.properties
file, add an '=
' after that property's key, followed by your custom value.
- Copy the value of the relevant property's
- 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.
- To determine the default value of a property whose value you wish to redefine, search for that property in the
- Save your modifications to the
jira-config.properties
file. - Restart your JIRA applications.
In new JIRA application installations, this file may not initially exist and if so, needs to be created manually.
- Shut down your JIRA applications (for example, by executing either the
jira.projectkey.warning = testwarning
jira.projectkey.description = testdescription