This documentation is for cPanel & WHM version 62 CURRENT builds. The "RELEASE" version of our documentation can be found in the Version 60 Documentation space.
This documentation describes the WHM interface and how you use it to manage your server.
- Keyboard Shortcuts in WHM — This document describes the keyboard navigation in WHM. The shortcuts help users navigate the left menu with their keyboard.
WHM Home interface
The WHM Home interface contains most of the features that server owners use regularly.
- cPanel & WHM Glossary — This document reviews a number of essential terms used in the WHM documentation.
Additional WHM interfaces
These documents describe additional WHM interfaces.
- Initial Setup Wizard — This document describes the steps in the Initial Setup wizard, which runs the first time that you access WHM.
- WHM News — The News link at the top of the WHM interface provides up-to-date information about your server.
- Change Log — This document provides information about the Change Log link provided at the top of the WHM interface. This feature tracks and lists changes in our software.
Files, directories, and processes
- Backup Tarball Contents — This document provides information about the structure and contents of the backup tarball file.
- The cPanel & WHM Update Configuration File — /etc/cpupdate.conf — Each line of the
/etc/cpupdate.conffile specifies how cPanel & WHM updates different parts of the system.
- The Quota File Systems Configuration File — /var/cpanel/noquotafs — The
/var/cpanel/noquotafsfile allows you to exclude specific file types from cPanel & WHM's quota system.
- The Statistics Software Configuration File — /etc/stats.conf — The
/etc/stats.conffile stores the configuration changes that you make in WHM's Statistics Software Configuration interface (Home >> Server Configuration >> Statistics Software Configuration).
- The cpanel.config File — The
/var/cpanel/cpanel.configfile stores all of the settings for WHM's Tweak Settings interface (Home >> Server Configuration >> Tweak Settings), as well as some additional configuration settings.
- The cPanel & WHM Login Theme — cPanel & WHM's login theme determines the appearance of the login pages for the WHM, cPanel, and Webmail interfaces.
- The cpanelsync.exclude File — This document details how to add files to the
- The failurls File — The
/var/cpanel/failurlsfile lists the locations where resellers can redirect users who fail to authenticate with cPanel through custom login forms.
- Guide to Horde Data Behavior — This document describes the changes made to the system when you upgrade from Horde Webmail, as well as the new behavior after you upgrade.
- Guide to IPv6 — This guide defines IPv6, describes how to implement IPv6 on a cPanel & WHM server, and provides steps to troubleshoot common IPv6-related issues.
- The rpm.versions System — This document describes the functionality of cPanel's rpm.versions system.
- — This document describes how to specify the maximum number of emails that a particular domain can send per hour.
- How to Restore Database Grants – This document details how to restore MySQL® and PostgreSQL® database grants.
- Select a PHP Binary — The cPanel Server Daemon (
cpsrvd) must know the path to the specific PHP binary that you wish to use to process PHP scripts.
- The splitlogs Binary — The
/usr/local/cpanel/bin/splitlogsutility allows you to fine-tune your resource and performance balance when you create Apache logs.
- The Task Queue System in cPanel & WHM — This document details cPanel & WHM's task queue system.
- Third-Party Software — This document provides a list of third-party software that cPanel & WHM includes and manages.
- cPanel PHP — This document lists the PHP modules, PEAR packages, and PECL modules that cPanel & WHM includes.
- Perl Module Installation — This document provides instructions on how to install custom Perl modules on your cPanel & WHM server.
- The cpconftool Script — This script backs up and restores the Exim configuration file and the
- WHM Scripts — This document lists scripts that exist in the
/usr/local/cpanel/scriptsdirectory with cPanel & WHM.
- The /bin/view_transfer Script — Use the
view_transferscript to check the status of and monitor transfer sessions.
- /scripts/pkgacct — Package a cPanel account — Use the
pkgacctscript to create a
cpmovearchive for a specified account.
- /scripts/restorepkg — Restore a cPanel account — Use the
restorepkgscript to restore a backup archive for a specified account.
- The dbmaptool Script — Use the
dbmaptoolscript to grant ownership of databases and database users to a cPanel user.
- The is_script_stuck Script — Use the
is_script_stuckscript to check how long a script's current PID has run, and choose to kill the process.
- The rebuild_dbmap Script — If the database map is corrupt for a cPanel user, you can use the
/scripts/rebuild_dbmapscript to rebuild that user's database map.
- The spf_installer Script — Use the
spf_installerscript to add SPF records to a cPanel user's accounts.
- The swapip Utility — Use the
swapiputility to specify parameters from the command line in order to update nameserver records.
- The proxydomains Script — Use the
proxydomainsscript to create the DNS records for a cPanel or Webmail account from the command line.
- The set_hostname Utility — Use the
set_hostnameutility to update the server's hostname, and perform all of the necessary actions to apply this change throughout the system.
- The wwwacct Script — Use the
wwwacctscript to create a cPanel account.
- The /bin/view_transfer Script — Use the