We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.
We will continue to maintain our API documentation on this server.
Use the Basic WebHost Manager Setup interface to configure basic options for cPanel & WHM.
Use the Change Root Password interface to change your server's
root password without the previous
Use the CloudLinux LVE Manager interface to view LVE Manager information for accounts on your server.
This interface only displays for
root-enabled users on CloudLinux™ servers.
Use the Configure cPanel Cron Jobs interface to configure cron jobs for cPanel & WHM updates and backups.
Use the Initial Quota Setup interface to confirm that the system uses disk quotas on the directories in which your cPanel users store their files.
Use the Server Profile interface to select your server's profile. Server profiles enable and disable specific services to allow you to optimize your server for a specific task.
Use the Server Time interface to set your server's time zone and synchronize it with the time server.
Use the Statistics Software Configuration interface to view information about your server’s statistics and statistics software.
Use the Terminal interface to access an in-browser terminal application for direct command-line access within a cPanel & WHM session.
Use the Create Support Ticket interface to create a cPanel Support ticket.
Use the Grant cPanel Support Access interface to grant access to your server to cPanel Support.
Use the Support Center interface to access cPanel & WHM's support resources.
Use the Change Hostname interface to change your server's hostname.
Use the Resolver Configuration interface to edit the
/etc/resolv.conf file via a configuration wizard. This file contains the nameservers that your server will query in order to resolve domain names into IP addresses.
Use the Apache mod_userdir Tweak interface to configure Apache's
mod_userdir module. This module enables access to a website through a URL that uses the
Use the Compiler Access interface to enable or disable compiler access for unprivileged users. Many common attacks require a functional C or C++ compiler on the server.
Use the Configure Security Policies interface to configure security measures for your server and your WHM account.
Use the cPHulk Brute Force Protection interface to configure cPHulk. cPHulk helps to defend your server against brute force attacks. Brute force attack methods involve the use of an automated system to guess your web server's or services' password.
Use the Host Access Control interface to allow or deny clients' access, based on their IP addresses, to specific services.
Use the Manage External Authentications interface to manage the OpenID-compliant authentication providers that your server's users can use to log in to cPanel.
Use the Manage root's SSH Keys interface to add, import, and control SSH keys on your server. The system divides your keys into public and private key sets in two separate lists.
Use the Manage Wheel Group Users interface to add or remove users from the wheel group. The wheel group contains specific users who can execute the
su command, which allows the user to gain
Use the ModSecurity Configuration interface to configure your ModSecurity settings.
Use the ModSecurity Tools interface to install and manage your ModSecurity rules.
Use the ModSecurity Vendors interface to install and manage your ModSecurity vendors.
Use the Password Strength Configuration interface to define the minimum password strength for all of cPanel & WHM’s authenticated features.
Use the PHP open_basedir Tweak interface to configure PHP's
open_basedir directive. This directive ensures that users cannot use PHP to open files outside of their home directory.
The interface only displays this feature if your server runs EasyApache 3.
Use the Security Advisor interface to run security scans on your server. After the scan, this interface advises you about how to resolve any security issues that it finds.
Use the Security Questions interface to define and manage security questions. The system uses security questions when an unrecognized IP address attempts to log in to your account.
Use the Shell Fork Bomb Protection interface to ensure that users with terminal access (SSH or Telnet) cannot deplete server resources. This depletion of resources can crash your server in a fork bomb (a malicious attack). Fork bombs start a cascade of small processes that duplicate themselves until they deplete the server's resources.
Use the SMTP Restrictions interface to configure your server so that the mail transport agent (MTA), Mailman mailing list software, and
root user are the only accounts that can connect to remote SMTP servers. You may want to deny users the ability to bypass your mail server to send mail. This is a common practice for spammers.
Use the SSH Password Authorization Tweak interface to enable or disable passwords for SSH authentication.
If you disable passwords, users must use keys when they access your server via SSH.
Use the Traceroute Enable/Disable interface to configure the
traceroute utility on your server. The
traceroute utility, a network tool, determines the route that your network traffic uses to reach its destination.
Use the Two-Factor Authentication interface to configure an improved security measure that requires two forms of identification to log in.
Use the Contact Manager interface to specify which issues will generate an alert notification, what methods the server uses to send notifications, and the priority status of each type of alert.
Use the Edit System Mail Preferences interface to define how your server handles mail for the system mail addresses. The system mail addresses are root, nobody, and cPanel.
This interface's functionality is now available in WHM's Modify an Account interface (WHM >> Home >> Account Functions >> Modify an Account).
Use the Change Ownership of Multiple Accounts interface to transfer multiple accounts to a reseller.
Use the Edit Reseller Nameservers and Privileges interface to configure the server's reseller accounts. You may limit a reseller’s ability to create accounts and access various features. You may also confer
root access, assign nameserver IP addresses for accounts that the reseller created, and add A entries for those addresses.
Use the Email All Resellers interface to email all of your resellers simultaneously.
Use the Manage Reseller's IP Delegation interface to specify a shared IP address for a reseller. Multiple resellers can use the same shared IP address; however, a reseller can only dedicate the shared IP address to one account.
Use the Manage Reseller's Shared IP interface to specify a shared IP address for a reseller.
Use the Reseller Center interface to add or remove reseller status on existing accounts. You can also email resellers and configure existing reseller accounts.
Use the Reset Resellers interface to apply Access Control Limits (ACLs) to resellers, or reset package permissions to default values.
Use the Show Reseller Accounts interface to list reseller accounts and view information about the reseller, the reseller's accounts, the associated domains, and the packages that the accounts use.
Use the View Reseller Usage and Manage Account Status interface to track your resellers’ disk space and bandwidth usage. You can also use this set of features to suspend, unsuspend, and terminate reseller accounts.
Use the Apache Configuration interface to configure Apache. Apache acts as your web server software and handles HTTP requests.
Use the Configure PHP and suEXEC interface to change Apache’s PHP handler configuration and PHP version, and to enable or disable the suEXEC program.
This interface only appears on servers that run EasyApache 3.
Use the cPanel Log Rotation Configuration interface to specify the cPanel log files that cPanel’s
cpanellogd daemon manipulates.
Use the cPanel Web Services Configuration interface to configure or edit the SSL/TLS cipher list for cPanel, WHM, and Webmail.
Use the Exim Configuration Manager interface to configure Exim. Exim is a mail transfer agent. Mail transfer agents send and receive email messages.
Use the FTP Server Configuration interface to configure your FTP server's behavior.
Use the FTP Server Selection interface to select an FTP server daemon to use, or to disable FTP.
Use the Mailserver Configuration interface to configure the POP3 and IMAP protocols that Dovecot® use.
Use the Manage Service SSL Certificates interface to install new certificates to your web server, or to reset your server’s certifications (clear the certificates).
Use the Nameserver Selection interface to select BIND or MyDNS as your nameserver software, or to disable the nameserver.
We recommend that you do not start your nameservers unless you plan to use them.
Use the PHP Configuration Editor interface to configure your PHP settings. PHP is a scripting language that accepts code as input to generate web pages. cPanel users can view these settings in cPanel’s PHP interface (cPanel >> Home >> Software >> PHP).
This interface only appears on servers that run EasyApache 3.
Use the Configure Application Locales interface to choose the statistic software's language for each locale setting.
Use the Copy a Locale interface to copy a locale to a standard locale or a non-standard locale.
Use the Delete a Locale interface to delete a locale.
/usr/local/cpanel/bin/is_script_stuckscript to monitor and kill these processes.
Use the File and Directory Restoration interface to restore items from backup files.
Use the Restore a Full Backup cpmove File interface to restore accounts with a backup file. You can also use this feature to manually transfer accounts from another server.
To use this feature, you must have previously enabled account backups in the deprecated Legacy Backup Configuration interface.
Use the Backup System Migration interface to migrate your server from the Legacy Backup system to the new Backup system.
To use this feature, you must have previously enabled account backups in the deprecated Legacy Backup Configuration interface.
Use the Configuration Cluster interface to link a master server to one or more additional servers. You can then copy server configuration settings to the configuration cluster's servers from specific WHM features.
Use the DNS Cluster interface to configure a DNS cluster and add servers to it. A DNS cluster is a group of nameservers that share DNS records.
Use the Remote Access Key interface to generate an access key. You can use this access key for automatic account creation scripts, external billing software, and to set up DNS and configuration clusters.
Use the Forceful Server Reboot interface to shut down your server regardless of any errors that the server encounters.
To begin this process, navigate to the Forceful Server Reboot interface and click Proceed.
Use the Graceful Server Reboot interface to close any user-level processes and then store their data before the reboot.
To begin this process, navigate to the Graceful Server Reboot interface and click Proceed.
Use the Apache Status interface to view Apache's status. Apache is a web server daemon (
httpd). It responds to HTTP requests, and subsequently serves web pages.
Use the Daily Process Log interface to view information about your server’s average consumption of processing power and memory for the selected day.
Use the Server Information interface to view information about your hardware configuration (for example, the speed of your processor).
Use the List Accounts interface to list all of the accounts on your server, and perform certain actions (for example, change the account's password).
Use the List Parked Domains interface to list all of the parked domains (aliases) on your server. A parked domain is a domain that points to another domain.
To add parked domains, use the Park a Domain interface (WHM >> Home >> DNS Functions >> Park a Domain).
Use the List Subdomains interface to list all of the subdomains on your server. Subdomains function as URLs for specific sections of a website (for example, the
example.com domain may have the
blog.example.com subdomain for its blog section).
cPanel users can add subdomains in cPanel's Subdomains interface (cPanel >> Home >> Domains >> Subdomains).
Use the List Suspended Accounts interface to view, unsuspend, or terminate your server's suspended accounts.
Use the Show Accounts Over Quota interface to list the accounts on your server that currently use more disk space than you have allocated to the account. You can also use this interface to enter a new disk space quota for these users.
Use the View Bandwidth Usage interface to view information about your server's traffic from HTTP (browser traffic), FTP (files transferred), SMTP (sent mail), and POP3 or IMAP (received mail).
Use the Force Password Change interface to force any of your users to change their passwords.
EasyApache 3 does not support new installations of Tomcat.
As of cPanel & WHM version 76, EasyApache 4 now supports Tomcat 8.5. For more information, read our Tomcat documentation.
Use the Install Servlets interface to install Tomcat Servlets for a domain. To install Servlets, select the account for which you wish to install Servlets and click Install.
This interface only appears on servers that use Tomcat.
Use the Limit Bandwidth Usage interface to change the allotted bandwidth for an account.
Use the Manage Account Suspension interface to suspend or unsuspend an account.
Use the Manage Demo Mode interface to turn any account on your server into a demo account.
Use the Manage Shell Access interface to manage which of your accounts can access your server remotely through the SSHD service.
Use the Modify an Account interface to select and redefine an account’s settings.
Use the Password Modification interface to change the passwords for any of your existing reseller or cPanel accounts.
Use the Quota Modification interface to change an account’s quota.
Use the Raw Apache Log Download interface to download raw access logs of the Apache web server’s activities.
Use the Raw FTP Log Download interface to download a raw access log that details the FTP server’s activities.
Use the Rearrange an Account interface to change the hard drive on which you wish to store an account. This interface is only relevant for servers with more than one hard disk.
Use the Reset Account Bandwidth Limit interface to reset an account's quota. For example, if you changed an account's bandwidth quota from the setting that is in the account's package, use this feature to reset that account's quota.
Use the Show Active and Inactive Accounts interface to review which accounts have an entry in the Apache configuration file. WHM only considers an account to be active if its domain and IP address has a valid entry within the
httpd.conf file. To attempt to rebuild the inactive account’s data in the Apache configuration file on your server, click Reactivate Inactive Domains .
Use the Skeleton Directory interface to easily copy the same files into every new account’s
public_ftp directories during the account creation process.
Use the Terminate Accounts interface to simultaneously terminate multiple accounts. When you terminate an account, the system completely removes it from your server.
Use the Unsuspend Bandwidth Exceeders interface to simultaneously unsuspend all of the accounts that exceed their bandwidth. Accounts remain unsuspended until the next bandwidth check.
Use the Upgrade/Downgrade an Account interface to change an account’s package.
Use the Web Template Editor interface to create placeholder web pages that appear to visitors who try to access a site on your server that is suspended, has moved, has not yet been configured, or has experienced a connection or firewall problem.
Use the Change Multiple Sites' IP Addresses interface to change the IP addresses of multiple accounts simultaneously. This feature is useful when a reseller transfers an account to another reseller.
Use the Modify Upgrade Multiple Accounts interface to simultaneously change the settings for multiple accounts.
Use the Convert Addon Domain to Account interface to convert an existing addon domain into a full cPanel account.
Use the Copy an Account from Another Server with Account Password interface to copy an account from a remote server without the use of the
Use the Review Transfers and Restores interface to review any accounts that you copied to your server.
Use the Transfer Tool interface to copy multiple accounts and packages from a remote server. This is useful when a reseller wishes to move a number of accounts from one server to another.
Use the Add a DNS Zone interface to set up a DNS zone on your server. A DNS zone is an administrative space or portion of the domain name system. This space directs traffic to the correct locations.
Use the Add an A Entry for Your Hostname interface to add A entries. An A entry, also known as an A record or an address record, consists of data that resides in your server’s DNS zone files. The A entry matches a hostname or domain name with an IP address. A correct A entry is essential if you wish to allow visitors to find your server on the Internet.
Use the Delete a DNS Zone interface to delete DNS zones from your server.
Use the Edit DNS Zone interface to edit the records in a domain’s DNS zone file.
Use the Edit MX Entry interface to list destination mail servers and designate a priority value for each server.
Use the Edit Zone Templates interface to modify the templates that cPanel & WHM uses to create DNS zone files for new domains.
Use the Enable DKIM SPF Globally interface to create SPF and SKIM records for all domains on your server.
Use the Nameserver Record Report interface to add and remove nameserver IP addresses on your server.
Use the Park a Domain interface to configure parked domains (aliases). A parked domain is a secondary domain that points to the user’s primary domain.
Use the Perform a DNS Cleanup interface to perform a cleanup of your DNS configuration. This function is useful if your BIND configuration file is corrupt, or if you have duplicate nameserver configuration files that cause DNS problems for your server.
Use the Reset a DNS Zone interface to reset a DNS zone file to its default values.
Use the Set Zone Time to Live interface to set the Time to Live (TTL) for your DNS zones.
Use the Setup Edit Domain Forwarding interface to redirect one domain to another domain. This is useful, for example, if you wish to temporarily redirect visitors while a site is down for maintenance.
Use the Synchronize DNS Records interface to synchronize the DNS records across multiple servers. This is useful if, for example, you use a DNS cluster setup, but find that some servers in the DNS cluster give outdated responses to DNS queries.
Use the Additional MySQL Access Hosts interface to remotely access MySQL® databases on your web server, or a remote MySQL server that you set up with the Setup Remote MySQL Server interface.
Use the Change MySQL User Password interface to change a database user's passwords. Because this feature does not require the old password, it is useful if a password is compromised or forgotten.
Use the Configure PostgreSQL interface to complete the PostgreSQL® installation process, create PostgreSQL users, and update the PostgreSQL password.
This feature is for advanced users only. The WHM interface only displays this interface if you have already installed PostgreSQL on your server.
Use the Database Map Tool interface to grant database ownership to existing cPanel users.
Use the Manage Database Users interface to view and manage all of your server's database users.
Use the Manage Databases interface to view and manage all of your server's databases.
Use the Manage MySQL Profiles interface to offload MySQL-related work to the remote MySQL server.
Use the MySQL Root Password interface to set a
root MySQL password. By default, MySQL's
root account has no password.
Use the MySQL/MariaDB Upgrade interface to upgrade your installation of MySQL or MariaDB to the latest version.
Use the phpMyAdmin interface to manage phpMyAdmin, a MySQL database management system. It allows you to access and edit your server's databases information. For more information, visit the PhpMyAdmin documentation.
Log in to phpMyAdmin with the cPanel user's username and password.
Use the Repair a MySQL Database interface to attempt to repair database tables that may have become corrupt. To repair a database, select the database that you wish to repair from the Users list and click Repair Database.
To prevent performance issues, this interface does not support InnoDB tables for Roundcube databases. To determine the databases that contain tables would cause significant performance issues. For more information about InnoDB tables, read the InnoDB Repair Guide.
Use the Show MySQL Processes interface to list any processes that currently run on any database on your server.
Use the phpPgAdmin interface to manage phpPgAdmin, a PostgreSQL database management tool. You can use the phpPgAdmin utility to access and edit information contained within any of your server's databases. For more information, visit the phpPgAdmin documentation.
Use the Add a New IP Address interface to add an IPv4 address to your IP address pool.
Use the Assign IPv6 Address interface to assign an IPv6 address to a specific account. To use this interface, available IPv6 addresses must exist in your IP address pool, or you must configure a shared IPv6 address.
Use the Configure Remote Service IPs interface to specify remote mail server and the remote nameserver IP addresses.
Use the IP Migration Wizard interface to change the IPv4 addresses of the cPanel accounts that your server hosts.
Use the IPv6 Ranges interface to add an IPv6 address range to your IP address pool, or delete an IPv6 address from the IP address pool.
Use the Rebuild the IP Address Pool interface to scan your server's bound IPv4 addresses in order to locate IPv4 addresses that the system does not associate with a domain.
Use the Show IP Address Usage interface to list the IPv4 addresses that you assigned to domains on your server.
Use the Show or Delete Current IP Addresses interface to display the IPv4 addresses that you have bound to your server. The interface also allows you to remove these IPv4 addresses from the server.
Use the Show/Edit Reserved IPs interface to reserve an IPv4 address that currently exists in your IP address pool.
Use the EasyApache 3 interface to update and reconfigure your Apache web server with version 3 of our EasyApache software.
This interface only appears on servers that run EasyApache 3.
Use the EasyApache 4 interface to update and reconfigure your Apache web server with version 4 of our EasyApache software.
Use the Module Installers interface to find and install modules for PHP, Ruby, and Perl.
Use the MultiPHP INI Editor interface to configure your PHP settings. This interface only displays for servers that run EasyApache 4.
Use the MultiPHP Manager interface to manage your PHP configuration. This interface only displays for servers that run EasyApache 4.
Use the Rebuild RPM Database interface to rebuild the RPM database if it becomes corrupt. To begin the process, click Proceed.
Use the System Update interface to update Perl modules or related packages for cPanel & WHM. This feature runs the
yum update command, but does not perform an update of the operating system's kernel. To begin the process, click Proceed.
Use the Tomcat Manager interface to manage the Tomcat status of your users.
This interface only appears if you installed Tomcat for EasyApache 4. EasyApache 4 only supports Tomcat 8.5.
Use the Update Server Software interface to update software for cPanel & WHM.
Use the Greylisting interface to configure Greylisting, a service that protects your server against unwanted email or spam.
Use the Mail Delivery Reports interface to review information about the email messages that your server sent (for example, whether each message arrived successfully and details about each delivery attempt).
Use the Mail Queue Manager interface to manipulate mail messages in the mail queue.
Use the Mail Troubleshooter interface to access a mail routing tracer.
Use the Mailbox Conversion interface to convert a cPanel account's mailboxes from
Use the Repair Mailbox Permissions interface to inspect mailbox ownership and file permissions. You can also attempt to repair any contradictions that may exist in the mail system. To begin the process, click Proceed.
Use the Spamd Startup Configuration interface to configure the settings that the Apache SpamAssassin™ daemon (
spamd) uses at startup.
Use the View Mail Statistics Summary interface to view statistics about mail that your server sends and receives over a defined period.
Use the View Relayers interface to list the users whose accounts relay mail. Relayed mail is mail that user accounts on your server receive, and then forward to remote accounts.
Use the Background Process Killer interface to select programs that the system will automatically terminate. After the system terminates a process, it sends a confirmation email.
Use the Process Manager interface to display, trace, and kill active processes on your server.
Use the Show Current Disk Usage interface to display your server's current hard drive usage.
Use the Change Log interface to view changes in the cPanel & WHM software.
Use the Customization interface to replace some of the default cPanel interface elements with your own branding elements and styles.
Use the Install cPAddons Site Software interface to add cPAddons and vendors.
Use the Manage cPAddons Site Software interface to activate moderation, force cPAddons updates, and uninstall deprecated cPAddons.
Use the Manage Plugins interface to add and manage plugins. Plugins provide additional functionality for your server.
Use the Modify cPanel & WHM News interface to set messages that display in the cPanel or WHM interfaces for your users and resellers.
Use the Reset a Mailman Password interface to reset the main password for any mailing list on your server, or to reset the password for the Mailman mailing list software.
Use the Synchronize FTP Passwords interface to synchronize your FTP passwords to repair FTP password issues. For example, you may wish to synchronize your FTP passwords when you reinstall the FTP server software.
/usr/local/cpanel/scripts/ftpupdate script to perform this sync from the command line.
Use the Generate an SSL Certificate and Signing Request interface to generate a certificate signing request (CSR) to use to purchase a certificate from a certificate authority (CA) or a self-signed SSL certificate (with a private key and CSR).
Use the Install an SSL Certificate on a Domain interface to install an SSL certificate with a private key.
Use the Manage AutoSSL interface to select the certificate provider for users to automatically obtain SSL certificates for their sites when their existing certificates expire or are invalid.
While the AutoSSL feature generally only requires a short amount of time to complete the installation process, certain factors may lead to longer wait times. Under some conditions, certificates may require up to 48 hours to process.
Use the Manage SSL Hosts interface to share SSL certificates and manage certificates by domain and user.
Use the Purchase and Install an SSL Certificate interface to purchase and install an SSL certificate through the cPanel Market for a user.
Use the SSL Storage Manager interface to view all of the installed keys and certificates on your server.
Use the DNS Server interface to restart BIND, NSD, or MyDNS. When the system prompts you for confirmation, click Yes.
Use the FTP Server interface to restart the server's FTP service. When the system prompts you for confirmation, click Yes.
Use the HTTP Server interface to restart Apache. When the system prompts you for confirmation, click Yes.
Use the IMAP Server interface to restart Dovecot. When the system prompts you for confirmation, click Yes.
Use the Mail Server interface to restart Exim. When the system prompts you for confirmation, click Yes.
Use the Mailing List Manager interface to restart Mailman. When the system prompts you for confirmation, click Yes.
Use the SQL Server interface to restart the PHP-FPM Service for Apache. When the system prompts you for confirmation, click Yes.
Use the SQL Server interface to restart MySQL. When the system prompts you for confirmation, click Yes.
Use the SSH Server interface to restart OpenSSH. When the system prompts you for confirmation, click Yes.
Use the API Shell interface to run WHM API functions from within the WHM interface. You must use a reseller account in order to access this interface.
Use the Apps Managed by AppConfig interface to view the registered WHM applications that AppConfig manages on your server.
Use the Manage API Tokens interface to to create, list, and revoke API tokens. API tokens allow you to grant cPanel users the ability to run API functions as a WHM account owner via a key hash.