Page tree
Skip to end of metadata
Go to start of metadata

This document is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 11.46

(Home >> Themes >> Universal Theme Manager)

Overview

This set of features allows you to manage four sets of themes.

A cPanel & WHM theme is the skeletal frame on which the system places the style, or “skin.” The theme contains many elements such as HTML and CSS. We recommend that you use the x theme for WHM, the x3 or paper_lantern themes for cPanel, and the x3mail theme for Webmail.

Note

The x3mail theme is intended for servers that will only function as mail servers. This theme is not for webhosting accounts.

Themes

 To access these themes, click the Manage Themes link that corresponds to the theme that you wish to edit.

  • cPanelThe theme that appears in the cPanel interface. cPanel users who maintain websites on your server will see this theme.
    • The most current themes that cPanel supports are x3 and paper_lantern.
  • Login — The theme that appears on the cPanel login interface.
  • Webmail — The theme for webmail clients that ship with cPanel.
  • WHM — The theme that appears in the WHM interface. You, the web host, and your resellers will see this theme.

The Theme Manager

This feature allows you to view, download, clone, upload, and delete themes. We recommend that you use the x3 or paper_lantern theme for cPanel.

The instructions below apply to all sections of the Universal Theme Manager, which includes cPanel, Login, Webmail, and WHM.

Important

In order to create a custom webmail theme, you must have a cPanel theme of the same name. You can clone the existing x3 theme in cPanel and give it the same file name as the custom webmail theme.

Viewing a snapshot of the theme

To view a snapshot of the theme, click the view () icon that corresponds to the theme that you wish to view.

When you clone a theme, the system creates a copy of the theme.

Clone a theme

To clone a theme, perform the following steps:

  1. Click the clone icon that corresponds to the theme that you wish to edit.
  2. Enter the name for the newly cloned theme on the next page.

    Note:

    When you create a custom webmail theme, the name should match the cPanel theme that you will use.

  3. Click Submit.

The system will clone the theme and display it in the Themes table.

Download a theme

To download a theme, click Download (). You can delete themes so that old or unused themes do not take up disk space.

Delete a theme

To delete a theme, click Delete () and click Yes on the following interface to confirm that you wish to delete the theme.

Upload and install a theme

To upload/install new themes, perform the following steps:

  1. Under the Install Theme heading, enter the name of the theme file, or click Browse.
  2. Select the theme file.
    • cPanel theme files have a .cptheme file extension.
    • The .cptheme file is actually a .tar.gz file.
  3. Click Upload.
    • The new theme will appear in the Themes table.

Try a theme (for WHM themes only)

To try a theme, click Activate () from the WHM Themes list. The interface instantly changes to the theme that you activated.

Addon Themes

Use the Universal Theme Manager to install and update addon themes. Addon themes are additional themes that cPanel or a third party provides.

To begin, click the Manage Addon Themes link at the bottom of the Theme Manager interface for cPanel, Login, Webmail, or WHM.

Install an addon theme

To install an addon theme, click the Install and Keep Updated checkboxes for the themes that you wish to use, and click Save.

Uninstall an addon theme

To uninstall an addon theme, click Uninstall next to the theme that you wish to remove.

Note

cPanel is not responsible for any third-party themes that you install.

Additional information

Important:

When you create your own themes or use a theme that cPanel does not provide, you must ensure that the following files exist:

  • /usr/local/cpanel/base/frontend/$theme/passwd/changepass.html
  • /usr/local/cpanel/base/frontend/$theme/passwd/index.html

These files control interfaces that the system uses whenever you must change a cPanel user's password. If you do not copy or create these interfaces, users cannot change their passwords if the following conditions are true:

  • You used WHM's Force Password Change interface (Home >> Account Functions >> Force Password Change) to require the user to change the account's password.
  • The user's password is too old or too weak, as defined in WHM's Configure Security Policy interface (Home >> Security Center >> Configure Security Policies).

Note

We do not currently support custom theme or localization efforts for WHM.