The cPanel & WHM Update Configuration File — /etc/cpupdate.conf

Introduction

The /etc/cpupdate.conf file on your server determines how cPanel & WHM will update the following:

  • cPanel & WHM itself
  • Packages installed by cPanel & WHM
  • Packages installed by the operating system
  • SpamAssassin rules

Editing /etc/cpupdate.conf

Each line of the /etc/cpupdate.conf file specifies how cPanel & WHM will update a certain aspect of the system.

You can edit this file 2 ways:

  • Manually, using your preferred text editor via the command line
  • By using the WHM Update Preferences feature — each setting on the screen changes a setting in the file

Using the command line to edit the file

To edit /etc/cpupdate, simply use a command line text editor (such as vi or nano).

You will need to understand the file's format:

  • /etc/cpupdate.conf uses key=value pairs. Each pair must be on its own line.
  • Spaces are not allowed either in the key or the value.
  • A single "equals" sign (=) delimits the key from the value.
  • Both the key and value are case-sensitive. Keys must be uppercase. Values must be lowercase.
    • Example: CPANEL=stable

Settings and their meanings

Configuration values

You may set each option below to one of the following values:

Value Description
daily The software can update via any of the following:
1) A daily /usr/local/cpanel/scripts/upcp cron job
2) The administrator running /usr/local/cpanel/scripts/upcp on the command line
3) The administrator using the WHM Update Preferences screen
manual The software can update via any of the following:
1) The administrator running /usr/local/cpanel/scripts/upcp on the command line
2) The administrator using the WHM Update Preferences screen
never The software cannot update.
inherit The software will adopt the update configuration you set for SYSUP in /etc/cpupdate.conf. (e.g. daily, manual, or never)

Update settings for cPanel-installed packages

The following settings correspond to the individual cPanel Package Updates on the WHM Update Preferences screen.

These settings define whether a cPanel-installed package will update when its update script is run.

note Note: When the cPanel update script (/usr/local/cpanel/scripts/upcp) runs, it runs each package's update script. (See the table below for a list of update scripts.)

Setting Update script affected by the setting Service affected by the setting Values accepted
BANDMINUP /usr/local/cpanel/scripts/bandminup Bandmin, a collection of Perl scripts for logging IP accounting data. inherit, never
COURIERUP /usr/local/cpanel/scripts/courierup Courier mail server, a mail transfer agent (MTA) that provides ESMTP, IMAP, POP3, webmail, and mailing list services. inherit, never
DOVECOTUP /usr/local/cpanel/scripts/dovecotup Dovecot, an open-source IMAP and POP3 mail server. inherit, never
EXIMUP /usr/local/cpanel/scripts/eximup Exim, a mail transfer agent (MTA). inherit, never
FTPUP /usr/local/cpanel/scripts/ftpup Pure-FTPd and ProFTPd file transfer protocol (FTP) servers. inherit, never
MYSQLUP /usr/local/cpanel/scripts/mysqlup MySQL relational database management software. inherit, never
NSDUP /usr/local/cpanel/scripts/nsdup NSD, an open-source nameserver daemon. inherit, never
PYTHONUP /usr/local/cpanel/scripts/pythonup Python, a programming language. inherit, never

Update settings for other software

Setting Meaning Values accepted Corresponding setting in WHM Update Preferences screen
BSDPORTS Whether to install packages from source using the FreeBSD ports tree (yes), or install binary packages that the FreeBSD project distributes (no).
This setting appears on all servers, but is effective for FreeBSD servers only.
yes, no FreeBSD Ports Package Updates
PORTSUP Whether cPanel & WHM will manage updates to the FreeBSD ports tree (/usr/ports).
This setting appears on all servers, but is effective for FreeBSD servers only.
yes, no None
CPANEL Determines the cPanel & WHM update tier for the server. edge, current, release, stable cPanel & WHM Updates > Release Tier
RPMUP Determines the frequency of updates for packages installed by the operating system.
This setting appears on all servers, but is effective for Linux servers only.
daily, manual, never Operating System Package Updates
SARULESUP Determines the frequency of updates for SpamAssassin rules. daily, manual, never SpamAssassin® Rules Updates
SYSUP Determines the frequency of updates for packages provided by the operating system. daily, manual, never cPanel Package Updates
UPDATES Determines whether the update will occur automatically or manually. daily, manual, never cPanel & WHM Updates > Daily Updates

Topic revision: r2 - 01 Jun 2011 - 18:33:29 - Main.JustinSchaefer