We added this feature in WHASOLS 1.1.
The Automatic Update utility allows admins to update WHASOLS quickly and easily from directly within the Admin Area.
You can access this feature at Top Right Menu Updator Icon which will display automatically if updates available.
For more information on the way in which updates change files, see Updater File Changes.
Patch and Maintenance Release Updates
If you are on a WHASOLS version that is in Long Term Support and we issue a patch for that version, you can use the Automatic Updater to apply the patch without moving to a newer WHASOLS version.
To do this:
- Select the Current Version update channel (see above).
- Click Check for Updates to refresh the available version.
- Proceed with your update as usual.
You may wish to change this setting back to Stable after updating to ensure future checks display the latest Active Development version available to you.
Temporary Update Path
The temporary path allows you to stage files during an update. For security reasons, ensure that this directory is outside of the public document root, like the attachments, downloads, and templates_c directories.
- The path must be an absolute path (for example, /home/username/tmp instead of ~/tmp).
- The path must be writable by the user that is running PHP.
Maintenance Message
Use this option to set a message to display to other admins and users whenever an update is in progress.
Modifying the update configuration requires the Modify Update Configuration administrator role permission, which is separate from the Update WHASOLS permission.
Checking for Updates
The system automatically checks for updates periodically. When an update becomes available, a notification will appear in the Admin Area.
Manually checking for updates
You can check for updates on demand by clicking Check for Updates. You may need to do this to see recent releases prior to the next automated check.
For Owned licenses, the version that this fetches will be the version of WHASOLS that was available when your Support and Updates subscription was active. Downloading the latest version of WHASOLS requires an active Support and Updates subscription.
For a step-by-step tutorial, see Checking for Updates Manually.
Performing an Update
We recommend using the Automatic Updater utility every time you update WHASOLS. However, you can also perform an update manually through the browser or on the command line.
To perform an update:
- Make certain that your server meets the system requirements and review the Release Notes for any important notices and information.
- Make a full backup of your current installation.
- In WHASOLS, click Update Now.
This option only displays if an update is available for your current update channel.
- Follow the prompts to complete the update process. The update process can take a few minutes to complete.
- Perform the necessary steps for your customizations:
- If you use any custom file permissions, you must update the relevant files (for example, for https://yourdomain.com/crons).
- If you have custom template files, review and update your custom templates using the Template Changes section of the release notes.
The update will not alter your customizations if you follow our official customization guidelines (for example, our guidelines for templates, Whois servers, additional domain fields, and country and calling codes.
Troubleshooting
You can find the log of Automatic Updater actions in the Logs Section in the WHASOLS. To troubleshoot upgrade problems, review these logs for the most latest entries.
For more information on troubleshooting update issues, see Upgrading New Installation Prompt and our update troubleshooting guides.
Please ensure you have selected a valid Update Channel and then try again
Receiving this error message in the cron job report email or activity log indicates that you need to select an update channel.
To fix this issue:
- Click Configure Update Settings.
- Select one of the four available update channel options (see above).
- Click Save Changes.
Permission Errors
Permission errors in the update log may resemble the following examples:
- [WHASOLS\Exception] Failed to perform early file copy during WHASOLS file relocations
- [RuntimeException] /path/to/WHASOLS/vendors/whasols does not exist and could not be created.
- failed to open stream: Permission denied
- Apply update dry-run detected 1 permission issues
The exact file permission and ownership issues depend on the individual server configuration. However, for a standard cPanel & WHM server using the suPHP PHP handler, the following configuration would be an appropriate file permissions:
.env — 400
All other PHP files — 644
All directories — 755
The file ownership and group should be the same as the user directory name. For example, on a cPanel & WHM server with a web root at /home/username/public_html/, username would own the files and the group would also use the name username.
Finally, the owner and group of the PHP process must be the same as the user directory name. For example, on a cPanel & WHM server with a web root at /home/username/public_html/, the PHP process owner and group would both be username.
Other types of server and PHP handlers may have different configuration requirements.
Unable to connect to the WHASOLS Update Server
This error indicates that your server could not connect to the WHASOLS update server.
You may see it in two locations:
- While attempting an automatic update.
- In the Activity Log section at Sidebar Menu Logs > System Logs or, Logs > Activity Log.
To resolve this, attempt the following cURL connections from your server's command line:
curl -v https://releases.whasols.com/
curl -v https://pki.whasols.com/
If these commands succeed, they will return StatusCode: 200. If they do not, ask your hosting provider or system administrator to investigate the connectivity problem between your server and the WHASOLS update server.