|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| − | You can update your WHMCS installation manually using your hosting control panel's file management system to manage the necessary files.
| + | #REDIRECT [[Updating#Updating_Manually]] |
| − | | |
| − | <div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>You can also update WHMCS [[Automatic_Updater|from within the Admin Area]] or [[Install_On_The_Command_Line|on the command line]].</div>
| |
| − | | |
| − | ==Preparation==
| |
| − | | |
| − | Some updates may require steps in addition to the standard update steps below. We recommend that you check the following documents for requirements before '''every''' update:
| |
| − | | |
| − | * [[Updating]]
| |
| − | * The applicable [[Release Notes]].
| |
| − | | |
| − | If you have custom template files, you will also need to review and make any necessary changes to your custom templates.
| |
| − | | |
| − | <div class="docs-alert-danger">
| |
| − | <span class="title">Pre-Update Backups</span><br />
| |
| − | You must '''always''' create a full backup before attempting any kind of update for WHMCS or any other software you use. In your full backup, include both the WHMCS files and the database.'''
| |
| − | </div>
| |
| − | | |
| − | ==Update Steps==
| |
| − | | |
| − | You can choose whether to update using one of two distribution types: '''Full Release''' or '''Patch Set'''. For more information on each distribution type, see [[Updating]].
| |
| − | | |
| − | ===Full Release===
| |
| − | | |
| − | A full release version includes:
| |
| − | | |
| − | * <tt>_full</tt> within the <tt>.zip</tt> folder filename.
| |
| − | * <tt>Distro Type: Full Version</tt> within the included <tt>README.txt</tt> file.
| |
| − | | |
| − | If the <tt>.zip</tt> filename contains <tt>_patch</tt>, see the section below.
| |
| − | | |
| − | To update for a full release version:
| |
| − | | |
| − | # Make certain that your system meets our [[System_Requirements|system requirements]].
| |
| − | # Obtain the latest full release download of WHMCS from http://download.whmcs.com/ or, if you use a reseller, from your license provider. | |
| − | # Unzip the contents of the downloaded WHMCS <tt>.zip</tt> file to a folder on your computer.<div class="docs-alert-danger"><span class="title">Custom Admin Directory?</span><br />If you have renamed your "admin" directory, rename the <tt>/whmcs/admin</tt> directory in the new files to match. </div><div class="docs-alert-warning"><span class="title">Custom Cron Directory?</span><br />If you have customised the location of the <tt>/crons/</tt> directory, be sure to upload that to the custom location.</div><div class="docs-alert-success"><span class="title">Custom File Permissions?</span><br />If you have customised the permissions on any of the files (for example, <tt>/crons/pipe.php</tt>). You must reapply these changes after the update is complete.</div>
| |
| − | # Upload the new files to your existing installation folder, replacing any existing folders and files.
| |
| − | # Visit the update page at <tt>example.com/whmcs/install/install.php</tt>. If you see a message that states that you have not installed WHMCS, you may have overwritten the <tt>configuration.php</tt> file for your installation. Stop and restore that file from your backup before continuing.
| |
| − | # Agree to the WHMCS End User License Agreement and follow the prompts to update your database.
| |
| − | # When the system prompts you, delete the installation folder from your server.
| |
| − | | |
| − | ===For a Patch Set===
| |
| − | | |
| − | A patch set version includes:
| |
| − | | |
| − | * <tt>_patch</tt> within the <tt>.zip</tt> folder name.
| |
| − | * "Distro Type: Patch Set" within the included <tt>README.txt</tt> file.
| |
| − | | |
| − | <div class="docs-alert-warning">
| |
| − | <span class="title">Version Requirements</span><br />
| |
| − | Before you begin, you '''must''' make certain that you are running the correct version for the patch set (the version immediately before the patch set's version). Patch sets only contain the files that changed since the previous release.
| |
| − | | |
| − | The previous release version that we designed these patch sets for is part of the first and smaller number in release notices providing the patch set download link.
| |
| − | </div>
| |
| − | | |
| − | To update using a patch set:
| |
| − | | |
| − | # Download the patch set from http://download.whmcs.com/.
| |
| − | # Unzip the patch set files.<div class="docs-alert-danger"><span class="title">Custom Admin Directory?</span><br />If your patch set includes changes to the <tt>admin</tt> directory and you have renamed your "admin" directory, rename the <tt>/whmcs/admin</tt> directory in the new files to match. </div>
| |
| − | # Upload the files from the <tt>/whmcs/</tt> directory to the root directory of your WHMCS installation.
| |
| − | # Visit the admin area of your WHMCS installation to trigger the version number increment and complete the process.
| |
| − | | |
| − | This method doesn't require an installation or update process.
| |
| − | | |
| − | ==Confirming a Successful Update==
| |
| − | | |
| − | To confirm that an update applied successfully, log in to your WHMCS [[Admin Area]]. Then, check to make sure that the version number on either the admin homepage (in the sidebar of all default templates) or in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Health Status|System Health]]''' or, prior to WHMCS 8.0, '''Help > System Health Status]]''' is the version that you attempted to apply.
| |
| − | | |
| − | If it has not incremented, then one or more of the files has not uploaded successfully. Check your file permissions and attempt the steps again from the beginning.
| |