How do I migrate to the SwiftModders WHMCS Theme Installer?
Notice: You can only migrate the following theme installation versions:
Allure WHMCS Theme 1.0.5+
SwiftModders WHMCS Client Theme 2.9.9.3+
SwiftModders WHMCS Admin Theme 5.9.9.3+
1. Backup your WHMCS database and files
It’s always important to make sure that your previous setup is preserved in case of an error with either the process or the module itself. Once you have a full backup of both your MySQL database and your WHMCS installation, you can move forward to the next step.
2. Download the theme you wish to migrate
More than likely, you already have the theme files installed on your WHMCS installation. That’s OK, but you must download the “Theme Installer” version and replace those files. There are minor changes that add support for the theme installer. Skipping this step could break your installation or prevent the display of the migration button. To download your theme again, log into your account and navigate to “My Services” > “Downloads.” Next, select the theme license you wish to migrate and click on the “Downloads” option in the sidebar.
Once loaded, you will notice a handful of downloads for your theme license. The correct download will be the one specified with “Theme Installer Version.” Be sure to download those files to your local machine.
3. Unzip the download to your local machine
After downloading the theme, you will need to unzip the compressed file onto your local machine. You can use many different tools to handle this, and both Windows and Macs have built-in uncompression tools. My preference for Windows machines would WinRAR, but you’re free to use the tool you feel most comfortable with.
For more information on how to unzip a file, please read this tutorial on WikiHow.
4. Upload the files to your WHMCS installation
Once your ZIP file has been extracted, you can upload the module files to your WHMCS installation. The best way to do this would be to use your favorite FTP program. I use SmartFTP and FileZilla regularly handle my FTP uploads, but more modern control panels like cPanel and DirectAdmin have File Managers available.
In the theme folder, look for the “upload” folder. Upload the contents of the “upload” directory, not the folder itself, to the root directory of your WHMCS installation. This will add the necessary theme files into the appropriate folders so that the Theme Installer will recognize the theme is available for install.
5. Access the Theme Installer and run the migration
Once your upload has been completed, you will need to login to your WHMCS admin portal and navigate to “Addons” > “SwiftModders WHMCS Theme Installer.” You should see the theme you downloaded available in the module and a “Migrate” option present. If you do not see this option, make sure you have uploaded the theme folders to the correct location. If you continue to have problems, please open a support ticket.
Click on the “Migrate” button, and the process will start immediately. The module will copy your settings from the original theme module to the new Theme Installer. This ensures that you do not lose your customizations done via the module. Keep in mind this will not remember your file customizations.
6. Update Your License Key
Your license key is more than likely in the older format that is no longer supported. You find your new license key by logging into your account and navigating to "My Services" > "Licenses." Once loaded, you will see your license underneath your product information, as illustrated below:
7. Reload the Theme Installer to confirm license activation
Head back to your WHMCS admin portal and navigate to “Addons” > “SwiftModders WHMCS Theme Installer.” You will see that your theme should now have an “active” checkmark status, and the “Edit Settings” button loads without issue. If your license is still showing errors, please be sure to open a support ticket.
To re-apply your customizations, be sure to click the “Recompile” option under “Actions.”
8. Deactivate the original theme module
This is a cleanup step and is highly recommended. Now that the Theme Installer is set up and running successfully, you can deactivate and remove the original theme module. Head to your WHMCS admin portal and navigate to “Setup” > “Addon Module.” In your list of add-on modules, there may be a few different SwiftModders modules for each theme. Here is a list of all the older add-on modules:
- Allure WHMCS Theme
- SwiftModders WHMCS Client Theme
- SwiftModders WHMCS Admin Theme
Each module corresponds to the theme you may have, so it should be fairly easy to determine which belongs to the theme you just migrated to. Once you’ve identified the module, you will now click the “Deactivate” button. This will remove all of the tables associated with the module from your MySQL database.
This will not remove the files for your WHMCS installation, but you can remove those as well by utilizing your favorite FTP client or control panel file manager. You will find the module folders in:
/*whmcsroot*/modules/addons/
Each theme will have a module folder labeled as follow:
- allure_companion
- swiftmodders_admin_companion
- swiftmodders_companion
The following folder names clearly identify which theme module you would be removing, similar to the module names. Select the correct folder and delete the files. Once the deletion is complete, you have completely removed all traces of the old module.
Congratulations! You’ve completely migrated your theme to the new SwiftModders WHMCS Theme Installer. If you encounter any issues when going through this process, do not hesitate to reach out and open a support ticket.