Version 5.0: Upgrade Guide

We are pleased to introduce Ubersmith Version 5.0, bringing significant updates and enhancements to our platform. To ensure a seamless transition to this latest version, we have outlined important upgrade requirements below. For detailed information on all updates included in this release, please refer to the full release notes.

System Requirements

Ubersmith Version:

• If you have a version of Ubersmith older than 4.6.x, ensure you upgrade to 4.6.4 first before upgrading to 5.0.0 to ensure compatibility with MySQL 8.0.

Ubuntu & Debian Installation Requirement:

• The Ubersmith Installation and Upgrade Utility has a new software dependency which must be installed. For Ubuntu & Debian installations, please install Python 3 venv with the command apt install python3-venv. We have adopted Python venv to leverage Python virtual environments, which enable us to install dependencies for the installer independently from the Python packages on the host OS. This approach helps prevent errors and compatibility issues. For more information on Python venv, please refer to the official documentation.

MySQL 5.7 Cluster/Server Upgrade:

• If you are currently using any external MySQL 5.7 clusters/servers, it is imperative to upgrade them to version 8.0 to align with the backend requirements of Ubersmith 5.0.0. Upgrading your server to version 8.0 offers various benefits, as outlined in this documentation, (this is the distribution of MySQL we ship with). Please note that Ubersmith does not offer automatic upgrades for clusters or external databases. Only the Ubersmith database container can be automatically upgraded using the Ubersmith Upgrade and Installation Utility.

Custom Code and Extensions

Upgrade to Docker Compose 2:

• Starting from this version, Docker no longer utilizes docker-compose; instead, please use docker compose without the hyphen. For more information, please visit the Docker documentation.

Removal of Timestamp Triggers:

• The timestamp triggers from the CLIENT and contacts tables have been removed. Though not in use in Ubersmith, they might be utilized in custom modules or plugins. API methods returning a Client or Contact will no longer include the fields _createdAt and _modifiedAt, such as the client.get method. This change also applies to custom code where a PHP variable created by Ubersmith representing a Client and Contact will no longer contain these fields. An example of this is the variable sent in the Hook ‘View\Client\Summary’ holding client data.

PHP 8.x Compatibility:

• Ubersmith was previously running with PHP 7.3 and has now been updated to support PHP 8.2, along with MySQL 8.0. Please note that custom scripts on your Ubersmith instance may require updates to ensure compatibility with PHP 8.2.
• In your plugin code, make sure to update any references to UbersmithSDK\Usage\Resource are replaced with UbersmithSDK\Usage\UsageResource, as ‘Resource’ is now a reserved keyword in PHP 8.x. For further information, refer to the Ubersmith Plugins Changelog.

PayPal Integration Update

We’ve updated the PayPal payment gateway integration to utilize the latest API version. If you use the PayPal payment gateway, please ensure the necessary configuration fields are complete by navigating to Settings -> Payment Processing Options. For detailed instructions, refer to our documentation.

Deprecation of PayPal Billing Agreements:

• As of this version, PayPal billing agreements are deprecated, although they will continue to function as before.

Thank you for your attention to these important upgrade requirements. Should you have any questions or need further assistance, please don’t hesitate to reach out to our support team.