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

About the JIRA Configuration Tool

The JIRA Configuration Tool is an application (included with all JIRA distributions except JIRA WAR) that offers server-level JIRA configuration through a convenient GUI. This tool allows you to do the following:

Please Note:

  • The JIRA Configuration Tool requires a Java platform to be installed and configured on your operating system. If you need to install a Java platform to run this tool, we recommend using a Java platform supported by JIRA — refer to JIRA Requirements for details.
  • If you use the JIRA WAR distribution or have a console-only connection to your JIRA server, you will need to perform these server-level configurations manually.
  • Whenever you configure or reconfigure JIRA's server-level settings using this tool, JIRA must be restarted so it can recognise these changes.

On this page:

Starting the JIRA Configuration Tool

The JAVA_HOME environment variable must be set to use the JIRA configuration tool. If it has not been set already, follow the instructions in Installing Java to set it.

To start the JIRA configuration tool:

The JIRA configuration tool can be run with a graphical user interface or via a command-line interface. The following sections show the graphical user interface, but the functionality is the same regardless of the interface.

Configuring the JIRA Home Directory

Your JIRA Home Directory allows you to set the folder that JIRA uses to store its various data files.

To set your JIRA Home Directory using the JIRA Configuration Tool:

  1. Click the JIRA Home tab.
  2. In the JIRA Home Directory field, type the full file path into the text field, or click the Browse button to browse for the location of your JIRA Home Directory.
  3. Click the 'Save' button. Your changes are saved to the jira-application.properties file located in the <jira-application-dir> subdirectory of your JIRA Installation Directory. For more information, please see Setting your JIRA Home Directory.

Screenshot: JIRA configuration tool — 'JIRA Home' tab

Configuring the database connection

To configure JIRA's database connection using the JIRA configuration tool, follow the appropriate procedure for your database type:

Screenshot: JIRA configuration tool — 'Database' tab

Configuring JIRA's web server

The JIRA configuration tool can also be used to configure JIRA's web server, specifically the TCP ports and the SSL configuration. Follow the relevant instructions linked below:

Screenshot: JIRA configuration tool — 'Web Server' tab

Tuning JIRA's database connections

For more information about the functionality of the Advanced tab, see Tuning Database Connections.

Screenshot: JIRA configuration tool — 'Advanced' tab

Running in command line mode

To run the config tool in command line mode, use the -c or --console arguments 
In linux, config.sh -c or config.sh --console
In windows, config.bat -c or config.bat --console 
You will be presented with the following menu:


The menu options can be accessed and values provided via the command line.
  • No labels



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.