Skip to main content

Upgrade Guide

Overview​

This document provides a guide to the steps required to upgrade an existing BBOT installation.

For information on the architecture and technical requirements please refer to the BBOT Architectural High-Level Design (HLD)

important

Ensure that your BBOT instance is configured on a server that is not shared with another application now or in the future.

Upgrade Steps​

Please follow the below steps in sequence observing all important notes prior to running the step.

Step Instructions​

Step 1: Download, Copy, and Extract Package to the Server to be Upgraded​

  1. Download the BBOT package from the download link provided in this document.
  2. Copy the packages to a suitable temporary directory on the server such as the user's home folder or a temp directory.
    • Important: This temporary copy/extract directory must be different from the BBOT installation directory with 10GB+ of available space.
  3. Extract BBOT zip package. Example: tar -xvf <FILENAME>.tar.gz.

Step 2: BBOT Upgrade​

  1. Navigate inside the BBOT_installer folder you extracted in step 1.3.
  2. With a sudo user run: 
    sudo bash upgrade.sh
    • Important: Upgrade scripts MUST be run by a sudo or root user otherwise upgrade will fail.
    • Note: additional parameters might be necessary (see below)
    • Pass additional parameters if you want to customize the upgrade.
    • Note: Please verify the API endpoint and the public path by entering 'y'.
  3. Optionally after the upgrade you can check the beebot_upgrade_log.txt to validate if any errors were encountered.

Step 3: Validating Upgrade​

From a web browser or via curl, access the URL [http://<SERVER_HOSTNAME_OR_IP>] where SERVER_HOSTNAME_OR_IP is the Server Hostname or IP Address of the server you just ran the upgrade on and you should see the below UI.