Documentation for JIRA 5.1.x. Documentation for other versions of JIRA is available too.

JIRA 101

Thank you for choosing JIRA to track your projects and issues. To help you get up and running quickly, we've compiled some easy instructions for configuring and using JIRA 5.0.

Getting started

1. Installing JIRA

First things first. If you haven't already got JIRA up and running, carry out the following steps:
  1. Download the appropriate JIRA Windows Installer (.exe) file (which matches the 'bit' version of your Windows operating system) from the JIRA download page.
  2. Run the '.exe' file, choose an installation directory, a home directory and a port ('8080' will do). We recommend that you choose to 'Run JIRA as a service'.
  3. To access JIRA, go to your web browser and type this address: http://localhost:8080. Windows 'Start' menu shortcuts will also be added which you can also use to start and stop JIRA.
  4. Follow the Setup Wizard. This will guide you through the process of setting up your JIRA server, creating an Administrator user and (optionally) setting up email.

For more help on the technical procedures in this section, see the JIRA Installation Guide.

If you need assistance, please create a support ticket.

(warning) Before using JIRA as a production system, ensure that you have configured JIRA to use a supported database other than JIRA's internal HSQL database (which is provided for evaluation purposes only). Please see the documentation for details.

  1. Download the appropriate Linux Installer (.bin) file (which matches the 'bit' version of your Linux operating system) from the JIRA download page.
  2. Open a console as the 'root' user (e.g. open a shell and enter the command 'su root').
  3. Execute the '.bin' file, choose an installation directory, a home directory and a port ('8080' will do). (If you execute the '.bin' file with 'root' user privileges, JIRA will be installed as a service and will run under a dedicated 'jira' user account.)
  4. To access JIRA, go to your web browser and type this address: http://localhost:8080.
  5. Follow the Setup Wizard. This will guide you through the process of setting up your JIRA server, creating an Administrator user and (optionally) setting up email.

For more help on the technical procedures in this section, see the JIRA Installation Guide.

If you need assistance, please create a support ticket.

(warning) Before using JIRA as a production system, ensure that you have configured JIRA to use a supported database other than JIRA's internal HSQL database (which is provided for evaluation purposes only). Please see the documentation for details.

(warning) JIRA running on Mac OS X is supported for evaluation purposes only.

  1. Download the JIRA Standalone (tar.gz) file from the JIRA download page and extract it.
  2. Edit the jira-application.properties file in the JIRA Installation Directory, add a 'jira.home' property and set it to your desired location for the JIRA home directory. Please use forward-slashes ("/"), not back-slashes ("\").
  3. Run bin/start-jira.sh to start JIRA.
  4. To access JIRA, go to your web browser and type this address: http://localhost:8080.
  5. Follow the Setup Wizard. This will guide you through the process of setting up your JIRA server, creating an Administrator user and (optionally) setting up email.

For more help on the technical procedures in this section, see the JIRA Installation Guide.

If you need assistance, please create a support ticket.

2. Adding users

  1. Click Administration in the top navigation bar.
  2. Select Users > Users from the top menu, then click Create User.
  3. Enter the Username, Password, Full Name and Email; and (optionally) tick the box to send the user an email containing their account details. Then click the Create button. For more details, please see the documentation.
  4. The Users screen will open and display the details for the new user. If the user is going to need to work on issues, click the Edit Groups link at the bottom of the screen to add them to the appropriate group. (If the user is only going to log issues, and not work on them, then they do not need to belong to the 'jira-developers' group and you can skip to the next task.) For more about groups, please see the documentation.
  5. On the Edit User Groups screen, select the jira-developers group and click the Join button. 
    (info) Adding your users to the jira-developers group will automatically add them to the Default Members for the 'Developers' project role. For more about project roles, please see the documentation.

You may want to suggest to your users that they take a look at 'Mastering the Basics' (below). You may also want to point them to the documentation on:

(info) Your users will need to access JIRA at http://<JIRA machine name>:8080 (not http://localhost:8080).

3. Creating a project

  1. Click Administration in the top navigation bar.
  2. Select Projects > Projects from the top menu, then click Add Project.
  3. In the Name field, type a descriptive name for your project (typically two or three words, e.g. Purchase Orders).
  4. In the Key field, type a meaningful prefix for issues in your project (typically three or four characters, e.g. ORD).
    (info) Be aware that you cannot subsequently change this in JIRA.
  5. In the Project Lead field, select the user to whom issues should be assigned by default.
  6. If you chose to set up email when you installed JIRA (see above), change the Notification Scheme field from None to Default Notification Scheme. This will allow JIRA to automatically send emails to appropriate people when particular events occur (e.g. 'Issue Created', 'Issue Resolved'). For more about email, please see the documentation.
  7. Leave the rest of the fields with their default values for now. Click the Add button.

Mastering the basics

4. Creating an issue

  1. Click the Create Issue link in the top navigation-bar. (If you're still in Administration mode click Exit Administration first.)
  2. Select the relevant Project and Issue Type.
  3. Type a short description of the issue in the Summary field, then click the Create button.

For more details, please see the documentation.

5. Logging work on an issue

  1. Go to the issue and select More Actions > Log Work.
  2. In the Time Spent field, enter the amount of time to be logged. Use 'w', 'd', 'h' and 'm' to specify weeks, days, hours or minutes (e.g. to enter two hours of work, type '2h').
  3. In the Work Description field, type a description or comment about the work you have done.
  4. Click the Log button.

For more details about the other options on this screen, please see the documentation.

6. Resolving an issue

  1. Go to the issue, and click the Resolve Issue button at the top of the issue details.
  2. In the 'Resolution' field, select the Resolution that best describes the outcome (e.g. 'Fixed').
  3. (Optional) In the 'Comment' field, type a description or comment about the issue's resolution.
  4. Click the Resolve button.

For more information about how an issue moves from one Status to another, please see the documentation.

7. Searching for issues

  • Use the box in the top right corner of every page to quickly search JIRA. You can type an issue key (e.g. TEST-1234) to jump directly to an issue, or use syntax like my open issues to immediately return all issues which are assigned to you and haven't yet been resolved.
  1. Click Issues on the top navigation bar to display JIRA's searching and filtering panel.
  2. Select the Project, Issue Type, or any other issue attributes of interest. You can also perform comprehensive text searches.
  1. Click Issues on the top navigation bar, then click advanced to display the JQL (JIRA Query Language) panel.
  2. Type your query (e.g. 'project=TEST') and click the Search button.

See the documentation for more information about saving your searches ('issue filters') and receiving search results via email.

8. Charting, reporting and exporting

  1. View your search results (see 'Searching' above) in the Issue Navigator.
  2. Click Views > Charts.
  3. Choose your preferred type of chart, and enter any required configuration details. For more details, please see the documentation.
  1. Click Projects in the top navigation bar.
  2. Select the project you are interested in.
  3. Click Reports at the right of the screen and select the report of interest.
  4. Enter any required configuration details, then click Next to display your report (e.g. Workload Pie Chart Report).
  1. View your search results (see 'Searching' above) in the Issue Navigator.
  2. Click the Views -> Word, Excel, or your preferred format. For more details, please see the documentation.

Customising JIRA

(Note that you need to be an Administrator to do the tasks in this section.)

You may want to create a sample project named 'Purchase Orders', in which to perform the tasks described in this section. For instructions, please see 'Creating a Project' (above).

9. Adding a new issue type

The Issue Type is one of the first things a user must choose when they create an issue. Depending on how your organisation is using JIRA, you might want to add a new Issue Type. For example, if you are using JIRA to track purchase orders, the default Issue Types ('Bug', 'Improvement', 'New Feature', 'Task') might not be relevant. So you might want to add a new Issue Type called 'Order'.

Issue type schemes let you control which issue types are available in specific projects. For example, you might want some issue types to only be available in administrative projects like purchase orders and equipment requests.

To add a new Issue Type called 'Order' and associate it with a project called 'Purchase Orders':

  1. Click Administration in the top navigation bar.
  2. Select Issues > Issue Types.
  3. Click the Add Issue Type button.
  4. In the Name field, type 'Order.' In the Description field, type 'A purchase order'. Then click the Add button. (For more about adding Issue Types, please see the documentation.)
  5. Click the Issue Types Scheme tab on the left of the 'Issue Types' screen. (For more about Issue Type Schemes, please see the documentation.)
  6. Click the Add Issue Type Scheme button.
  7. In the 'Add Issue Type Scheme' form, in the 'Scheme Name' field, type 'Purchase Order Issue Type Scheme'.
  8. In the 'Available Issue Types' list, click the Issue Type called 'Order' and drag it into the 'Issue Types for Current Scheme' list.
  9. Click the Save button.
  10. On the 'Issue Type Schemes' window, click Associate in the 'Purchase Order Issue Type Scheme' row.
  11. In the Projects box, click 'Purchase Orders,' then click the Associate button.

To test what you have done, create an issue in the 'Purchase Orders' project. The only available Issue Type should be 'Order'.

10. Adding a new screen

Depending on how your organisation is using JIRA, you might want to add a purpose-built screen that will be displayed for particular types of issues, or for particular projects or workflows.
For example, if you are using JIRA to track purchase orders, some of the normal issue fields (e.g. 'Affects Version', 'Fix Version', 'Environment') might not be relevant. So you might want to create a simplified screen that omits these fields.

To add a new Screen called 'Purchase Order Screen', and associate it with a project called 'Purchase Orders':

  1. Click Administration in the top navigation bar.
  2. Select Issues > Screens.
  3. Click the Copy link next to 'Default Screen'.
  4. In the Name field, type 'Purchase Order Screen'. Then click the Copy button. (For more about Screens, please see the documentation.)
  5. Click the Configure link next to 'Purchase Order Screen'.
  6. Select the Remove checkbox for the following fields: 'Affects Version', 'Fix Version', 'Environment'. Then click the Remove button.
  7. Click the Screen Schemes tab in the left navigation column.
  8. Click the Add Screen Scheme button.
  9. In the Name field, type 'Purchase Order Screen Scheme'. From the Default Screen dropdown, select 'Purchase Order Screen'. Then click the Add button. (For more about Screen Schemes, please see the documentation.)
  10. Click the Issue Type Screen Schemes tab in the left navigation column.
  11. Click the Add Issue Type Screen Scheme button.
  12. In the Name field, type 'Purchase Order Issue Type Screen Scheme'. From the Screen Scheme dropdown, select 'Purchase Order Screen Scheme'. Then click the Add button. (For more about Issue Type Screen Schemes, please see the documentation.)
  13. Click Projects > Purchase Orders in the top navigation bar. The project details will be displayed.
  14. Click the Screens tab in the left navigation column.
  15. On the 'Purchase Order Issue Type Screen Scheme' screen, click Actions > Use a different scheme. 
  16. On the 'Type Screen Scheme Association' screen, select 'Purchase Order Issue Type Screen Scheme' from the Scheme dropdown. Then click the Associate button.

To test what you have done, view an issue in the 'Purchase Orders' project. You shouldn't see the Affects Version, Fix Version or Environment fields.

11. Adding a new custom field

Depending on how your organisation is using JIRA, you might need to add a custom field that will be displayed for particular types of issues, or for particular projects. Adding custom fields allows you to include that information in reports and to track that information like other data in JIRA. For example, if you are using JIRA to track purchase orders, you might create a custom field called Supplier.

To create a new custom field called Supplier and put it on the 'Purchase Order Screen':

  1. Click Administration in the top navigation bar.
  2. Select Issues > Fields.
  3. Click the Add Custom Field button.
  4. On the 'Create Custom Field: Choose the field type' screen, select the Select List radio button. Then click the Next button.
  5. On the 'Create Custom Field - Details' screen:
    1. In the Field Name field, type 'Supplier'.
    2. In the Description field, type 'Choose the supplier for this Purchase Order'.
    3. Under 'Choose applicable issue types' select Order. Then click the Finish button.
  6. On the 'Associate field Supplier to screens' screen, select the Purchase Order Screen checkbox. Then click the Update button.
  7. On the 'Custom Fields' screen, click the cog in the Supplier row. Then click Configure.
  8. Click the Edit Options link in the 'Default Configuration Scheme for Supplier' section.
  9. In the Add Value box, enter 'ABC Pty Ltd,' then click Add. 
  10. Repeat that step to add 'ACME Pty Ltd' and 'XYZ Pty Ltd' as other options.
  11. Use the arrows in the Order column to move 'ACME Pty Ltd' to the top of the list.
  12. Click the Done button.

To test what you have done, create an issue in the 'Purchase Orders' project. You should see a field called Supplier that has a dropdown box containing the three options you set up.

12. Adding a new issue status and workflow

Depending on how your organisation is using JIRA, you might need to add a new step in the issue 'workflow'. A step in the workflow is called a status. For example, if you are using JIRA to track purchase orders, you might add a new Status called 'Purchase Approved.'

You can also create new workflows to accommodate the way a specific process works. To do this, you first create a workflow (often this is easiest to do by copying an existing workflow similar to the one you need). After setting up the workflow, you then activate it so that any issue types affected by the workflow can be updated to use the new workflow.

To add a new Status called 'Purchase Approved', and create a new workflow that has an extra step between 'Open' and 'In Progress':

  1. Click Administration in the top navigation bar.
  2. Click Issues > Statuses.
  3. In the 'Add New Status' section, type 'Purchase Approved' in the Name field.
  4. Click the Add button. The new status will appear in the list of status types in the 'View Statuses' section.
  5. Click Issues > Workflows in the top navigation bar. (For more about Workflow, please see the documentation.)
  6. Click the Copy link next to 'jira (Read-only System Workflow)'.
  7. In the Workflow Name field, type 'Purchase Order Workflow'. Change the Description to 'Workflow for system purchase orders.'
  8. Click the Copy button.
  9. Click the Text button on the 'Purchse Order Workflow' screen.
  10. In the 'Add New Step' form:
    1. In the Step Name field, type 'Purchase Approved'.
    2. In the Linked Status field, select 'Purchase Approved'.
    3. Click the Add button.
  11. Click the Add Transition link next to Open:
    1. In the Transition Name field, type 'Approve Purchase'.
    2. In the Destination Step field, select 'Purchase Approved'.
    3. Click the Add button.
  12. Click the Add Transition link next to Purchase Approved:
    1. In the Transition Name field, type 'Start Progress'.
    2. In the Destination Step field, select 'In Progress'.
    3. Click the Add button.
  13. Click the Delete Transitions link next to Open. Select Start Progress and click the Delete button.
  14. Click the Workflow Schemes tab in the left navigation column. Then click the Add Workflow Scheme button.
  15. In the Name field, type 'Purchase Order Workflow Scheme'. Then click the Add button.
  16. On the 'Purchase Order Workflow Scheme' window, click Associate an Issue Type with a Workflow button.
  17. Select All Unassigned Issue Types from the Issue Type dropdown. Select Purchase Order Workflow from the Workflow dropdown. Then click the Assign button.
  18. Click Projects > Purchase Orders.
  19. Click the Workflows tab in the left navigation column.
  20. Click the Actions cog on the right, then select Use a different scheme.
  21. On the 'Associate Workflow Scheme to Project' screen, select Purchase Order Workflow Scheme from the Scheme dropdown. Then click the Associate button.
  22. JIRA will begin the process of migrating the issues in the Purchase Order project to the new workflow scheme. Click Associate on the first 'Associate Workflow Scheme to Project' screen.
  23. A screen will appear that tracks the progress of the migration. When it's complete, click Acknowledge.

To test what you have done, create an issue in the 'Purchase Orders' project. After you save the issue, an option for the Approve Purchase status should be available from the Workflow button dropdown, but an option called Start Progress.

13. Using permission schemes, groups and project roles

A Permission scheme allows you to grant people 'permission' to work on issues in a project. The new project that you created previously is using JIRA's default permission scheme. If you end up creating lots of projects, you might need to grant different people permission to work on different projects.
For example, if your organisation requires all software development issues to be tested by a Quality Assurance person before being closed, you could create a permission scheme called 'Software Development Permission Scheme' in which you assign the 'Close Issue' permission to the appropriate people. You would then associate your new permission scheme with all your software development projects.
There are a number of ways to do this, depending on your requirements:

  • Project roles enable you to associate different people with particular functions, for particular projects.
  • Groups enable you to associate the same people with a particular function, for all projects that use this permission scheme.

To add a new permission scheme called 'Software Development Permission Scheme', and a project role called 'Quality Assurance':

  1. Create a project role called 'Quality Assurance':
    1. Click Administration in the top navigation bar.
    2. Select Users > Roles.
    3. In the 'Add Project Role' section, type 'Quality Assurance' in the Name field. Then click the Add Project Role button.
  2. Create a permission scheme called 'Software Development Permission Scheme', in which you assign the 'Close Issue' permission to the 'Quality Assurance' project role:
    1. Select Issues > Permission Schemes.
    2. Click the Copy link next to 'Default Permission Scheme'. A new permission scheme called 'Copy of Default Permission Scheme' will be created.
    3. Click the Edit link next to 'Copy of Default Permission Scheme'. On the 'Edit Permission Scheme' screen,
      1. Change the Name to 'Software Development Permission Scheme.'
      2. Change the Description to 'Permission scheme for software development projects'. Then click the Update button.
    4. Click the Permissions link next to 'Software Development Permission Scheme'. On the 'Edit Permissions' screen,
      1. For the 'Close Issues' permission, click the Delete link next to 'Project Role (Developers)'. Click Delete on the next screen to confirm the deletion.
      2. For the 'Close Issues' permission, click the Add link. On the 'Add New Permission' screen, click the Project Role radio button and choose Quality Assurance. Then click the Add button.
  3. Associate the 'Software Development Permission Scheme' with all your software development projects. Do the following for each relevant project:
    1. Click Projects from the top menu and select the project of interest. The project details will be displayed.
    2. Click the Permissions tab in the left navigation bar. Then click the cog and select Use a different scheme.
    3. Select 'Software Development Workflow Scheme' from the dropdown and click the Associate button.
  4. For each software development project, add the appropriate people to the 'Quality Assurance' project role:
    1. Click Projects from the top menu bar and select the project of interest.
    2. Click the People tab in the left navigation bar.
    3. Click in the area next to 'Quality Assurance' and add the appropriate people to the group. You can start typing a user's name and JIRA will automatically suggest the users as you type.
    4. Click the Update button.

Or, to add a new permission scheme called 'Software Development Permission Scheme', and a group called 'quality-assurance':

  1. Create a group called 'quality-assurance', and add the appropriate people to it.
    1. Click Administration in the top navigation bar.
    2. Select Users > Groups from the top menu.
    3. In the 'Add Group' section, type 'quality-assurance' in the Name field. Then click the Add Group button.
  2. Create a permission scheme called 'Software Development Permission Scheme', in which you assign the 'Close Issue' permission to the 'quality-assurance' group.
    1. Select Issues > Permission Schemes from the top menu.
    2. Click the Copy link next to 'Default Permission Scheme'. A new permission scheme called 'Copy of Default Permission Scheme' will be created.
    3. Click the Edit link next to 'Copy of Default Permission Scheme'. On the 'Edit Permission Scheme' screen,
      1. Change the Name to 'Software Development Permission Scheme.'
      2. Change the Description to 'Permission scheme for software development projects'. Then click the Update button.
    4. Click the Permissions link next to 'Software Development Permission Scheme'. On the 'Edit Permissions' screen,
      1. For the 'Close Issues' permission, click the Delete link next to 'Project Role (Developers)'. Click Delete on the next screen to confirm the deletion.
      2. For the 'Close Issues' permission, click the Add link. Click the Group radio button and choose quality-assurance. Then click the Add button.
  3. Associate the 'Software Development Permission Scheme' with all your software development projects. Do the following for each relevant project:
    1. Click Projects from the top menu bar and select the project of interest.
    2. Click the Permissions tab in the left navigation bar. Then click the cog and select Use a different scheme.
    3. Select 'Software Development Workflow Scheme' from the dropdown and click the Associate button.

14. Installing plugins

You can install plugins to add new functionality to JIRA (e.g. additional gadgets or reports), or to change the behaviour of existing features.

To install a plugin from the Atlassian Plugin Exchange:
  1. Click Administration in the top menu.
  2. Select Plugins > Plugins. The 'Manage My Plugins' page will open, showing any plugins already installed on your JIRA site.
  3. Click the Install Plugins tab. You will see a list of featured plugins. To search for other plugins, enter some keywords that describe the plugin in the 'Search the Marketplace' search box and press 'Enter'. For example, you can enter "charts" to see a list of plugins that provide different types of charting capabilities.
  4. Select a plugin and click the Install button. It it's a paid plugin, you can click Try to install a trial version of the plugin. A confirmation message and the plugin details will appear when the plugin is installed successfully.
    (info) Note: You may need to restart JIRA for your change to take effect. The Universal Plugin Manager will inform you if this is the case.
    (info) Note: Not all plugins can be automatically installed. Some require manual installation. These plugins will have a 'Download' button instead of an 'Install' button. In these cases, you should read and follow the plugin's installation instructions.
For more details please see the documentation.

Important next steps

(Note that you need to be an Administrator to do the tasks in this section.)

15. Import existing data from another issue tracker into JIRA

If you have existing projects and issues in another issue tracker such as Bugzilla, FogBugz, Mantis, Pivotal Tracker, Trac and more, have a look at our page on Migrating from Other Issue Trackers. This section of our documentation contains detailed instructions on how to import data from your other issue tracker into JIRA.

(info) Our main website highlights some top reasons why people migrate from other issue trackers to JIRA.

16. Use a supported database

Ideally, before allowing your users to use your JIRA installation as a 'production system', ensure that you have configured JIRA to use a supported database other than JIRA's internal HSQL database (which is provided for evaluation purposes only).

If your JIRA installation is using the internal HSQL database and you want to switch it across to using a supported database, see Migrating JIRA's data to a different type of database server for more information.

17. Backing up data

To back up your JIRA data, and establish processes for regular backups, please see the documentation.

Thank you for using JIRA.

Thanks for choosing JIRA. We're always happy to help. Feel free to email or call us with any questions you have.