Using the JIRA application configuration tool
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 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 recognize these changes.
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.
- Windows: Open a command prompt and run
config.bat
in thebin
sub-directory of the JIRA installation directory. - Linux/Unix: Open a console and execute
config.sh
in thebin
sub-directory of the JIRA installation directory.
This may fail with the error as described in our Unable to Start JIRA applications Config Tool due to No X11 DISPLAY variable was set error KB article. Please refer to it for the workaround.
The JIRA configuration tool can be run with a graphical user interface or via a command-line interface using the -c
or --console
argument. 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.
- Click the JIRA home tab.
- 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.
- Click the 'Save' button. Your changes are saved to the
jira-application.properties
file located in the<jira-application-dir>
subdirectory of your JIRA application 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