Upgrading a Com.X10 or Com.X20 to 3CX version 18

This document outlines the steps required to upgrade a Com.X10 or Com.X20 from 3CX version 16, on Debian 9, to 3CX version 18 on Debian 10.

The upgrade involves an upgrade not only to the 3CX software, but also to the operating system. If your PBX Appliance contains telephony ports, then the Virtual Com.X TDM gateway is also upgraded.

As such, it is important to follow a methodical approach to minimize the risk of one of any of these upgrade components failing.

Prior to the upgrade

A few steps should be taken prior to the upgrade, so as to allow the upgrade to proceed with minimal interruptions,

1. If the PBX is not already on a static IP address, or on a static lease configured on the DHCP server, configure one now. This will make sure that regardless of the operating system's having been upgraded, the PBX will reboot on the same IP address it held prior to the upgrade.

2. Take a configuration backup of the device, and store it on your laptop or PC. The operating system of the device is being upgraded, so it is important to have a full backup on hand, on another device. Should serious trouble be experienced during the upgrade, you then have a backup that can be restored so as to restore service.

3. Update Comma-UI. Use the Comma-UI to perform an update to comma-UI. Make sure that comma-UI is on at least version 1.43 before attempting the upgrade.

4. Make sure that any additional repositories that have been manually added to /etc/apt/sources.list, have been removed or commented out. The upgrade involves an upgrade from Debian 9 (stretch) to Debian 10 (Buster). Including unknown Stretch repositories in your sources list will result in the upgrade failing.

Updating Comma-UI

Prior to commencing the upgrade, an update to comma-UI is required. Software Package management is performed using the comma-UI.

Select host system tools, then "check for updates".

After the update check is complete, select "install updates".

During the update of the comma-UI package, the comma-UI will become unavailable, so allow a few minutes for the device to update, before attempting to access the comma-UI on port 8888 again.

You can use the System information page to validate that comma-UI is version 1.44 at least.

Upgrading to 3CX version 18

Once you have completed to steps detailed above, it is time to start with the actual upgrade. This process can take several minutes, so make sure your customer expects the down time.

If the device in question contains any telephony ports, then it's important to expect additional down time, as the on board hardware will require some reconfiguration.

Upon clicking on the upgrade button, you will be presented with a second warning, indicating the risks of the upgrade. The pop up suggests that all 3CX services will be halted for around 20 minutes.

Click the Upgrade button to proceed.

Upon completion of a successful upgrade, your device will reboot.

The admin of the site will then receive an email, informing them of the successful upgrade to 3CX version 18, running on Debian 10. The management console will then be available on the selected HTTP port, and comma-UI will be available on port 8888.

Handling Hardware

Coinciding with the release of 3CXPBX version 18, is our own second iteration of the Virtual Com.X TDM gateway. We have introduced a number of improvements to increase the stability of internal telephony ports running on Com.X and Wanderbox devices.

Many of the configuration elements of this upgrade are contained within an updated gateway template on 3CX version 18. As such, gateway trunks should be recreated, so as to make use of the updated gateway templates on 3CX v18.

Due to this upgrade, however, existing configurations of analogue or PRI trunks will need to be re-created.

If your Com.X device features on-board telephony ports, the safest way of managing the upgrade is to create new gateway and FXS configurations. This will mean deleting the existing gateway or FXS gateway from the 3CX configuration, and then re-adding another gateway with the same Mac address.

If your Com.X device features on-board telephony ports, contact Far South Networks to assist in the upgrade of your unit.