Update Preferences

Valid for versions 82 through 84

Version:

82

86


Last modified: May 13, 2020

Overview

This interface allows you to define how your server performs software updates and upgrades.

Warning:
  • Before upgrading your server’s cPanel & WHM version, make sure that the new version is compatible with your system. We recommend staging the upgrade on a test system before upgrading your production system.

  • After you upgrade to a new major version of cPanel & WHM, you cannot downgrade to a previous major version of cPanel & WHM. For this reason, you cannot select a release tier that represents a downgrade. An icon appears next to the description for tiers that represent a downgrade.

  • If you are upgrading from a very old version of cPanel & WHM, you may experience problems.

    • To resolve this issue, manually upgrade to an intermediate version using the /etc/cpupdate.conf file. Then, you can proceed to the final target version.
    • If you need assistance, contact cPanel Technical Support.
  • cPanel & WHM installs the at daemon (atd) during the update process. This daemon validates the system’s health after each update. If the update analysis process encounters any errors, the at daemon emails a report to your contact email address.

Release Tier

This section of the interface allows you to select a release tier. The release tier that you select controls when the system performs an upgrade to a new major version of cPanel & WHM. Additionally, this allows you to specify how your server performs an update within a major version.

You can select the following cPanel & WHM release tiers:

LTS

Long-Term Support (LTS). Use this tier to select a single cPanel & WHM version for the year during which cPanel, L.L.C. supports it.

Note:

We only ship one LTS version per year.

STABLE

This version has received considerable public exposure, testing, and verification.

We publish this tier less often than RELEASE.

RELEASE

This version is feature-complete and we tested it thoroughly. It contains all intended features and functionality. New installations default to RELEASE.

We publish this tier less often than CURRENT.

CURRENT

We tested and verified this version, but it may not contain all of the proposed functionality of a release. This tier resembles the “release candidate” tier that other publication schemes use.

We publish this tier less often than EDGE.

EDGE

We only perform rudimentary testing on this version. We may significantly modify these features in future releases. This version usually lacks official public documentation.

This version is published most frequently (up to several times per week).

Warning:

Due to the dynamic nature of EDGE builds, only use EDGE to test for compatibility and functionality in a controlled environment. We do not recommend this tier for production servers.

Automatic update delay

To help us provide the best possible support, automatic upgrades to subsequent major versions of cPanel & WHM do not always occur immediately. This depends on your release tier.

  • If your server meets all of the delay requirements, the system applies a delay of several business days before your automatic upgrade executes.
  • The system randomly selects the length of your delay.

The system applies a delay if all of the following statements are true:

  • You use the RELEASE or STABLE tiers.

    Note:

    Servers on the EDGE, CURRENT, or LTS tiers, or that use a specific build or version instead of a named tier, won’t experience delays.

  • You don’t run the upgrade manually.

  • Upgrading will only update the server by one major version (for example, from version 78 to version 80).

  • You do not run the upgrade with either:

    • The --force option when you run the /scripts/upcp script.
    • The Force setting in WHM’s Upgrade to Latest Version interface (WHM >> Home >> cPanel >> Upgrade to Latest Version).

When we release a major version, you may perform any of the following actions:

  • Use either of the following methods to update immediately:
    • The --force option when you run the /scripts/upcp script.
    • The Force setting in WHM’s Upgrade to Latest Version interface (WHM >> Home >> cPanel >> Upgrade to Latest Version).
  • Do nothing to allow the automatic upgrade to occur.
  • To prevent future delayed upgrades, change your release tier.

Daily Updates

Use this menu to select how you want cPanel & WHM to update. You can choose from the following options:

  • Automatic — Select this option if you want cPanel & WHM to automatically update through a cron job every night at midnight.
  • Manual — Select this option if you wish to manually update cPanel & WHM.
  • Never — Select this option if you do not want cPanel & WHM to update.
Note:

The maintenance portion of the /usr/local/cpanel/scripts/upcp script always runs as part of the nightly cron job, regardless of the update settings.

Staging Directory

The upgrade to newer versions of cPanel & WHM requires a minimum amount of disk space in order to stage the files necessary. This feature determines where the system places the staging files.

Note:

If the selected directory does not have enough disk space for the update, the system automatically selects a different directory for the next attempt. An email will notify you of the new selection, and you will have 24 hours to change the new directory.

To select the staging directory for the updates, perform one of the following actions:

  • Keep the default directory in the Staging Directory text box. This defaults to the /usr/local/cpanel directory.
  • Enter a new directory in the Staging Directory text box. If you enter a path to a different directory, the system will automatically create the .cpanel__HOSTNAME__upcp_staging subdirectory at that location, where HOSTNAME is the name of the actual server.
  • Select a partition from the Available Partitions table.

Operating System Packages

This feature determines whether the nightly maintenance tasks will update the RPM packages from your operating system distribution. This is similar to the yum update command.

  • Automatic — Automatically update the operating system packages whenever the /usr/local/cpanel/scripts/upcp script runs.
  • Manual — Only update operating system packages manually via the /usr/local/cpanel/scripts/upcp script.
  • NeverDon’t update the operating system packages when the /usr/local/cpanel/scripts/upcp script runs. If you select this option, you must run the /usr/local/cpanel/scripts/rpmup2 script to update your operating system packages.
Note:
  • This setting does not impact cPanel-provided RPMs.
  • In cPanel & WHM version 68 and later, the /usr/local/cpanel/scripts/sysup script automatically updates the EasyApache 4 RPMs. The following settings will not prevent automatic updates:
    • An RPMUP value of never in the /etc/cpupdate.conf file.
    • An Operating System Packages setting of Never in this interface.
  • You can prevent the /usr/local/cpanel/scripts/upcp script from creating new EasyApache 4 yum repositories if they don’t already exist. To do this, use the touch command to create the the /var/cpanel/skip-repo-setup file. For example:
    <pre><code>touch /var/cpanel/skip-repo-setup
    </code></pre>

Apache SpamAssassin™ Rules

This feature defines how you wish to update the Apache SpamAssassin rules.

  • Automatic — Automatically update Apache SpamAssassin rules whenever the /usr/local/cpanel/scripts/upcp script runs.
  • Manual — Only update Apache SpamAssassin rules manually via the /usr/local/cpanel/scripts/upcp script.
  • NeverDon’t update Apache SpamAssassin rules when the /usr/local/cpanel/scripts/upcp script runs.
Note:
  • When the cPanel update script (/usr/local/cpanel/scripts/upcp) runs, it updates Apache SpamAssassin through the Apache SpamAssassin update script (/usr/local/cpanel/scripts/sa-update_wrapper).
  • For more information about Apache SpamAssassin rules, read the Apache SpamAssassin documentation.

Send my settings to all configuration cluster servers

Select this checkbox to send your Update Preferences settings to all of the servers that currently exist in your configuration cluster.

Note:

The interface only displays the Send my settings to all configuration cluster servers checkbox if you have already added additional servers to the configuration cluster with WHM’s Configuration Cluster interface (WHM >> Home >> Clusters >> Configuration Cluster).

If you selected this option, the interface may require several seconds to load when you click Save, and will then display a confirmation message with the following information:

  • An error icon (Error Icon) in the Status column indicates that the server failed to receive the settings.
  • The Message column displays additional information about servers that failed.

Click Show Details to view the status of each server in the configuration cluster.

Additional Documentation