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

About the JIRA Configuration Tool

JIRA Configuration Tool is a GUI application that you can run before you start the JIRA Web Server, in order to configure the JIRA Home Directory and the Database Connection.

The application can be run again at a later date, but you must restart JIRA in order to pick up the new settings.

The Configuration Tool is available in JIRA Standalone edition only. People using the WAR edition must still manually change the configuration files.

Starting the Configuration Tool

The JIRA Configuration Tool is a GUI tool only available if you are using JIRA Standalone distribution. If you are running a WAR-EAR distribution of JIRA, or have a text-only connection to the JIRA server, you will need to configure the files manually.

The JIRA Configuration Tool requires that Java be installed and configured on your operating system. We recommend using a Java platform supported by JIRA — refer to JIRA Requirements for details.

The Configuration Tool will display your current configuration settings if any are already set.

(info) Please Note: You may need to set the JAVA_HOME environment variable to run the JIRA Configuration Tool. See Installing Java for details.

Configuring the JIRA Home Directory

Under the 'JIRA Home' tab, you can set the folder that JIRA uses to store various data files. Type the full file path into the text field, or click the 'Browse' button to browse your disk drive(s).

For more details please see Setting Your JIRA Home Directory.

Configuring the Database Connection

Click the 'Database' tab. From the 'Database type' drop-down you can choose your database type.

For details on specifying the settings for different types of databases, please see Connecting JIRA to a Database.

Connection Details

Different databases take slightly different settings in the 'Connection Details' section. For some of these fields, you may be able to leave a blank value indicating to use the 'default value'.

These are the common settings:

  • Hostname — The name or IP address of the server that the DB is installed on.
  • Port — The TCP/IP port that the DB server is listening on. Often you can leave this blank to use the default port number.
  • Username — The user which JIRA will use to connect to the DB server.
  • Password — The password which JIRA will use to authenticate with the DB server.

After typing in your settings, use the 'Test Connection' button to test the connection settings. The tool will attempt to connect to the database, and give a message with the results.

Connection Pool

JIRA keeps a pool of database connections open to the database server. You can set the maximum size of this pool in the 'Pool Size' text field.

Saving your settings

Click 'Save' to save your settings when you are done.

You will need to restart JIRA in order for your new settings to take effect.

  • 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.