Automatic Updater - Revision history

SarahK: /* Manually checking for updates */

2023-01-31T18:21:20Z

‎Manually checking for updates

SarahK: /* Choosing an Update Channel */

2022-11-28T21:46:19Z

‎Choosing an Update Channel

SarahK: /* Setting a Temporary Update Path */

2022-11-28T21:46:07Z

‎Setting a Temporary Update Path

SarahK: /* Setting a Maintenance Message */

2022-11-28T21:45:45Z

‎Setting a Maintenance Message

SarahK: /* Troubleshooting */

2022-10-20T16:35:23Z

‎Troubleshooting

SarahK: /* Performing an Update */

2022-10-20T16:33:49Z

‎Performing an Update

SarahK: /* Performing an Update */

2022-10-20T16:30:34Z

‎Performing an Update

SarahK: /* Performing an Update */

2022-08-17T18:48:32Z

‎Performing an Update

SarahK: /* Unable to connect to the WHMCS Update Server */

2022-08-17T18:41:42Z

‎Unable to connect to the WHMCS Update Server

SarahK at 18:25, 17 August 2022

2022-08-17T18:25:50Z

Show changes

@@ Line 86: / Line 86: @@
 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 WHMCS that was available when your Support and Updates subscription was active. Downloading the latest version of WHMCS requires an active Support and Updates subscription.
 == Performing an Update ==

@@ Line 22: / Line 22: @@
 == Configuring Your Update Settings ==
-=== Choosing an Update Channel ===
+=== Update Channel ===
 The Automatic Updater allows you to choose the update channel for the least stable version you are willing to update to:

@@ Line 63: / Line 63: @@
 </div>
-=== Setting a Temporary Update Path ===
+=== 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 <tt>attachments</tt>, <tt>downloads</tt>, and <tt>templates_c</tt> directories.
 * The path must be an absolute path (for example, <tt>/home/username/tmp</tt> instead of <tt>~/tmp</tt>).
 * The path must be writable by the user that is running PHP.
 === Maintenance Message ===

@@ Line 70: / Line 70: @@
 * The path must be writable by the user that is running PHP.
-=== Setting a Maintenance Message ===
+=== Maintenance Message ===
 Use this option to set a message to display to other admins and users whenever an update is in progress.
@@ Line 77: / Line 77: @@
 Modifying the update configuration requires the '''Modify Update Configuration''' [[Administrator Roles|administrator role permission]], which is separate from the '''Update WHMCS''' permission.
 </div>
 == Checking for Updates ==

@@ Line 114: / Line 114: @@
 You can find the log of Automatic Updater actions in the <tt>tblupdatelog</tt> table in the WHMCS database. To troubleshoot upgrade problems, review this table for the most recent entries (the highest <tt>id</tt> values). You can use a tool like phpMyAdmin to browse the table's contents.
-For more information on troubleshooting update issues, see [http://help.whmcs.com/m/updating Updating] and [[Upgrading New Installation Prompt]].
+For more information on troubleshooting update issues, see [[Upgrading New Installation Prompt]] and [http://help.whmcs.com/m/updating our update troubleshooting guides].
 ===Please ensure you have selected a valid Update Channel and then try again===

@@ Line 92: / Line 92: @@
 == Performing an Update ==
-<div class="docs-alert-success">
+<div class="docs-alert-info">
 We recommend using the '''Automatic Updater''' utility every time you update WHMCS. However, you can also perform an update [https://go.whmcs.com/1709/Updating-WHMCS-Manually manually through the browser] or [[Install On The Command Line|on the command line]].
 </div>
@@ Line 100: / Line 100: @@
 # Make certain that your server meets the [[System_Requirements|system requirements]] and review the [[Release Notes]] for any important notices and information.
 # Make a full backup of your current installation.
-# In WHMCS, click '''Update Now'''. <div class="docs-alert-info"><i class="fa fa-info-circle"></i>This option only displays if an update is available for your current update channel.</div>
+# In WHMCS, click '''Update Now'''. <div class="docs-alert-warning"><i class="fa fa-info-circle"></i>This option only displays if an update is available for your current update channel.</div>
 # Follow the prompts to complete the update process. The update process can take anywhere from 30 seconds to a few minutes to complete.
+# Perform the necessary steps for your customizations:
-If you have custom template files you will also need to review and make any necessary changes to your custom templates using the '''Template Changes''' section of the [[Release_Notes|Release Notes]].
+#* If you use any custom file permissions, you '''must''' update the relevant files (for example, for <tt>/crons/pipe.php</tt>).
 <div class="docs-alert-success">
-* The update will not alter your customizations if you follow our recommendations (for example, our guidelines for [https://developers.whmcs.com/themes/ templates], [[WHOIS_Servers|Whois servers]], [[Additional Domain Fields|additional domain fields]], and [[Customising Countries and Calling Codes|country and calling codes]].
+The update will not alter your customizations if you follow our official customization guidelines (for example, our guidelines for [https://developers.whmcs.com/themes/ templates], [[WHOIS_Servers|Whois servers]], [[Additional Domain Fields|additional domain fields]], and [[Customising Countries and Calling Codes|country and calling codes]].
 </div>

← Older revision		Revision as of 16:30, 20 October 2022
Line 91:		Line 91:

	== Performing an Update ==		== Performing an Update ==
		+
		+	<div class="docs-alert-success">
		+	We recommend using the '''Automatic Updater''' utility every time you update WHMCS. However, you can also perform an update [https://go.whmcs.com/1709/Updating-WHMCS-Manually manually through the browser] or [[Install On The Command Line\|on the command line]].
		+	</div>

	To perform an update:		To perform an update:

@@ Line 147: / Line 147: @@
 ===Unable to connect to the WHMCS Update Server===
-You may see this error in two locations:
+This error indicates that your server could not connect to the WHMCS update server.
 * While attempting an automatic update.
 * In the '''Activity Log''' section at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Activity Log'''.
 To resolve this, attempt the following cURL connections from your server's command line: