Installation and Upgrade

Owned by Rosen Marinkov
Last updated: Oct 10, 2024
5 min read

On this page:

Before you begin

To install Configuration Manager for Jira:

  • You must have the Jira System administrators global permission.

  • Your Jira version must support the intended Configuration Manager for Jira version. Refer to the Compatibility Matrix.

Install Configuration Manager for Jira (CMJ)

Install on Jira Data Center

To install the Configuration Manager for Jira app (CMJ) on your Jira Data Center instance, follow these steps:

  1. Log into your Jira Data Center instance as a user with the Jira System Administrator global permission.

  2. Click the cog icon on the top bar and select Manage apps.

  3. From the left-hand side menu, click Find new apps.

  4. Search for Configuration Manager for Jira.

  5. Once you locate the app, click the Buy now button.

  6. Review the app details and click Select & install to proceed with the installation.

  7. After the installation is complete, you may need to provide your CMJ app's license key. Refer to the documentation to learn how to enter your Configuration Manager License.

Install on Jira Server

To install the Configuration Manager for Jira app (CMJ) on your Jira Server instance, follow these steps:

  1. Visit Configuration Manager for Jira’s Atlassian Marketplace page.

  2. From the Hosting options dropdown on the right side of the page, select Server as the hosting type.

  3. Scroll to the Resources section at the bottom of the page and click Download to get the CMJ installation file.

  4. In your Jira Server instance, log in as a user with the Jira System Administrator global permission.

  5. Click the cog icon on the top bar and select Manage apps.

  6. From the left-hand side menu, click Manage apps.

  7. Click the Upload app link and select the installation file you downloaded in step 3.

  8. Click Upload and wait for the app to install.

  9. After the installation is complete, select Close in the Installed and ready to go dialog. You may need to provide your CMJ app's license key. Please refer to the documentation below to learn how to enter your Configuration Manager License.

How to Enter Your Configuration Manager License in Jira

  1. Log in as a user with the Jira System Administrator global permission.

  2. Click the cog icon in the top bar and select Manage apps.

  3. Look for Configuration Manager for Jira and click on it to open its details.
    Your Support Entitlement Number (SEN) is shown on this screen, along with other information about the app. 

  4. Go to https://my.atlassian.com and copy your Configuration Manager license key. You can generate a new Evaluation license key or retrieve your old license key if you already have one.

  5. Paste your license into the License key textbox.

  6. Click Update to use the license.

Configuration Manager’s license must match your Jira license

Please note that if you are using a commercial (i.e., not an evaluation) license for Configuration Manager for Jira, it must match your Jira license. For example, if you have a Jira commercial license for 25 users, you must have a Configuration Manager paid license for 25 users.

Evaluation licenses for Configuration Manager do not need to match Jira licenses.

After the installation finishes, the following bundles are installed: 

  • Configuration Manager Core Bundle,

  • Configuration Manager for Jira,

  • Integrity Check for Jira,

  • Power Admin,

  • Configuration Manager for Jira SPI Bundle.

Verifying the installation

To verify that Configuration Manager for Jira (CMJ) is installed, check that it is present under the Configuration Manager menu in the Jira Administration section.

Upgrading Configuration Manager

Before you begin, please read the latest Release Notes, and ensure that you are running a version of Jira that is compatible with your new version of Configuration Manager for Jira.

  1. Log in to Jira as a user with the Jira System Administrators global permission.

  2. Click the cog icon on the top bar and select Manage apps. The Universal Plugin Manager (UPM) page will be displayed.

  3. On the Manage Apps page, look in the Apps Requiring Action section and locate Configuration Manager for Jira.

  4. Click the Update button.

Disabling Configuration Manager

  1. Log in to Jira as a user with the Jira System Administrators global permission.

  2. Click the cog icon on the top bar and select Manage apps. The Universal Plugin Manager (UPM) page will be displayed.

  3. On the Manage Apps page, click Check for Purchases then locate Configuration Manager for Jira.

  4. Click the Manage button. The details for the Configuration Manager for Jira app will show up.

  5. Click the Disable button.

  6. Repeat steps 3, 4, and 5 for Configuration Manager Core Bundle, Integrity Check for Jira, Power Admin, and Service Provider Interface.

Configuration Manager will be disabled after you disable all of the bundles:

  • Configuration Manager Core,

  • Configuration Manager for Jira,

  • Integrity Check for Jira,

  • Power Admin,

  • Configuration Manager for Jira SPI Bundle.

Uninstalling Configuration Manager

Configuration Manager for Jira consists of several separate bundles (apps) distributed through the marketplace in a single .obr package. The names of the bundles are:

  • Configuration Manager Core,

  • Configuration Manager for Jira,

  • Integrity Check for Jira,

  • Power Admin,

  • Configuration Manager for Jira SPI Bundle.

You need to uninstall all bundles for a successful uninstallation. The order in which you uninstall them doesn't matter. However, if you’re planning to continue to use Integrity Check or Power Admin, then you shouldn’t uninstall the Configuration Manager Core bundle.

To uninstall the Configuration Manager for Jira app, follow these steps:

  1. Log in as a user with the Jira System Administrator global permission.

  2. Click the cog icon on the top bar and select Manage apps.

  3. On the Manage Apps page, locate Configuration Manager for Jira in User-installed apps. Click on it to display its details.

  4. Click the Uninstall button.

  5. Repeat steps 3 and 4 for Configuration Manager Core Bundle, Integrity Check for Jira, Power Admin, and Service Provider Interface.