Upgrade self-hosted Jira Align instances

Atlassian supports the current on-premise version and the immediately prior release. Jira Align supports the latest two on-premise versions. For example, if the current version is 10.135.X, version 10.134.X is also supported. To maintain a supported version, we recommend regularly upgrading Jira Align on-premise. Current version information can be found in the release calendar.

Note: If you are upgrading from version 10.109.X or earlier, you must first upgrade to version 10.117.X before upgrading to 10.118.X or later.

Topics in this article:

• Back up Jira Align directories and databases
• Prepare for the upgrade
• Perform the upgrade

Back up Jira Align directories and databases

We recommend backing up both the Jira Align install directory and associated databases before performing an upgrade.

1. Make a backup (file system copy) of the current Jira Align install directory. The default location is C:\[YOURCOMPANYNAME] where [YOURCOMPANYNAME] is the name chosen during the initial Jira Align installation.
2. Back up [YOURDATABASENAME], where [YOURDATBASENAME] is the name chosen during the initial Jira Align installation. 

3. If it’s your first time upgrading to version 10.127.0 or later, rename the AgileCraftServer database by running the SQL:
    

   ALTER DATABASE [AgileCraftServer]
   MODIFY NAME = [X_deprecated_AgileCraftServer]

   Revoke access to this database for Jira Align SQL users initially created with access as part of the original installation or later. Jira Align won’t use the renamed database, so you may remove this database if your organization doesn’t need the data.

We recommend working with your database administrator if you need assistance. The following guide provides steps for performing a standard SQL database backup: Quickstart: Back up & restore database with SSMS - SQL Server

Prepare for the upgrade

1. Create a folder for the new version under C:\[YOURCOMPANYNAME]\Releases\
   1. Example: C:\YOURCOMPANYNAME\Releases\10.120
2. Copy the new Jira Align install package (zip) to the folder that was created:
   1. Example: C:\YOURCOMPANYNAME\Releases\10.120\JiraAlign-10.120.2.7.zip
3. Extract the install package contents to the same folder:
   1. Example: C:\YOURCOMPANYNAME\Releases\10.120\*.*
4. Locate the deploy-only-CUSTOMERNAME.bat file in the extracted root folder:
   
5. Rename the deploy-only-CUSTOMERNAME.bat file by changing CUSTOMERNAME to match the Jira Align install root folder name:
   
6. Open the file in a text editor:
   
7. In the text editor, replace CUSTOMERNAME with the name of the IIS site that is running Jira Align:
   
8. For each site, create a new folder as C:\[YOURCOMPANYNAME]\[CUSTOMER_DATABASE]\BackofficeService if not already created.
9. For all sites, open ServiceTasks.BackOffice.dll.config in C:\[ROOT_DIRECTORY]\[CUSTOMER_DATABASE]\BackofficeService using a text editor.
   1. Set the smtp_from_email_address value to the email address you want to send emails from. Make sure this email can send mail through the host or relay in the next step.
   2. Update the SMTP email relay server settings for the attributes host="127.0.0.1", port="25", and enableSsl="false" that Jira Align will use to relay email through.
   3. Optionally, add userName and password attributes if you need to authenticate to the SMTP host or relay. These values will be encrypted when the Backoffice Windows service starts.
      •  
        • If you're unsure about email relay settings, ask your IT administrator.
        • For details on supported SMTP relay settings, visit this article: smtp Element (Network Settings)

Perform the upgrade

1. Stop the IIS server that runs Jira Align.
2. Open a Windows command prompt as an administrator. For more information on how to do this, review Start a Command Prompt as an Administrator.
3. If this is your first time upgrading to 10.127.0 or above:

   1. Run an uninstall command for each site:
       

      C:\[ROOT_DIRECTORY]\BackofficeService\AgileCraft.Backbone.exe --uninstall --task BackOffice --suffix AgileCraftServer

   2. For each site, run this install command from each database folder:

      C:\[ROOT_DIRECTORY]\[CUSTOMER_DATABASE]\BackofficeService\install.bat --task BackOffice --instance [CUSTOMER_DATABASE]

      This will install a service with the name Jira Align Backoffice ([CUSTOMER_DATABASE]).

4. Change to the new version folder C:\[YOURCOMPANYNAME]\Releases\[VERSION]
   Example: C:\YOURCOMPANYNAME\Releases\10.120\
5. Run the deploy-only-[YOURCOMPANYNAME].bat file.
   Example: deploy-only-YOURCOMPANYNAME.bat
6. The install script will display a prompt prior to performing database updates. Press any key to continue.
7. The upgrade script will return a “Succeeded” message once it completes.
   
8. Start the IIS server.
9. Open the Jira Align site and confirm the new version is displayed at the bottom of the login page.