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

Skip to end of metadata
Go to start of metadata

To configure a project in JIRA:

  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.
  3. Select an existing project, or click 'Add Project' to add a project.

Here is what a project looks like once created:

A project's configuration settings are as follows:

  • Avatar — an image (48x48 pixels) that represents the project. You can either use the default image, i.e.:

    or choose a different image. If you prefer not to use an image, simply upload a transparent pixel.
  • Description — an optional description of this particular project. You can include HTML, but make sure all your tags are closed.
    Icon

    Please be aware that this is completely unfiltered HTML, therefore it is susceptible to cross site scripting attacks.

  • Key — a 'key' unique to this project (eg. 'WEB'), which specifies the first few letters of this project's issue keys (e.g. 'WEB-100'). We recommend that you define a key that describes the project and is easy to type (as it prefixes each issue in the project). Please note that the key is shown to users who do not have permission to see the project and cannot be changed once the project exists.
  • URL — an optional URL associated with this project, eg. pointing to project documentation.
  • Project Team:
    • Project Lead — user fulfilling the role of project leader. Used as the 'Default Assignee' (see below), and potentially elsewhere in JIRA (e.g. in permission schemes, notification schemes, issue security schemes and workflows).
    • Default Assignee — the user to whom issues in this project are initially assigned when created. Can be either the 'Project Lead' (above), or, if Allow unassigned issues is set to 'On' in JIRA's general configuration, 'Unassigned'. There are also default component assignees.
    • Project Roles — members are users/groups who fulfil particular functions for this project. Project roles are used in permission schemes, notification schemes, issue security schemes and workflows.
  • Issue Type Scheme — the project's issue type scheme determines which issue types apply to this project.
  • Notification Scheme — the project's notification scheme determines who receives email notifications of changes to issues in this project.
  • Permission Scheme — the project's permission scheme determines who has permission to view or change issues in this project.
  • Issue Security Scheme — the project's issue security scheme determines what visibility levels issues in this project can have (see issue-level security).
  • Field Configuration Scheme — the project's field configuration scheme determines which field configuration applies to issue types in this project. (A field configuration determines each field's overall visibility, requiredness, formatting (wiki/rich-text or plain) and help-text).
  • Screen Scheme — the project's screen scheme determines which screens are displayed for different issue operations (view, edit, create);
    or:
    Issue Type Screen Scheme — the project's issue type screen scheme determines which screens are displayed for different issue operations (view, edit, create), for different issue types.
  • Workflow Scheme — the project's workflow scheme determines which workflows (issue state transitions) apply to issue types in this project.
  • CVS Modules — configures CVS integration for this project.
  • Mail Configuration — specifies the 'From' address for emails sent from this project. Only available if an SMTP email server has been configured in JIRA.
  • Project Category — a logical category to group this project into. Useful for managing multiple related projects. New categories can be created via the 'Project Categories' link in the 'Administration' menu.
  • Application Links — entities to which this JIRA project has been linked in other applications (via application links). New entity links can be created by clicking the 'Configure Application Links' link. See Linking your JIRA Project to another Entity for details.

As well as:

  • Components — logical groups that this project's issues can belong to. See the component management page for details.
  • Versions — versions defined in the project. See the version management page for details.

A note about Project Administrators

A JIRA project administrator is someone who has the project-specific 'Administer Project' permission, but not necessarily the global 'JIRA Administrator' permission.

A project administrator can:

Additional Resources

  • Adding a Project tutorial video — Watch this short tutorial video to see how a project is added in JIRA. Please note the JIRA version of the tutorial video before watching.