Development Guides Home >> Guide to cPanel Interface Customization and Branding

Guide to cPanel Interface Customization - The Login Theme

Introduction

Note:

cPanel & WHM's login theme determines the appearance of login pages. Login themes include template files, image files and logos, CSS files, and a favicon for the login pages.

  • Your customers view these pages each time they log in to their accounts.
  • The default login theme exists in the /usr/local/cpanel/base/unprotected/cpanel/ directory.

You can view your server's available login themes in WHM's Theme Manager interface (WHM >> Home >> Themes >> Theme Manager).

If your custom interfaces require jQuery, you must include that code in require() blocks. For more information, read our Guide to cPanel Interface Customization - jQuery documentation.

Login theme development workflow

When you customize a login theme, we recommend that you use the following workflow:

  1. Use WHM's Theme Manager interface (WHM >> Home >> Themes >> Theme Manager) to clone the existing login theme.
  2. Update logos and other login theme image assets.
  3. Update the desired login page templates.
  4. Update the style_v2.css and style_v2_optimized.css files with any desired CSS changes.
  5. If necessary, update your server's locales with any new phrases that you added to the login pages.
  6. Select the new login theme from the Default login theme menu in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

Login templates

Template files determine the appearance of each login page. Each login theme includes template files for the main login pages, error pages, and templates for the Reset Password feature.

For more information, read our Guide to cPanel Interface Customization - Login Templates.

Login images

You can customize the images that the cPanel & WHM login theme uses. These images exist in login theme's images directory.

For more information, read our Guide to cPanel Interface Customization - Login Images.