UCRM - Update Guide and Beta Branch Usage


Overview


This guide explains how to update UCRM and how to switch from/to the beta branch of the UCRM project. The beta branch is intended to provide the user with the most recent UCRM features and improvements. 

WARNING: Be advised that reverting back to an older  stable version is not possible. The user will only be able to update to a newer stable or beta version as it is released.

Table of Contents


  1. In-App Update
  2. Debugging
  3. Manual Update Using CLI
  4. Related Articles

In-App Update


Back to Top

In UCRM navigate to System > Tools > Update to upgrade to a new UCRM version. Choose whether you want to run UCRM from the stable branch (more reliable version) or from the beta branch (which has the most recent features) and click the "Update to this version" button.

image1.png

WARNING:  You will be able to switch back to a stable version only after a newer version of UCRM is released. E.g. moving from 2.2.2-beta1 to stable will only be possible after version 2.2.2 or higher is released. However, you can update to a newer beta version by just running the usual update command (without specifying the version).

Note that you will be notified about a new available version automatically once it’s released. An orange button reading "Update to new version" will be visible on all pages in UCRM.

Once you click "Update to this version" under Tools > Updates, the rest of the process is fully automated. All users: admins and clients, will see a splash screen informing them that UCRM is currently under maintenance. Once the update is done, you will be automatically redirected back to the system. If you want to see what’s new in the updated version, just click on the notification icon (top right-hand corner).


Debugging


Back to Top

In some cases it might be helpful to see the log file of the latest update process. Go to see the update log file in the System > Tools > Updates or if the UI is not accessible, you can find this log file on the server at this location: /home/ucrm/data/ucrm/updates/update.log 

Use this file when asking for help on the UCRM Community forum. Note that this file is overwritten each time you run the update either in-app update or manual update.


Manual Update Using CLI


Back to Top

In some non-standard situations you may need to run the UCRM update manually using CLI. The following command will update UCRM to the latest stable or the latest beta version depending on whether it is currently using the stable or beta branch.

cd /home/ucrm
curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UCRM/master/update.sh | sudo bash -s | sudo tee update.log

If you want to switch to a specific version, you just need to put the version number in the command. For example, this will update your UCRM to version 2.12.0-beta1

cd /home/ucrm
curl -fsSL https://raw.githubusercontent.com/Ubiquiti-App/UCRM/master/update.sh | sudo bash -s -- 2.12.0-beta1 | sudo tee update.log

Related Articles


Back to Top

UCRM - Install UCRM Cloud Using DigitalOcean

UCRM - Backup and Migration


We're sorry to hear that!