How to Create Custom-Branded Login Pages

For cPanel *For cPanel & WHM 11.36 WHM 11.38*

Introduction

This document explains how to create custom login pages. Custom login pages will be applied to every account on the server. Resellers cannot create their own custom login pages at this time.

• Important: Much of the information in this document may change in the future. However, the variables used by the templates will remain the same throughout future versions of cPanel & WHM.
• Note: Throughout this document, $themename is meant to represent the name of theme you are customizing.

Duplicating the existing theme

You can find all of the materials required to rebrand login pages in /usr/local/cpanel/base/unprotected/. This directory contains the main login template and CSS files, in addition to 2 important subdirectories:

• /usr/local/cpanel/base/unprotected/$themename/templates/ — This directory contains several additional customizable templates. These templates include error pages, the reset password feature, and a few lesser-used templates that you need to customize in order to fully brand login pages.
• /usr/local/cpanel/base/unprotected/$themename/images/ — This directory contains all of the images that appear on login pages.

First, create a duplicate of the existing cpanel theme:

1. Access WHM's Universal Theme Manager (Main >> Themes >> Universal Theme Manager).
2. Click the Manage Themes link under Login.
3. Click the Clone icon next to the cpanel theme.
4. Enter a name for the duplicate theme in the available text field and click Submit.

At this point, you will have a copy of the cpanel theme located in /usr/local/cpanel/base/unprotected/$themename. In this case, $themename is the name you entered in step 4.

Once you have duplicated a theme, you are free to edit the images and templates listed below.

Once you have finished editing the theme, navigate to Tweak Settings and select your new theme from the Default login theme option.

To change the locale on your custom login page, use the edit a locale feature.

To add new strings to your custom login page, we strongly encourage you to use the maketext function.

Locating the images

Please take note of the following points about the subheader logos for cPanel, WHM, and webmail:

• Images are located in /usr/local/$themename/base/unprotected/cpanel/images. There are 3 subheader images and 9 other images to customize.
• The container area for all of the subheader images is 345 x 75 pixels.
• The subheader logos themselves are 318 x 55 pixels. You should design your custom logo using the same dimensions to allow for padding within the login subheader.
• The subheader logos are located in the login-sub-header div in style_v2.css.

Subheader Images

Other images

Customizable templates reference

token_denied.tmpl

login.tmpl

passthrough.tmpl

resetpass.tmpl

resetpass_confirmation.tmpl

resetpass_no_user.tmpl

resetpass_success.tmpl

reset-email-html.tmpl

reset-email.tmpl