JIRA Agile Installation and Upgrade Guide
The information on this page does not apply to Atlassian OnDemand. If you are using Atlassian OnDemand then you do not need to install JIRA Agile, as it is supplied under Atlassian's Hosted Commercial Add-ons program. You may order and manage your JIRA Agile OnDemand licenses by logging into your account at http://my.atlassian.com.
Before you begin
- You must have the JIRA System Administrators global permission before you can carry out the instructions on this page.
- Please check the Supported Platforms to ensure your version of JIRA supports the intended JIRA Agile version.
If you are using a version of JIRA prior to 6.0, please use these instructions instead of the page you are currently reading.
- Check for any known issues in the JIRA Agile Knowledge Base.
- Please allocate an extra 256M of RAM to JIRA, just for JIRA Agile — i.e. please allocate a minimum of 512M to JIRA, instead of 256M. For details on how to do this, please see: Increasing JIRA Memory.
We highly recommend for the upgrade/installation to take place during off office hour as the upgrade task might take more resources especially on memory that might cause the server to encounter slowness.
- Please check the Supported Platforms to ensure that your browser is supported.
Please note: JIRA Agile does alter JIRA database tables to support project templates . Further, JIRA Agile will add additional tables to the JIRA database. Enabling or disabling JIRA Agile within your installed add-ons will not cause any damage to your JIRA data.
Installing JIRA Agile
Step 1. Install the JIRA Agile Add-on
- Log in to JIRA as a user with the 'JIRA System Administrators' global permission.
- Click the 'cog' icon on the top bar (or click Administation if using an older version of JIRA) and select Add-ons. The Universal Plugin Manager (UPM) page will be displayed.
- On the Find new add-ons page, type 'JIRA Agile' in the search box.
- The JIRA Agile add-on will appear in the list below the search box. Click the Install button. A confirmation message and the add-on details will display, if it is installed successfully.
If your JIRA instance is on a server that cannot access the internet, you will need to download the JIRA Agile add-on separately (from the Atlassian Marketplace) and install the add-on file by upload, as described here: Installing Marketplace apps.
Step 2. Enter your JIRA Agile License
- Log in as a user with the JIRA System Administrators global permission.
- Click the 'cog' icon on the top bar (or click Administation if using an older version of JIRA) and select Add-ons. The Universal Plugin Manager (UPM) page will be displayed.
- On the Purchased Add-ons page, click Check for Purchases then locate JIRA Agile.
- Click the Manage button. The details for the JIRA Agile add-on will display.
Your Support Entitlement Number (SEN) is also shown on this screen.
- Paste your license into the License Key field and click Update.
You can copy your JIRA Agile license from https://my.atlassian.com, where you can either generate a new Evaluation License Key, or retrieve your old License Key if you already have one.
If you need to change your JIRA Agile license details at any time in the future, please refer to Specifying your License Details.
GreenHopper license must match JIRA license
Step 3. Start JIRA Agile
Click the Agile tab to go to JIRA Agile.
Step 4. Configure JIRA Agile
To configure JIRA Agile, read the JIRA Agile 101 Guide.
About language support
English, French, German, Japanese, Dutch and Spanish are currently supported for JIRA Agile. Almost all character sets (like Cyrillic, Greek...) are supported for input. More languages will be supported in future releases. For details, please see Atlassian Translations.
Important note about custom fields: the language in which JIRA Agile custom fields are created is the default JIRA language (not the Java locale) at the time that you install JIRA Agile. Since custom fields are locked, you cannot change the language other than using the workaround in GHS-10356.
Upgrading JIRA Agile
Before you begin, please read the latest Release Notes and version-specific Upgrade Notes, and ensure that you are running a version of JIRA that is compatible with your new version of JIRA Agile.
To upgrade JIRA Agile:
- Log in to JIRA as a user with the 'JIRA System Administrators' global permission.
- Click the 'cog' icon on the top bar (or click Administation if using an older version of JIRA) and select Add-ons. The Universal Plugin Manager (UPM) page will be displayed.
On the Manage Add-ons page, look in the Add-Ons Requiring Action section and locate JIRA Agile .
Click the Update button.
If your JIRA instance is on a server that cannot access the internet, you will need to download the JIRA Agile add-on separately (from the Atlassian Marketplace) and install the add-on file by upload, as described here: Installing Marketplace apps.
Disabling JIRA Agile
- Log in to JIRA as a user with the 'JIRA System Administrators' global permission.
- Click the 'cog' icon on the top bar (or click Administation if using an older version of JIRA) and select Add-ons. The Universal Plugin Manager (UPM) page will be displayed.
- On the Purchased Add-ons page, click Check for Purchases then locate JIRA Agile .
- Click the Manage button. The details for the JIRA Agile add-on will display.
- Click the Disable button.
Getting Help
You may wish to check out the Atlassian Answers for JIRA Agile for advice from other users. If you need further assistance from us to resolve a problem, please log an issue on our support system.