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

Guide to cPanel Interface Customization - cPanel Style Development

Introduction

Note:

Custom styles are only available in the Paper Lantern theme. The Paper Lantern theme is now deprecated and will be removed. For more information, read our cPanel Deprecation Plan documentation.


You can develop custom styles that modify the appearance of the cPanel interface.

For example, you may wish to create a customized appearance to match your company's branding and logo, or you may wish to create customized styles for distribution.

  • A custom cPanel style only changes the appearance of the cPanel interface, while cPanel plugins add customized functionality. For information about how to create cPanel plugins, read our Guide to cPanel Plugins documentation.
  • For a step-by-step tutorial about how to create and apply a custom style, read our Tutorial - Create a Custom cPanel Style documentation.

We strongly recommend that you keep your custom styles up to date to avoid compatibility issues when you upgrade cPanel & WHM. To do this, perform the following actions:

  • Monitor our Change Logs and our Release Notes documentation for updated features and bug fixes.
  • Make certain that your server runs on the LTS, STABLE, RELEASE, or CURRENT release tiers , so that it receives any functionality updates.
  • You can also use a server that runs on the EDGE release tier to test for compatibility and functionality in a controlled environment.
  • We strongly recommend that you do not attempt to modify the existing cPanel default style. Updates to cPanel & WHM may overwrite your changes. To modify any aspect of the cPanel interface's appearance, you must create a new style

Style development workflow

When you create a cPanel style, we recommend that you use the following workflow:

  1. Create a new directory for the style.
  2. Create the styles.css file within the new directory. You can also use the styles.min.css file. We strongly recommend that you include both the styles.css and styles.min.css files.
  3. Add the desired images and other assets to the directory.
  4. Perform one of the following actions to add the style to the server and apply it to accounts:
  5. Move the style's directory to the appropriate location on the server, and then apply the style to the desired accounts:
    • For all of the accounts on the server – /var/cpanel/customizations/styled/mystyle/
    • For all of the cPanel accounts that a reseller owns – /home/reseller/var/cpanel/reseller/styled/mystyle/
    • For a specific cPanel account – /home/username/var/cpanel/styled/mystyle/
      • mystyle represents the name of the style's directory
      • reseller represents the reseller's username.
      • username represents the cPanel account's username.
      • If the server uses a customized home directory path, make certain that you use the appropriate path for that home directory.
      • If these directories do not currently exist on the server, use the mkdir command to create them.
    • Use WHM's Customization interface ( WHM >> Home >> cPanel >> Customization ) to upload and apply your style.
    • Use the /usr/local/cpanel/usr/local/cpanel/scripts/modify_accounts script to apply a specific style and theme across multiple existing accounts.

The system uses the cpsrvd daemon to serve cPanel styles. The cpsrvd daemon listens on port 2082 (insecure connections) and port 2083 (secure connections). Make certain that you consider these requirements when you specify paths in your custom styles

©2022 cPanel, L.L.C. All rights reserved.Privacy PolicyTrademarks