This guide explains how to update WHMCS modules using an In-App Updater system. It is written as a general process that can be used across any module that includes an In-App Updates panel.
Before You Update
- Take a database backup before updating
- Run updates during a low-traffic period
- Confirm you have administrator access to WHMCS
- Confirm the module is functioning normally before you start
- Confirm your server has available disk space for downloads and backups
Where to Find the In-App Updater
In WHMCS Admin, open the module you want to update and locate its In-App Updates panel. The exact menu location depends on the module and WHMCS layout, but it is typically within the module’s admin area.
Updater Settings (Overview)
Most In-App Updater systems include settings similar to the items below. Depending on the module, some options may not exist.
- Manifest URL (where update metadata is retrieved)
- Update channel (example: stable)
- Auto-check for updates (optional)
- Allow prerelease updates (optional)
- Storage path for downloaded updates
- Backup retention (how many backups to keep)
- Debug logging (optional)
Only change updater settings if you were instructed to by the vendor or your internal standards.
How to Check for Updates
- Open the module’s In-App Updates panel
- Click Check for Updates
- Review the version number, release notes, and compatibility notes
If no update is available, the updater will indicate you are up to date.
How to Run an Update
When an update is available:
- Click Update Now
- Do not close the page while the update runs
- Wait for confirmation that the update completed successfully
A typical In-App Updater process includes:
- Download the update package
- Validate the update package integrity
- Create a backup of the current module version
- Install the updated files
- Run database migrations (if included by the module)
- Record update logs for auditing
After Updating
After the update completes, clear WHMCS template caches:
Utilities → System → System Cleanup
- Empty Template Cache
- Empty Admin Template Cache
Then verify the updated module loads normally.
Recommended Post-Update Verification
Use this checklist after each update:
- Open the module dashboard/home page
- Open the module’s main list page (example: projects, records, or items)
- Open an existing item and confirm the detail view loads
- Create a test item (if safe to do so) and confirm it saves successfully
- If the module has a client area component, confirm it loads for a test client
Troubleshooting
The updater says the update is not compatible
- Confirm your WHMCS version meets the module’s minimum requirement
- Confirm your PHP version meets the module’s minimum requirement
- If channels exist, switch to stable for production
The update fails or times out
- Enable Debug Logging (if available) and retry once
- Check WHMCS Activity Log for related errors
- Confirm the server has sufficient disk space for backups and downloads
- Confirm outbound connectivity to the update server is not blocked
The module is broken after updating
- Clear template caches and reload the module
- Review the updater logs for the failure reason
- If the updater supports rollback, use rollback to restore the prior version
- If backups were created, restore the module backup and retest
Best Practices
- Use the stable channel for production sites
- Test updates on staging first when possible
- Keep backups for a rolling window (based on retention settings)
- Document version changes internally for audit tracking
Information to Provide When Requesting Support
If an update fails and you need support, collect:
- WHMCS version
- PHP version
- Module name
- Version updated from and to
- Updater logs (or screenshots)
- Relevant WHMCS Activity Log entries