The cPanel & WHM Update Configuration File - cpupdate.conf


Last modified: February 19, 2024

Overview

The /etc/cpupdate.conf file on your server determines how cPanel & WHM updates the following system components:

  • cPanel & WHM itself.
  • Installed packages (Package Manager files).
  • Apache SpamAssassin™ rules.

How to edit the configuration file

Each line of the /etc/cpupdate.conf file determines how cPanel & WHM updates the specified system component. You can edit this file with your preferred text editor.

File format

The /etc/cpupdate.conf file’s format is similar to the following example:

1
2
3
4
5
CPANEL=release
RPMUP=daily
SARULESUP=daily
STAGING_DIR=/usr/local/cpanel
UPDATES=daily
Notes:
  • Each KEY=value pair is on a separate line.
  • A single equals sign (=) separates the uppercase KEY and lowercase value.
  • The file must not contain spaces.
  • In the example above, /usr/local/cpanel is the default staging directory for the /etc/cpupdate.conf file.

Configuration values

The following keys and values determine how to update specified components of the system:

CPANEL

This setting determines the server’s release tier or product version. The CPANEL setting appears in WHM’s Update Preferences interface (WHM » Home » Server Configuration » Update Preferences) as the Release Tier setting.

You can specify either of the following value types:

  • A release tier name (edge, current, release, stable, or lts), to ensure that your server always uses the appropriate version for that tier.
  • A cPanel & WHM version number, to specify an exact version (for example, 118, 11.118, or 118.123.45)
    Warning:

    You must enter supported version number. Specifying an unsupported version number will cause the installation to fail. For more information, read our Product Versions and the Release Process documentation.

For example:

CPANEL=release

For the latest information on cPanel & WHM version numbers and tiers, see the Latest cPanel & WHM Builds (All Architectures) table in the cPanel Downloads page.

RPMUP

This setting determines how to update the operating system’s packages. The /usr/local/cpanel/scripts/update-packages script uses this value.

You can specify one of the following values:

  • daily — Update packages daily.
  • manual — Update packages manually (for example, via the command line).
  • never — Prevent both automatic and manual updates to packages.

For example:

RPMUP=daily
SARULESUP

This setting determines how to update Apache SpamAssassin™ rules. The /usr/local/cpanel/scripts/sa-update_wrapper script uses this value.

You can specify one of the following values:

  • daily — Update rules daily.
  • manual — Update rules manually (for example, via the command line).
  • never — Prevent both automatic and manual updates to rules.

For example:

SARULESUP=daily
STAGING_DIR

This setting determines the location of the staging directory for the update files. The default staging directory value is /usr/local/cpanel.

The STAGING_DIR setting appears in WHM’s Update Preferences interface (WHM » Home » Server Configuration » Update Preferences) as the Staging Directory setting.

You can specify any valid path. In this example, /valid/path stands for the valid path that you wish to use.

STAGING_DIR=/valid/path
UPDATES

This setting determines how to update cPanel & WHM when updates become available. The /usr/local/cpanel/scripts/upcp script uses this value.

You can specify one of the following values:

  • daily — Update cPanel & WHM daily.
  • manual — Update cPanel & WHM manually (for example, via the command line).

For example:

UPDATES=daily

Additional Documentation