Difference between revisions of "Automatic Updater"
(→Checking for Updates) |
(→Requirements) |
||
| Line 2: | Line 2: | ||
== Requirements == | == Requirements == | ||
| − | * | + | * At least 250 MB of free disk space |
| − | * | + | * PHP setting allow_url_fopen enabled |
| − | * | + | * PHP max_execution_time in excess of 60 seconds |
| − | + | * PHP Zip Extension or the proc_open PHP function enabled | |
| − | * | + | * PHP setting open_basedir to include entire WHMCS docroot |
== Checking for Updates == | == Checking for Updates == | ||
Revision as of 15:26, 8 August 2016
Contents
Requirements
- At least 250 MB of free disk space
- PHP setting allow_url_fopen enabled
- PHP max_execution_time in excess of 60 seconds
- PHP Zip Extension or the proc_open PHP function enabled
- PHP setting open_basedir to include entire WHMCS docroot
Checking for Updates
Introduced in WHMCS 7.0.0, the Automatic Updater provides admins with a quick and easy way to update to new versions of WHMCS with just a few clicks in the admin area interface. The system will check for new updates on each cron run. Upon logging into the WHMCS admin area, a notification will appear in the top right corner of admin area. This alert will let the admin know if a new version of WHMCS is available, or if the version of WHMCS that is currently installed is the latest version. Below are examples of what these notifications look like:
Admins can also manually check for updates by navigating to the Utilities top menu in the admin area interface and select Update WHMCS.
Once selected, the admin will be asked to confirm their password, as only admin users that have the "Update WHMCS" admin role will be able to access the updater.
Once in the Automatic Update interface, admins can tell at a glance what version of WHMCS that is installed, as well as check for updates using the Check for Updates button.
By clicking Check for Updates, the version indicated in Your Version on the left side of the version summary will stay the same, but the information presented in the Latest Version on the right side of the version summary may be updated depending if a new update is available. It should also be noted that the Check Now button also indicates the last time an update check was performed. If a new version is available for upgrade, admins can then begin the update process by clicking the Update Now button.
Configuring Your Update Settings
The Automatic Updater also presents admins with the ability to configure update settings such as choosing an update channel, setting a temporary update path, and setting an update maintenance message for customers. Note that accessing the update configuration page requires "Modify Update Configuration" administrator role, which is separate from "Update WHMCS" role.
Choosing an Upgrade Channel
The automatic updater provides admins with the ability to set the release stability that they are comfortable receiving. Admins will be able to select from the following channels:
| Channel | Description |
| Stable | Recommended for most installations of WHMCS, the Stable channel will present admins with the latest stable version that has been released by WHMCS. |
| Release Candidate | Admins subscribed to the Release Candidate will be able to upgrade to the latest Release Candidate builds of WHMCS, or the latest stable version of WHMCS - whichever is newer. This means if WHMCS is upgraded to 7.0.0-rc.1, when 7.0.0-GA is released, the admin will be prompted to upgrade to the general availability that was just released. |
| Beta | Admins subscribed to the Beta release channel will be able to download the newest beta, release candidates, and stable versions of WHMCS. This is for testing installations, as it will allow admins to update to the latest WHMCS (beta, rc, or stable). WHMCS recommends development licenses use this channel. |
| Current Version | By selecting this channel, admins are electing to only receive maintenance updates for the major/minor version they are on. For example if the installed version of WHMCS is running 7.0.0-GA, admins will be offered 7.0.1-GA, but not 7.1.0. This channel is useful if the installed version of WHMCS has a number of 3rd party modules and customizations that need to be tested before upgrading to a new production release. |
Setting a Temporary Update Path
The temporary path is used for staging files during an update. For security reasons it is recommended that this directory be located outside the public doc root, just like the attachments, templates_c, and downloads directories. The path must be an absolute path (i.e. /home/whmcsuser/tmp instead of ~/tmp) and must be writable by the admin that is running PHP.
Setting a Maintenance Message
Admins can use this option to set a message that will be displayed to users in the client area whenever an update is in progress, as the client and admin areas will be unavailable during an update.
Performing an Update
Beginning the Update Process
Once the update configuration options have been set, admins can begin the update process. Before the update process begins, WHMCS strongly recommends that admins backup their current installation and database. WHMCS also recommends that at least 250 MB of disk space is available before beginning the update process. Once comfortable with the available disk space and backups have been made to the current installation and database, the admin can start the update by clicking the Continue button.
Checking for Custom Files
The next step in the upgrade process checks the current installation for customized files, such as template files, language translations, whois server entries, and additional domain fields. It's important to review these files, as just like in previous updates, any update applied to the installation of WHMCS will override any custom changes. Before continuing to the next step in the upgrade process, it is wise to backup any customized files in order to quickly apply them again after the update has been complete. WHMCS has also included changes to how admins can customize the additional domain fields, country / calling codes, and whois server entries so that admins can preserve changes between updates. To view this documentation, please refer to following documentation pages:
Starting the Update
Once an admin is comfortable with the status of their custom files, the next step in the update process is to start the update itself. It's important to note that this third step is the point of no return - one the update has started, there is no pausing or stopping the process, and it is strongly recommended that admins stay on this page and do not navigate away using their browser. When ready to begin, click the Update Now button.
Finalizing the Update
The final step of the update process is confirmation that the update has been completed. The system will present the admin with an Update Completed message, along with a link to the current version's release notes.
