Installation Guide - Customize Your Installation


Before you begin the installation process, you can customize the configuration for certain portions of cPanel & WHM.

Installation methods

New installations of cPanel & WHM use the fast installation method by default. This method handles certain aspects of cPanel & WHM differently to drastically reduce installation time. For example, the fast installation method:

  • Uses tarballs to download certain code cPanel & WHM files.
  • Uses system RPMs or .deb packages, if they are available, to set up the Perl local::lib library.
    • Red-Hat-based systems, like AlmaLinux OS, Rocky Linux™, or CloudLinux™, use RPMs.
    • Debian-based systems, like Ubuntu®, use .deb packages.

Installation options

You can use the following options to customize cPanel & WHM’s installation process:

  • --confirm — Require confirmation before the installation script runs.
  • --force — Force installation on an unrecommended configuration.
  • --keep — Do not delete the target directory after installation.
  • --nochown — Do not assign permissions for the extracted files to the current user.
  • --noexec — Do not run the installation script.
  • --nox11 — Do not spawn an X terminal input terminal.
  • --skip-cloudlinux — Skip the automatic CloudLinux conversion process even if a license exists.

    If you do not use this option, and you install cPanel & WHM on a Red Hat® Enterprise Linux® (RHEL)-based server with a CloudLinux license, the installer will automatically convert the server to CloudLinux.

  • --skip-wptoolkit — Skip the automatic installation of WP Toolkit.
  • --skip-imunifyav — Skip the automatic installation of ImunifyAV.
  • --target NewDirectory — Extract the cPanel & WHM installation files to the NewDirectory directory.
  • --tar arg1 [arg2 ...] — Access the contents of the arg1 archive through the tar command.

Basic server setup

The /etc/wwwacct.conf file contains the basic setup information for cPanel & WHM. After you install cPanel & WHM, you can find and edit this information in WHM’s Basic WebHost Manager Setup interface (WHM » Home » Server Configuration » Basic WebHost Manager® Setup).

To customize this configuration, perform the following steps:

  1. As the root user, create the /etc/wwwacct.conf file.
  2. Enter all of the wwwacct.conf file’s parameters, with one entry per line:

    Separate each parameter and its value with a space.

    NS2 ns2.domain.tld
    CONTACTPAGER [email protected]
    LOGSTYLE combined
    CONTACTEMAIL [email protected]
    HOMEMATCH home
    TTL 14400
    NSTTL 86400
    NS ns1.domain.tld
    ETHDEV eth0
    DEFMOD jupiter
    HOMEDIR /home
  3. Define the required ADDR or ADDR6, DEFMOD, HOMEDIR, LOGSTYLE, NS, NS2, and SCRIPTALIAS values.

    If you do not define these values, account creation will fail.

    For example:
    DEFMOD jupiter
    HOMEDIR /home
    LOGSTYLE combined
    NS ns1.domain.tld
    NS2 ns2.domain.tld

    In this example, ns1.domain.tld and ns2.domain.tld are your nameservers’ identities.

  4. Specify values for any other parameters that you wish to configure. Refer to the configuration values table for a complete list of available parameters.

Configuration values

You can configure the following values in the /etc/wwwacct.conf file:

Value Description Example
ADDR Required
The server’s shared IPv4 address. If you do not specify this value, you must specify an ADDR6 value.
  • If you will run the server in NAT mode, use the internal IP address for this value.
  • Due to networking requirements, you cannot run an IPv6-only cPanel & WHM server. You must have at least one IPv4 address.
ADDR6 Required
The server’s shared IPv6 address. If you do not specify this value, you must specify the ADDR value.
CONTACTEMAIL The system administrator’s contact email address. [email protected]
CONTACTPAGER The number to which the server sends Short Message Service (SMS) notifications. [email protected]
DEFMOD Required
The default cPanel theme that you wish to use for newly-created accounts. This value does not impact cPanel theme behavior for existing accounts.
ETHDEV The default ethernet device.
  • This parameter defaults to the eth0 value.
  • Specify venet0:0 if the server runs Virtuozzo®.
HOMEDIR Required
The path to the default home directory.
HOMEMATCH A string that determines which partitions to use as home directories for new accounts. (For example, a value of users matches system mounts of users, users1, or users3.) home
HOST The server’s hostname. hostname
The Apache log format to use. You must define this value as combined.
NS Required
The primary nameserver to add to DNS zones by default.
NS2 Required
A second nameserver to add to DNS zones by default.
NS3 An additional nameserver to add to DNS zones by default. ns3.domain.tld
NS4 An additional nameserver to add to DNS zones by default. ns4.domain.tld
NSTTL The default time to live (TTL) value that DNS zones will use. 86400
Whether the system aliases a /cgi-bin/ directory on account creation. This value only accepts y or n.
TTL The default time to live value. 14400

Configuration settings

When you install cPanel & WHM, the system reads the /root/cpanel_profile/cpanel.config file. This file stores the settings that WHM’s Tweak Settings interface (Home » Server Configuration » Tweak Settings) contains, as well as various configuration settings for other cPanel & WHM features. The system uses these settings to set the values in the /var/cpanel/cpanel.config file.


Some of the values that the /root/cpanel_profile/cpanel.config file contains are dynamic, or require specific values.

To set these parameters, perform the following steps:

  1. As the root user, create the /root/cpanel_profile/cpanel.config file.
  2. With one entry per line, list the parameters and values that you wish to configure in key=value format.

For example, to preconfigure your server to deny the nobody user the ability to send email to a remote address, add the nobodyspam=1 line to the /root/cpanel_profile/cpanel.config file before you install cPanel & WHM.

The mysql-version key

You can configure the version of MySQL® or MariaDB® to use in the /root/cpanel_profile/cpanel.config file’s mysql-version key before you install cPanel & WHM. To ensure that your cPanel & WHM installation uses your intended database version, your mysql-version key must meet the following requirements:

  • Your mysql-version key requires a single decimal point. We do not support the configuration of specific database build versions: for example, MySQL 8.0.29.
  • Your mysql-version key cannot contain strings. For example, if you install cPanel & WHM with a mysql-version key of MySQL 8.0, the installation process will fail. To configure a cPanel & WHM installation to use MySQL 8.0, instead enter a mysql-version key of 8.0.
  • If you set the mysql-version key to an unsupported database version (for example, mysql-version=5.1), the installation process will fail. For more information about supported database versions, read our Supported MySQL/MariaDB versions documentation.

We do not support the mysql-version configuration of existing cPanel & WHM installations.

Account restoration

The /etc/cpanelacctrestore file contains a list of accounts to automatically restore during the cPanel & WHM installation process. You can use this file to restore accounts to a freshly-installed server.


When you create a backup file, you must use one of the following formats:

  • cpmove-{USER}
  • cpmove-{USER}.tar
  • cpmove-{USER}.tar.gz
  • {USER}.tar
  • {USER}.tar.gz
  • backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar
  • backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz

To restore a list of cPanel accounts during the cPanel & WHM installation process, perform the following steps:

  1. As the root user, use a text editor to create the /etc/cpanelacctrestore file.
  2. List the user account names, one entry per line.
  3. Upload the backup file or files to one of the following directories:
    • /home
    • /home2
    • /home3
    • /root
    • /usr
    • /usr/home
    • /web

Release tiers

The /etc/cpupdate.conf file determines the product version for your installation of cPanel & WHM. This file also controls when your server performs the automatic upgrades to new major versions of cPanel & WHM.

When you preconfigure this file, cPanel & WHM will install the specified version or the major version that corresponds to the specified release tier.


To preconfigure the cPanel & WHM release tier, perform the following steps:

  1. As the root user, create the /etc/cpupdate.conf file.
  2. In the /etc/cpupdate.conf file, use the CPANEL parameter to set your desired release tier.

For example, to configure your server to use the STABLE tier, add the CPANEL=stable value to the /etc/cpupdate.conf file.

The cpsources file


Invalid modifications to this file may cause serious problems. We strongly recommend that you do not modify this file unless you understand the full technical ramifications of your actions and can maintain these customizations.

The /etc/cpsources.conf file determines the locations from which your server downloads updates. By default, cPanel & WHM servers retrieve updates directly from cPanel, L.L.C. through our pool of update servers.

Invalid data

If you see the following error in your server’s logs, the /etc/cpsources.conf file likely contains invalid data:

[2015-12-08 14:12:54 +0200] ***** FATAL: Unable to retrieve tier version info: timeout

To resolve this issue, move the /etc/cpsources.conf file to another location, then run the /usr/local/cpanel/scripts/upcp script. The system will automatically restore a valid cPanel-supplied version of the /etc/cpsources.conf file.


To disable FastUpdate on your server, use SSH to connect to your server as the root user and run the following command:

touch /var/cpanel/never_ever_use_fast_update_not_even_a_check

To reenable FastUpdate on your server, use SSH to connect to your server as the root user and run the following command:

rm /var/cpanel/never_ever_use_fast_update_not_even_a_check


Yellowdog Updater, Modified (yum) is an RPM package management tool for Linux servers that automatically installs with your operating system.

  • When you install cPanel & WHM, you must only use vendor-provided repositories. Third-party repositories may replace vital parts of the system and cause unexpected results.
  • The yum tool and commands do not work on Debian-based Linux servers, like Ubuntu®.

Exclude packages

Because cPanel & WHM handles its own installation of services through the rpm.versions system, the installer automatically configures the /etc/yum.conf file to exclude the following packages:

AlmaLinux 9, Rocky Linux 9, and CloudLinux 9

  • MySQL55
  • MySQL56
  • cpanel-mysql
  • cpanel-perl-536-authen-libwrap

AlmaLinux 8, Rocky Linux 8, and CloudLinux 8

  • bind-chroot
  • dovecot*
  • exim*
  • filesystem
  • mysql*
  • nsd*
  • php*
  • proftpd*
  • pure-ftpd*

Remove yum groups


To obtain a list of yum groups, run the yum grouplist command.

Before you install cPanel & WHM, make certain that the following yum groups are not installed on your server:

  • FTP Server
  • GNOME Desktop Environment
  • KDE (K Desktop Environment)
  • Mail Server or E-mail Server
  • Mono
  • Web Server
  • X Window System

To remove a yum group, run the yum groupremove command. For example, to remove the Mono and Mail Server groups, run the following command:

yum groupremove "Mono" "Mail Server"



cPanel & WHM installs EasyApache 4 by default.

EasyApache 4 allows you to preconfigure your profile before you install cPanel & WHM on your server. To preconfigure your profile before installation you will need to create the /etc/cpanel_initial_install_ea4_profile.json file. If you create this file ahead of time then the installation process installs and copies this profile to the /etc/cpanel/ea4/profiles/custom/ directory.

  • The /etc/cpanel_initial_install_ea4_profile.json file must exist as both a valid JSON file and a valid EasyApache 4 profile. If your JSON file contains errors, no data, or the installation fails, the system installs the default EasyApache 4 profile.
  • If your selected version of EasyApache fails to build, the installation process continues and you must troubleshoot the issue manually.
  • If your system runs CloudLinux, the system installs the CloudLinux EasyApache 4 repository and the default CloudLinux profile.
  • Systems that do not run CloudLinux install cPanel & WHM’s EasyApache 4 repository and the default profile.

For information about how to create an EasyApache 4 profile, read our EasyApache 4 - Create a Profile documentation.