PBX Version Upgrade Module

How to install the PBX upgrade module 

Please find below steps to install PBX upgrade module.

Download PBX Upgrader tool from server

1. Jump to "GUI → Admin → Updates " section.

   Open

   

    

2. Select "Module updates" tab from updates page and then click "check online"

   Open

   

    

    

3. "Check online" will fetch the latest available modules from our mirror server and then it will display available modules. 
    Select "download all" and then "process".
   
   

4.  This will again ask for the confirmation to install latest version of PBX upgrader tool
   
   

5. On confirmation this will install the module and will take you to module admin page.
   
   

Install  PBX Upgrader tool manually

If PBX upgrader tool is not visible for you during "check online" functionality then you can follow below steps to install this manually.

• Navigate to your PBX, login and go to Module Admin

• Click “Upload Module”

• Make sure “Download from the web” is chosen and enter 

http://mirror1.freepbx.org/modules/packages/versionupgrade/versionupgrade-15.0.37.tgz as the “Download Remote Module”

• Click download from web

• Go to Manage local modules

• The module can also be installed as the asterisk user from the command line using fwconsole

Install the new module as it should now show locally available.

GUI - How to use PBX upgrader tool 

Please find below steps to upgrade your PBX version 15 system to PBX version 16 using "PBX upgrader" tool.

1. Select "GUI → Admin → 15 to 16 Upgrade Tool" 

    

2.  After selecting 15 to 16 Upgrade tool, below page will reopen where we can check the features of version 16 by expanding the tab or else move to next step by clicking "Check the requirements" button.

3.  You will see all passed validation as soon as "requirements check" process is over. Move to next step by clicking "Proceed to upgrade process".

    

   
   
   

4. Upgrade process will start with wizard shown below.  Clicking on "next" will start downloading new PHP 7.4 dependent packages along with updated modules as per the PBX version 16 system.

   
   NOTE: As shown in upgrade wizard top help tip, this will update the PHP version to 7.4 along with dependent packages and then will perform the module updates so please do not refresh/close the browser.

   System upgrade process is an irreversible step so please ensure to take your PBX backup before proceeding.
   
   

    

   Alert pop up will appear for just to be double sure to start the upgrade process.  We can cancel the upgrade process from here also.

5. Step-2 of upgrade wizard will take some time so "do not refresh the web browser" and let the process to finish. 

    

6. This process will take some time due to downloading , installing all the PHP 7.4 and dependent packages and the PBX version 16 modules. In some cases it can take a very long time, don't interrupt it.
   The upgrade  process will perform the "fwconsole restart" as well. 

    

7. The wizard will display the status and upon successful completion it will display "The upgrade process has finished. Click Refresh below to continue.". Just click on the "Refresh" button and you will be redirected to module admin page and the upgrade to version 16 has been done successfully.

    

CLI - How to use PBX upgrader tool

Please find below CLI command to perform upgrade via Linux CLI.

yum upgrade -y

fwconsole ma upgradeall

fwconsole chown

fwconsole reload

fwconsole ma downloadinstall versionupgrade   OR fwconsole ma downloadinstall http://mirror.freepbx.org/modules/packages/versionupgrade/versionupgrade-15.0.42.tgz

fwconsole chown

fwconsole reload

fwconsole versionupgrade --check

fwconsole versionupgrade --upgrade

fwconsole chown

fwconsole reload

reboot or fwconsole restart

Post Upgrade checks

• Verify the php version to ensure the upgrade is done properly.
  - Run  "php -v" command from the CLI and verify the PHP version is properly upgraded, output of the command should show php version as "PHP 7.4.XX"

• Verify asterisk manager is connected.
  - Login to asterisk CLI and run " manager show connected" command verify admin user is connected and you are not seeing any asterisk manager connection related errors.
  
  

• Unban / unblock known good IP's (Applicable if you fail2ban service is enabled).
  - If your endpoints are registered through responsive firewall and not whitelisted in fail2ban then your known good IP's may get banned during the upgrade process and needs to be removed from banned list so that the endpoint an get registered.

• Check the modules are enabled properly.
  - During the upgrade process the module may get disabled during the upgrade process due to some dependency package or module missing so please ensure all your required modules are installed and enabled properly.

• Verify fwconsole commands are running fine.
  - Run "fwconsole r" and fwconsole restart" commands and verify both the commands executes 

Trouble Shooting the Upgrade process

• If your upgrade process failed for some reason or there is no response from the GUI wizard due to some network issues, then please login to CLI and check "/var/log/pbx/freepbx16-upgrade.log" for more detailed info on why the process failed.
  
  

• Sometimes after completing the upgrade process you might see the error as "In RedisCache.php line 135: Function Redis::delete() is deprecated" . The root cause of this issue is that the framework module failed to upgrade but the PHP updated to 7.4. To fix this issue follow the below steps.

  •  Download install the V16 framework module manually

    • ./usr/sbin/fwconsole ma downloadinstall framework --tag=16.0.10.42
      
      

  • Upgrade all the modules
    
    

    • fwconsole ma upgradeall

• If the upgrade process is failed due to the cloud migration module, then move the cloud migration module directory to different location and then install all the modules.

Cloud migration module error

To fix this issue

• If the upgrade process is failed due to the oracle_connector module, then move the oracle_connector module directory to different location and then install all the modules.

Oracle Connector module error

To fix this issue