HostModules Docs

Updating

When a new version of HmSingleOrderAddon is released, follow this process to update safely.

Back up before updating

Always take a full backup of your WHMCS files and database before updating. Pay special attention to any customizations you’ve made to the template files.

Update Steps

  1. Download the new version

    Log in to your HostModules client area, go to My Products, and download the latest version zip file.

  2. Note your customizations

    Before overwriting any files, make a note of (or copy) any files you have customized:

    • templates/orderforms/HmSingleOrderForm/css/hm-main.css (if you edited CSS directly)
    • templates/orderforms/HmSingleOrderForm/_custom.scss (custom SCSS overrides)
    • Any custom .tpl template files you have modified

    It’s best practice to keep customizations in _custom.scss rather than modifying core files — this makes updates much easier.

  3. Upload the new files

    Upload the new addon files, overwriting the existing ones:

    • modules/addons/HmSingleOrderAddon/ — overwrite completely
    • templates/orderforms/HmSingleOrderForm/ — overwrite completely (then re-apply customizations)
  4. Run database migrations

    After uploading, go to System Settings → Addon Modules, find HmSingleOrderAddon, and click Upgrade if prompted. If no upgrade button appears, the update didn’t include database changes.

    You can also trigger migrations by deactivating and re-activating the module, but this will drop your settings data — only do this if instructed by support.

  5. Re-apply customizations

    If you had custom CSS or template changes, re-apply them to the new files. If you used _custom.scss, simply rebuild the CSS:

    cd templates/orderforms/HmSingleOrderForm
    npm install
    npm run build
    
  6. Clear WHMCS cache

    In your WHMCS admin, go to Utilities → System → Smarty Cache and clear the template cache to ensure the new templates are loaded.

Changelog

Check the HostModules changelog for a full list of changes in each version. Release notes describe whether a version requires database migrations or has breaking template changes.

Version Check

You can always see the currently installed version in:

System Settings → Addon Modules → HmSingleOrderAddon → Configure

The version is displayed in the module info header.

Stay notified

Enable email notifications in your HostModules client portal to receive alerts when a new version is released.