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

Skip to end of metadata
Go to start of metadata

JIRA has a number of configuration options that allow your JIRA server to be customised for use within your organisation. These options can be accessed and edited on JIRA's 'General Configuration' page.

Editing JIRA's General Configuration

To access and edit options on the 'General Configuration' page:

  1. Log in as a user with the JIRA Administrators global permission.
  2. Select Administration > System > General Configuration to open the General Configuration page as shown in Screenshot 1 (below).
    (tick) Keyboard shortcut: g + g + start typing general configuration
  3. Scroll to the end of the page and click the Edit Configuration button to edit the three sections as described below:

On this page:

(warning) Some functionality described on this page is restricted in JIRA OnDemand.


Screenshot 1: General Configuration

(info) The Advanced button at the end of the page is only visible if you have the JIRA System Administrators global permission.

Settings

Setting

Description

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.
(info) 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. Self-signup is disabled; only Administrators can create new users.
Default: Public

Maximum Authentication Attempts Allowed

The maximum authentication attempts that are allowed before CAPTCHA is shown to a user. If you leave it blank then CAPTCHA will never be shown and users will have unlimited authentication attempts. It is recommended that you set this to a small number (e.g. below 5).
Default: 3 (for new installations of JIRA)
(info) If you upgrade from a version of JIRA prior to 4.1.1, this option will be reset to 3 for security reasons mentioned in the JIRA 4.1.1 Upgrade Guide.

CAPTCHA on signup

If you are running JIRA in Public mode (see above), it is strongly recommended that you enable CAPTCHA. This will show a CAPTCHA image on signup to prevent spambots from signing up.
Default: ON

Base URL

The base URL of this JIRA installation. (warning) You can only configure JIRA to respond to a single URL and this setting must match the URL that your users request for accessing your JIRA site. You cannot (for example) have a different hostname or URL for internal and external users. This is especially important for JIRA 4.0.x or higher, as any mismatch between this Base URL setting and the URL requested by your JIRA users will cause problems with dashboard gadgets. This URL is also used in outgoing email notifications as the prefix for links to JIRA issues.

Email from

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}'. Note that the actual address (e.g. 'jira@company.com') cannot be specified here - it is determined by the mail server or individual project configuration.

Introduction

A short introduction message displayed on the dashboard. (info) Also see the announcement banner, which is displayed on every JIRA page. You can include HTML, but ensure all tags are correctly closed.

Internationalisation

Setting

Description

Indexing language

JIRA uses Lucene, a high-performance text search engine library, in full-text searches for issues stored in JIRA. This option is designed to enhance JIRA's search indexing and issue searching features for issues entered in the languages available in this list. Hence, choose the language that matches the language used in your issues.

Choosing a specific language in this list has the following effects when conducting searches in JIRA (with respect to your chosen language):

If multiple languages are used in your issues (or you wish to disable the two effects above), choose Other.

(info) You will need to re-index JIRA if you change this value.

Installed languages

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

Default language

The language used throughout the JIRA interface (as selected from the list displayed in Installed Languages above). Users can override the default language by using the Language setting in their user profile.

Default user time zone

This is the time zone used throughout the JIRA interface. Users can override the default language by using the Time Zone setting in their user profile. (To choose the time format see Configuring the Layout and Design.)

(info) Date fields, which have no time component, such as due dates, release dates (associated with versions) and custom date fields, solely record date information (and no time zone-related information) so are not affected by time zone settings.

Options

Setting

Description

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, 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.
Generally you would only turn this ON if you are managing all your users from outside JIRA (e.g. using Crowd, Microsoft Active Directory or another LDAP directory).
Default: OFF

Logout confirmation

Controls whether to obtain user's confirmation when logging out: NEVER COOKIE - prompt for confirmation if the user was automatically logged in (via a cookie). ALWAYS
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

Accept remote API calls

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 users' 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

JQL Auto-complete

Provides auto-completion of search terms when users perform an advanced (JQL) search. Turn OFF if you prefer not to use this feature, or are experiencing a performance impact.
Default: ON

Internet Explorer MIME Sniffing Security Hole Workaround Policy

Attachment viewing security options for cross-site site scripting vulnerabilities present in Internet Explorer 7 and earlier. Changes the default browser action for attachments in JIRA. Options are:
- Insecure: inline display of attachments - allows all attachments to be displayed inline. Only select this option if you fully understand the security risks. See JIRA Security Advisory 2008-08-26 for further details.
- Secure: forced download of all attachments for all browsers - force the download of all attachments. This is the most secure option, but is less convenient for users.
- Work around Internet Explorer security hole - forced download of high-risk attachments (IE-only Workaround) - for IE browsers, force the download of attachments that IE would mistakenly detect as an HTML file. Declared HTML attachments are also never displayed inline. Use this option to reduce the risk of attacks to IE users via attachments.
Default: Work around Internet Explorer security hole

Contact Administrators Form

Provides an email form for users to fill in when they click the 'Contact Administrators' link (which appears when appropriate in JIRA, e.g. on Login panels and pages). Applies only if outgoing email is enabled. Can be used with or without the custom 'Contact Administrators Message' below. Users with the JIRA Administrators global permission (not JIRA System Administrators - see JRA-27454 for details) will be notified as a result of this feature being used.
Default: OFF

Contact Administrators Message

Displays a custom message when users click the 'Contact Administrators' link (which appears when appropriate in JIRA, e.g. on Login panels and pages). The 'Contact Administrators Message' will be displayed at the top of the 'Contact Administrators Form', if the form is enabled (see above), or by itself if the form is not enabled.

Configuring Advanced Settings

JIRA has a small number of commonly edited advanced configuration options, which are stored in the JIRA database. These options can be accessed and edited from the Advanced Settings page.

To access and edit options on the 'Advanced Settings' page:

  1. Log in as a user with the JIRA System Administrators global permission.
  2. Select Administration > System > General Configuration to open the General Configuration page as shown in Screenshot 1 (above).
    (tick) Keyboard shortcut: g + g + start typing general configuration
  3. Click the Advanced button at the end of the General Configuration page to display the Advanced Settings page:
  4. Edit the value of a Key/Property by clicking its value on the right of the page and modifying the existing value.
    (info) Refer to the following Topics for more information about the Keys (above):

    KeyTopic
    jira.attachments.number.of.zip.entriesConfiguring the number of files shown in the content of ZIP-format files on issues
    jira.clone.prefixConfiguring the cloned issue summary field prefix

    jira.date.picker.java.format
    jira.date.picker.javascript.format
    jira.date.time.picker.java.format
    jira.date.time.picker.javascript.format

    Configuring date picker formats
    jira.issue.actions.orderChanging the Default Order for Comments from Ascending to Descending
    jira.projectkey.patternConfiguring Project Keys
    jira.table.cols.subtasksConfiguring sub-task fields displayed on parent issues
    jira.view.issue.links.sort.orderConfiguring the order of linked issues displayed on the 'view issue' page
  5. Click the Update button (which will appear in the Operations column on the right) to save the new value in the JIRA database.
    (info) Please Note:
    • Any changes you make to these properties/keys become effective immediately.
    • Click the General Settings button to return to the General Configuration page.

See Also

There are a handful of other advanced configuration options (which are of little interest to most JIRA system administrators) whose default values can be customised in the jira-config.properties file located in the JIRA Home Directory, which you may want to edit. For details, please see Advanced JIRA configuration.