Child pages
  • The WHM Interface
This documentation is for cPanel & WHM version 80 EDGE builds.  The "RELEASE" version of our documentation can be found in the Version 78 Documentation space.


Skip to end of metadata
Go to start of metadata

Overview

Note:

If you have not already installed cPanel & WHM on your server, use our Installation Guide to complete the installation process.

The WHM interface provides the server's root user and resellers with access to all of WHM's server administration features.

The WHM interface consists of the following sections:

  1. Top navigation bar
  2. Breadcrumbs and the Support menu
  3. Side navigation menu
  4. Important Next Steps
  5. Features

Top navigation bar

WHM's top navigation bar remains visible as you navigate throughout the WHM interface.

  • Click News to view important news and announcements from cPanel, Inc.
  • Click Change Log to view the cPanel & WHM change logs.
  • Click Log Out to log out of your WHM account.
  • Click the version number to navigate to WHM's Upgrade to Latest Version interface (WHM >> Home >> cPanel >> Upgrade to Latest Version).
  • Click Load Averages to navigate to WHM's Process Manager  interface (WHM >> Home >> System Health >> Process Manager). The numbers that follow this link represent the server's one-minute, five-minute, and 15-minute load averages, respectively.

You may also see important server notices in this section of the interface. For example, if the most recent attempt to upgrade cPanel & WHM failed, you may see a The last attempt to update cPanel & WHM was blocked. warning, which you can click to review a list of upgrade blockers.

Breadcrumbs and the Support menu

Under the top navigation bar, WHM displays the breadcrumbs to the current interface. For example, it displays Home >> Server Configuration >> Tweak Settings for WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

  • Click Home in the breadcrumbs to navigate to the Home interface. Click the WHM section name (in the middle of the breadcrumbs) to navigate to the landing page for that section.
  • To access documentation for the current interface, click the help icon ().

Click the lifesaver icon () in the right corner to view the Support menu. 

  • Click cPanel & WHM FAQ to access our cPanel Knowledge Base documentation.
  • Click Support Forums to access the cPanel Forums.
  • Click Documentation to access the main page of our WebHost Manager documentation (from WHM's Home interface) or the documentation for the current interface (from other WHM interfaces).
  • Click Contact cPanel to submit a ticket to cPanel Technical Support.

By default, the interface only displays a selection of the most helpful features in WHM. To view all of WHM's sections and features in the Home interface, set the View toggle to Classic

Note:

You can also use the side navigation menu to access cPanel & WHM's other features.


Side navigation menu

The side navigation menu in WHM provides access to all of WHM's interfaces, and allows you to quickly search for specific features. For more information about WHM's features and interfaces, read our WHM Features List documentation.

We hide this menu by default. To show or hide this menu, click the expand () or collapse () icons, respectively. You can also click View All Features at the bottom of the interface to expand this menu.

If the side navigation menu is collapsed, the Explore WHM section appears at the bottom of the interface.

  • To search for a feature, enter one or more keywords in the text box and click the search icon ().
  • To quickly navigate to a WHM interface, use the menu of available features:
    • To expand or collapse all menu sections with one action, click the expand icon () or collapse icon () at the top of the menu, immediately below the search text box.
    • To expand or collapse a single menu section, click the arrow icon () for that section.
    • To access a WHM section, click that section's name in the menu.
    • To access a WHM interface, click that interface's name in the menu.

Important Next Steps

The first time that you log in to WHM, the interface displays an Important Next Steps section with quick access to important actions for new servers.

  • To hide this section of the interface, click Dismiss.
  • To restore this section of the interface after you hide it, run the following command as the root user:

    sed -i '/home:hide_important_next_steps/d' /var/cpanel/whm/nvdata/root.yaml

Features

The WHM Home interface provides quick access to the features that manage cPanel & WHM servers and accounts. 

Notes:

By default, we hide Feature Showcase items on new installations until new items are available for the next server update. For more information and steps to view these items, read our Guide to the Feature Showcase documentation.

Trial license banner

Servers that use a trial license display a banner above the WHM Home interface's icons. This banner displays the server's trial license status, and you can click Purchase a License to buy a full cPanel, Inc. license. For more information, read our How to Purchase a cPanel License documentation.

cPanel Analytics

If you have enabled cPanel Analytics at the server level, a lightbulb icon () will appear on the right side of the interface. Click the icon to display your account-level cPanel Analytics options. Select Allow to enable cPanel Analytics for your account, or select Deny to disable it. 

Note:

Plugin developers should make certain to respect user privacy. We strongly recommend that you anonymize any data that you collect for analysis.

For more information about how cPanel, L.L.C. handles private data, read our cPanel Analytics documentation.

Legal agreements and initial setup

Note:

If you have questions about your license agreement, contact cPanel Customer Service.

When you log in to WHM for the first time on a new cPanel & WHM server, the system prompts you to accept our End User License Agreement (EULA). This agreement provides the terms under which you use cPanel, Inc.'s software. Read the EULA carefully. 

  • You must accept this agreement in order to use cPanel & WHM.
    • If you click Cancel and Exit, a confirmation message will appear. 
    • If you click OK for this message, the system will automatically log you out of WHM. The EULA will appear again the next time that you log in to WHM.
  • To remove acceptance of the EULA on an existing server, delete the appropriate touchfile in the /var/cpanel/activate/ directory. To continue to use cPanel & WHM, you must accept the EULA again the next time that you log in.

After you accept the EULA, the system will optionally allow you to specify a contact email address, two nameservers, and your ethernet device. To view this interface on an existing server, delete the /etc/.whostmgrft touchfile.

Additional documentation