Valid for versions 82 through the latest version
This interface allows you to customize parts of the cPanel and Webmail interfaces. You can:
Upload custom logos.
Upload a favicon.
Update parts of the cPanel interface to match your company’s branding.
Upload custom cPanel styles.
Update the contact information on publicly-visible placeholder pages.
For the purposes of cPanel, L.L.C.’s products and documentation, we use the following terms:
Branding — Branding modifies the cPanel interface in order to match your company’s logo and brand.
Branding changes include updates to image assets or text labels.
For more information, read our Branding documentation.
Includes — UI includes add custom content to the header or footer of the cPanel interface (but not the WHM interface).
You can create UI includes for specific cPanel interfaces, or global UI includes that display on all of cPanel’s interfaces.
For more information, read our UI Includes documentation.
Plugin — A plugin modifies an interface’s features or functionality, and it may also include changes to the interface’s appearance.
Style — A style uses CSS, images, and other assets to modify the appearance of the entire cPanel interface without changes to its functionality or features.
You can create and apply styles to an entire server or a specific reseller’s accounts, or you can create them for distribution.
For more information, read our cPanel Style Development documentation.
Theme — A theme applies an overlay on the skeletal framework for all of the interfaces.
cPanel & WHM currently ships with one default cPanel theme and one default WHM theme.
The Webmail and login interfaces also use themes.
To customize the cPanel or Webmail interfaces:
Enter your company’s name in the Company Name text box to brand the interface with your company name.
Use this option if you don’t want to upload a custom logo.
If you use this option, your company name will appear in the default cPanel font.Note:
To change the font style, you must customize cPanel’s CSS with a custom style.
The Company Name value cannot exceed 50 characters. The cPanel interface truncates it if the name’s width exceeds the width of the user’s browser window.
Enter your help or support URL in the Help Link text box to customize the Help link. The Help link won’t appear in the cPanel interface until you enter a custom URL.
Enter your documentation URL in the Documentation Link text box to customize the Documentation link. If you don’t enter a custom Documentation link, the Documentation link points to the cPanel, L.L.C. documentation.
Click Browse under the desired heading to add your company logo, Webmail logo, or favicon. Then, select the desired file.Note:
cPanel & WHM has specific icon size and file type requirements. For more information, read our Guide to cPanel Interface Customization - Custom Icons and Logos documentation.
If you upload a file with this interface, the system saves it as an
To delete an uploaded logo, click the trash can icon () for that image file.
To apply your changes, click Save.
You can download an example skeleton style to help you create a new style.
Upload a custom style
To upload custom cPanel styles:
Click Upload a Style.
To select a style to upload, click Browse.
The system uses the
.tar.gzfile’s name as the style’s name.
You must upload your custom style as a
.tar.gzfile, which must contain the
styles.min.cssfile, or both.Note:
We strongly recommend that you include both files.
To set the style as the default style, select the Set this style as my default style checkbox.
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:
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.
To modify the theme or style for existing accounts, use the
Use the Manage Styles section to work with styles. To filter the list of styles, click the desired filter name. For each style, you can perform the following actions:
Set as Default — Click to set a style as the default style for your newly-created accounts.Note:
This action only sets the default for new accounts that you create. It does not set the style for existing accounts on the server.
Set as Default — Click to set a style as the default style for your newly-created accounts.Note:This action only sets the default for new accounts that you create. It does not set the style for existing accounts on the server.
Download Style — Click to download the style. You may wish to download existing styles to customize them or use them as a base for new styles.
Delete — Click the trash can icon () to delete a style. Then, click Delete again to confirm the deletion.Note:
You can only perform this action on styles that you uploaded and own.
Delete — Click the trash can icon () to delete a style. Then, click Delete again to confirm the deletion.Note:You can only perform this action on styles that you uploaded and own.
We strongly recommend that you update this. Otherwise, customers see the default information, which may hurt your brand.
The cPanel interface will not show the company name that you enter in the Customize Branding tab on placeholder pages.
Resellers who own their accounts can add custom information to their main domains.
Main domains for other resellers use the server owner’s information.
For example, when the system displays a placeholder page to a user, they may see the following message:
If you are the owner of this website, please contact your hosting provider: firstname.lastname@example.org
email@example.com a link to the hosting provider’s default contact email address. If you update this information, you can choose a specific email address or URL instead.
For information on how to remove this information from the Account Suspended and Default Webpage site templates, read our Web Template Editor documentation.
Customize contact information
To enter your public contact information:
Enter your company’s name in the Public Company Name text box.
Enter your company’s URL in the Public Contact URL text box.
cPanel & WHM stores branding information in the
reseller_info.json file, which exists in either the
root user’s or reseller’s brand directory.
If the reseller who owns the account has specified custom branding information, the cPanel user sees the reseller’s branding in the cPanel interface.
If the reseller has not specified custom branding information, but the
rootuser has, the cPanel user sees the
rootuser’s branding in the cPanel interface.
If neither the reseller nor the
rootuser have specified custom branding information, the cPanel user does not see any customizations to the cPanel interface.
When you save your customizations through this interface, the system stores your items in the following directories:
resellernamerepresents the reseller’s username.
stylenamerepresents the style’s name. For example, if you upload the
mystyle.tar.gzfile, the system stores the style’s files in the
|Item||File path||File name|
|Item||File path||File name|
.svglogo first. If no
.svglogo exists, the system uses the
.pnglogo, if one exists.