Overview

This guide will help us understand how to use the upgrade script

The upgrade.sh script can be found in (idhub-docker-<version>/  location) inside the downloaded packages, This will help the end user to upgrade to the latest downloaded package, from a previously installed package
But make sure your immediate installed version is up and running without issues

The up-gradation process will involve following checklists to be followed:

  • Procuring the Stop, Start, Backup and Restore, Maintenance .sh files
  • Detailed Information about Stop, Start, Backup, Restore, Maintenance .sh
  • Executing the scripts

Detailed steps for each one of the above steps are provided below

Step 1: Procuring the scripts

Before proceeding to script few things needs to be considered while moving ahead of the document, it is presumed that

  1. You have already downloaded the latest package to which you want to upgrade your idhub version
  2. You had untar/unzipped the package (or untar using "tar zxvf idhub-docker-<version>.tar.gz")
  3. You kept latest downloaded idhub version under "/apps/" directory of your server

The Stop, Start, Backup and Restore.sh scripts are located at the below location of the idhub-docker<version> package which can be downloaded from the link above

/idhub-docker<version>/<file>.sh
BASH

And the Maintenance.sh script can be found in below location 

/idhub-docker<version>/config/maintenance/
BASH

Step 2: Information about Stop, Start, Backup and Restore, Maintenance .sh scripts

  1. Stop.sh- This script is used to shut down the current running IDHub stack in your environment
  2. Start.sh- This script is used to start the current stopped IDHub stack in your environment
  3. Backup.sh- This script is used to take backup of your IDHub data, user data and other meta data information's 
  4. Restore.sh-  This script is used restore IDHub data, user data and other meta data information's which are backup up by the Backup.sh script
  5. Maintenance.sh- This script is used to set IDHub to show maintenance page to the end users in case of any maintenance works needs to be done 

Step 3:  Executing the script

Execute the below command to run the script process from the directory of the script

./<File>.sh
BASH

Replace <File> with the script you want to execute