KanBo Backup and Update (On-Premises)

Table of Contents

Overview

This article will walk you through the update process and demonstrate how to perform backups along the way. It is absolutely critical to perform backups at each step of the update process. Failing to do so can lead to irreversible data loss, so be sure to follow those steps.

Always back up data before updates or configuration changes.

Prerequisites

Before you initiate the update, verify that you have:

  • Sufficient privileges to stop and restart the IIS Application Pool for KanBo, as well as access to the SQL Server to perform a database backup
  • The KanBo.zip package that contains update files for the KanBo App
  • The KanBo.Jobhost.zip package that contains the update files for KanBo scheduled tasks
  • The RM.zip package that contains update files for the Resource Management app (if Resource Management is a part of your KanBo license)

First step: KanBo Backup

Before updating KanBo, it is essential to create a complete backup.

  1. Open the Internet Information Services (IIS) Manager.
  2. Navigate to Application Pools, locate the KanBo Application Pool, and stop it.
  1. Open the KanBo installation directory by navigating to the site under Sites, and the select Explore.
  1. Create a complete backup of your KanBo directory by copying the folder to a secure location.
  2. After completing the backup, delete all files and directories in the KanBo folder except for the appsettings.json file and the KanBo.Branding folder.
onprem-deletefiles
  1. Extract the contents of the KanBo.zip package into the KanBo directory.

If the Resource Management module is installed, repeat the aforementioned steps with the RM.zip package.

  1. Launch SQL Server Management Studio (SSMS) on your SQL Server.
  2. Connect to the appropriate database instance and execute a database backup to ensure you can revert to the previous version if needed.

Second step: KanBo Update

Once the KanBo backup is ready, you can begin the update process.

  1. Return to IIS and restart the KanBo Application Pool.
  2. Afterwards, open the KanBo App in your browser.

If you are presented with this screen, that means that a database upgrade is required. If that is not the case, you can skip the rest of the steps in this section.

  1. To upgrade databases, append /setup to your KanBo URL (e.g., contosokanbo.azurewebsites.net/setup) to access the setup page.
  2. Select Show advanced setup.

A page displaying an error about a failed license ID fetch due to pending migrations should appear, and the License ID section should display “Loading… (retrying in Xs).”

  1. Select Upgrade databases.

On successful migration you will be presented with a “Finished databases upgrade” message and the license ID visible again.

If an error occurs during the upgrade, contact our support team at support@kanboapp.com.

  1. After a successful database upgrade, on the top left corner select Exit to go back to KanBo.

Resource Management module

For KanBo installations with Resource Management module, verify if a database upgrade is needed by refreshing the setup page.

  1. Go to the Advanced setup > Resource Management. 
  1. If the Upgrade database button is visible in the Resource Management section, initiate the upgrade.
  1. On successful upgrade, it is recommended to synchronize the Resource Management Users and Managers.

KanBo scheduled tasks

If KanBo scheduled tasks are configured, update them as follows:

  1. Create a backup of the scheduled tasks folder.
  2. Extract the contents of the KanBo.Jobhost.zip package into the existing scheduled tasks directory, ensuring that you overwrite the existing files.

Restoring KanBo to the previous version

In the event of an unsuccessful update or system issues, restore the previous version by following these steps:

  1. Stop the KanBo Application Pool in IIS.
  2. Use SQL Server Management Studio to restore the KanBo database from the backup.
  3. Replace the KanBo files with those from your backup.
  4. If scheduled tasks and the Resource Management module were updated, restore their files from their respective backups.
  5. Restart the KanBo Application Pool.

Was this article helpful?

Please, contact us if you have any additional questions.