JIRA
Install
Admin
Use
Search JIRA documentation:

Configuring JIRA

PDF
PDF

JIRA has a number of configuration options that allow the system to be customised for use within your organisation.

To manage your JIRA configuration:

  1. Log in as a user with the 'JIRA Administrators' global permission.
  2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard:

    Link to Administration sectionLink to Administration section

  3. On the panel on the left, under the title 'Global Settings', click on the link labelled 'General Configuration'.
  4. The following screen will be displayed. Click 'Edit Configuration' to edit the three sections as described below.
Screenshot of JIRA configuration settings and options

Settings

SettingDescription
Title This is the title that will be displayed on the JIRA login page and the dashboard. It helps identify your installation and its purpose. (Note: also see logo, which is displayed on every JIRA page.)
Mode

JIRA can operate in two modes:

Public Anyone can sign themselves up and create issues (within the bounds of your JIRA system's permissions).
Private Useful for internal issue-tracking systems where you do not want public users to login. Signup is disabled; only Administrators can create new users.

Default: Public

CAPTCHA on signup

If you are running JIRA in Public mode (see above), it is strongly recommended that you enable Captcha.

Default: ON

Base URL

This is the base URL of this JIRA installation.

It is used in outgoing email notifications to construct valid links to JIRA issues.

Email From Header

Specifies the From: header format in notification emails. Default is of the form "John Doe (JIRA) <jira@company.com>". Available variables are $'{fullname'}, $'{email'} and $'{email.hostname'}.

Introduction

A short introduction message displayed on the dashboard. (Note: also see the announcement banner, which is displayed on every JIRA page.)

It is possible to include HTML, but ensure all tags are correctly closed and that the HTML is well formed.

Internationalisation

SettingDescription
Character encoding

The character encoding for input and viewing of information within JIRA. For most western languages, the default ("UTF-8") is suitable.

If you change this setting, ensure that you also change your database's encoding.

View a list of supported encodings. However, please use the IANA preferred MIME name (such as 'iso-8859-1' instead of 'ISO8859_1') to ensure XML backups have the correct encoding string.

Indexing language

JIRA uses Lucene, a high-performance text search engine library, in full-text searches over the information stored in JIRA.

This option should be set to the language in which information is entered into JIRA. It is necessary to re-index JIRA if this value is changed.

Installed languages This section lists all language packs available within the JIRA system. (Note: to install additional languages, see Internationalisation.)
Default language

This is the language used throughout the JIRA interface (as selected from the list displayed in Installed Languages above).

Users override this language by using the Locale setting in their user profile.

Options

SettingDescription
Allow users to vote on issues

Controls whether voting is enabled in JIRA. Voting allows users to indicate a preference for issues they would like to be completed or resolved. See also the 'View Voters and Watchers' permission.

Default: ON

Allow users to watch issues

Controls whether watching is enabled in JIRA. Users can 'watch' issues which they are interested in. Users watching an issue will be notified of all changes to it. See also the 'View Voters and Watchers' and 'Manage Watcher List' permissions.

Default: ON

Allow unassigned issues

When turned ON, JIRA will allow issues to be unassigned or assigned to 'no-one'.

When turned OFF, issues must always be assigned to someone - by default, the assignee will be the Project Lead as defined for each project.

Default: OFF

External user management

When turned ON, JIRA will assume that you are managing users from outside JIRA (e.g. using Crowd). This means that you will no longer be able to create, edit or delete users/groups from within JIRA (or via email or import); but you can still assign users/groups to project roles, and create/edit/delete user properties.

Additionally, JIRA will not display options for users to change their password, or edit their profile.

Note: JIRA's LDAP integration is currently limited to external password management, so this option should be left OFF when using LDAP.

Default: OFF

External password management

When turned ON, JIRA will assume that you are managing passwords from outside JIRA. JIRA will not display options for users to change their password, or display the 'Forgot Password' link on the login screen.

Note: With the default osuser LDAP provider, this option should be turned ON, as accounts are not yet stored in LDAP and this option only hides the password features within JIRA.

Default: OFF

Logout confirmation

Controls whether to obtain user's confirmation when logging out.

cookie means prompt for confirmation if the user was automatically logged in (via a cookie).

Default: NEVER

Use GZip compression

Controls whether to compress the web pages that JIRA sends to the browser. It is recommended that this be turned ON, unless you are using mod_proxy.

Default: OFF

Allow remote API access

Controls whether to allow remote client access (via XML-RPC or SOAP) to this JIRA installation for authenticated users.

Default: OFF

User email visibility

Controls how user email addresses are displayed in the user profile page.

PUBLIC — email addresses are visible to all.

HIDDEN — email addresses are hidden from all users.

MASKED — the email address is masked (e.g. 'user@example.com' is displayed as 'user at example dot com').

LOGGED IN USERS ONLY — only users logged in to JIRA can view the email addresses

Default: PUBLIC

Comment visibility

Determines what will be contained in the list that is presented to users when specifying comment visibility and worklog visibility.

Groups & Project Roles — the list will contain groups and project roles.

Project Roles only — the list will only contain project roles.

Default: Project Roles only

Exclude email header 'Precedence: bulk'

Controls whether to prevent the Precedence: Bulk header on JIRA notification emails. This option should only be enabled when notifications go to a mailing list which rejects 'bulk' emails. In normal circumstances, this header prevents auto-replies (and hence potential mail loops).

Default: OFF

Issue Picker Auto-complete

Provides auto-completion of issue keys in the 'Issue Picker' popup screen. Turn OFF if your users' browsers are incompatible with AJAX.

Default: ON

User Picker Auto-complete

Provides auto-completion of user names in the 'User Picker' popup screen. Turn OFF if you have a very large number of users, or if your users' browsers are incompatible with AJAX.

Note: If 'User email visibility' (see above) is set to HIDDEN, the users' email addresses will not be searched or shown in the auto-complete results.

Default: ON if you have less than 5,000 users (or OFF if you have more than 5,000 users).

Advanced properties

There are a handful of other properties (usually storing defaults of little interest to most JIRA users) in the WEB-INF/classes/jira-application.properties file, which you may want to edit.