Last modified: March 7, 2022
Overview
- We deprecated the Paper Lantern theme in cPanel & WHM version 102.
- This interface’s options change based on the theme that you select.
This interface allows you to customize parts of the cPanel interface. You can modify the following items:
- 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:
Term | Description |
---|---|
Branding | Branding modifies the cPanel interface in order to match your company’s logo and brand.
|
Includes | UI includes add custom content to the header or footer of the cPanel interface (but not the WHM interface).
|
Plugin | A plugin modifies an interface’s features or functionality, and it may also include changes to the interface’s appearance.
|
Theme | A theme applies an overlay on the skeletal framework for all of the interfaces.
|
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.
|
Select a theme
The feature allows you to choose a theme. To choose a theme, use the menu to select which theme you wish to customize. You can select the following themes:
- Jupiter
- Paper Lantern (deprecated)
The theme you select will update the features that you can customize.
Jupiter customization options
When you select the Jupiter theme, the interface will show the following options:
Logos
The Logos tab allows you to update the following items:
- A logo for light backgrounds.
- A logo for dark backgrounds.
- A logo description.
To update the logos and description, perform the following steps:
You can only use the .svg
file format.
- Under Company Logo - used with dark background colors, click Browse.
- Select logo that you wish to use, and click Open. A preview of the logo will appear.
- Under Company Logo - used with light background colors, click Browse.
- Select logo that you wish to use, and click Open. A preview of the logo will appear.
- In the Description text box, enter a description for the image tag.
Note:The information you enter updates the alt text for the logo. Screen readers use this text to describe the page content.
- Click Update Logos.
Colors
The Colors tab allows you to update the color of cPanel’s Main Menu.
To update the Main Menu color, perform the following steps:
- Click the Main Menu Background Color text box and use the color wheel to choose the color you prefer. Or, enter the hexadecimal color format that you prefer.
- Click Update Colors.
To restore the Main Menu’s default colors, click Restore Defaults.
Favicon
The Favicon tab allows you to update the cPanel interface’s favicon.
You can only use the .ico
file format.
To update the favicon, perform the following steps:
- Click Browse.
- Select favicon that you wish to use, and click Open. A preview of the favicon will appear.
- Click Update Favicon.
Links
The Links tab allows you to update the Documentation and Help links in the cPanel interface footer.
To update the links, perform the following steps:
- Enter your preferred link in the Help Link text box.
- Enter your preferred link in the Documentation Link text box.
- Click Update Links.
Public Contact
The Public Contact tab allows you to customize the contact information that cPanel & WHM provides for a cPanel account’s default website page and suspended website page.
To update your contact information, perform the following steps:
- Enter your company’s name in the Public Company Name text box.
- Enter your company’s contact URL in the Public Contact URL text box.
- Click Save.
Paper Lantern customization options
When you select the Paper Lantern theme, the interface will show the following options:
Customize Branding
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.
Note:This option only exists as part of the Paper Lantern theme. We strongly recommend that you upload an image to use as a company logo and then set alternative text for that image.
If you use this option, your company name will appear in the default cPanel font.
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
.svg
file.To delete an uploaded logo, click the trash can icon (
) for that image file.
To apply your changes, click Save.
Customize Style
Styles only exist as part of the Paper Lantern theme.
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.gz
file’s name as the style’s name.You must upload your custom style as a
.tar.gz
file, which must contain thestyles.css
file, thestyles.min.css
file, 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.
Click Upload.
Important: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.
Manage styles
To modify the theme or style for existing accounts, use the /usr/local/cpanel/scripts/modify_accounts
script.
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.
Public Contact
We strongly recommend that you update this information. Otherwise, customers see the default information, which may hurt your brand.
The cPanel interface will not display the company name that you enter in the Customize Branding tab on placeholder pages.
The Account Suspended and Default Webpage interfaces show visitors this Public Contact information. Users will also see it when they search for your contact information.
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: [email protected]
[email protected]
is 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.
Click Save.
File locations
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
root
user has, the cPanel user sees theroot
user’s branding in the cPanel interface.If neither the reseller nor the
root
user 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:
resellername
represents the reseller’s username.stylename
represents the style’s name. For example, if you upload themystyle.tar.gz
file, the system stores the style’s files in the/home/resellername/var/cpanel/reseller/styled/mystyle
directory.
Reseller
Item | File path | File name |
---|---|---|
Favicon | /home/resellername/var/cpanel/reseller/brand |
favicon.ico |
Logo | /home/resellername/var/cpanel/reseller/brand |
logo.svg or logo.png |
Webmail logo | /home/resellername/var/cpanel/reseller/brand |
webmail.svg or webmail.png |
Custom styles | /home/resellername/var/cpanel/reseller/styled/stylename |
N/A |
Root
Item | File path | File name |
---|---|---|
Favicon | /var/cpanel/customizations/brand |
favicon.ico |
Logo | /var/cpanel/customizations/brand |
logo.svg or logo.png |
Webmail logo | /var/cpanel/customizations/brand |
webmail.svg or webmail.png |
Custom styles | /var/cpanel/customizations/styled/stylename |
N/A |
.svg
logo first. If no .svg
logo exists, the system uses the .png
logo, if one exists.