Knowledgebase: WHM > cPanel > Customization
Customization
Posted by Matthew Jeffels, Last modified by Matthew Jeffels on 30 December 2016 03:28 PM

Customization

This interface allows you to upload custom logo's and a favicon, modify aspects of the cPanel interface and upload new custom cPanel styles.

If you want to create your own cPanel style you can download an example skeleton style to aid you in the style creation process.

Customize Branding

To use your own customized branding on your server, select the "Customize Branding" tab. You will then need to follow these steps;

To brand the interface with the name of your company enter your company's name into the "Company Name" textbox. 

You should use this option if you do not wish to upload your own custom logo. The company name will then be displayed in cPanel's default font.
If you wish to change the font style you will have to customize cPanel's CSS via a custom style. The company name cannot exceed 50 characters.

To customize the "Help" link enter your help or support website into the "Help Link" textbox. The help link will not appear in the cPanel interface until you enter a custom URL.

To customize the "Documentation Link" enter your documentations websites link into the "Documentation Link" textbox. By default this will be a link to cPanel's documentation website.

In order to customize your company logo, webmail logo, or favicon, click "Browsw" under the heading of said icon you wish to change. You will then need to select the logo that you wish to upload.

To delete an uploaded logo, click the trash can icon for that file.

To apply your changes click save.

Customize Style

To upload custom cPanel styles you will need to perform the following;

Click Upload a Style.
To select a style to upload, click Browse.

You must upload your custom style as a .tar.gz file, which must contain the styles.css file, the styles.min.css file, or both. We strongly recommend that you include both the styles.css and styles.min.css files. The system uses the .tar.gz file's name as the style's name.

To set the style as the default style, select the Set this style as my default style checkbox. Click Upload.

The Manage Styles section allows you to view available styles, set a style as the default style for newly-created accounts, download styles, and delete styles that you uploaded.

To filter the list of styles, click the desired filter name. For each style that the interface displays, you can perform the following actions to it;

Set as Default — Click to set a style as the default style for your newly-created accounts. 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 in order to customize them or use them as a base for new styles.
Delete — Click the trash can icon to delete a style, and then click Delete again to confirm the deletion. You can only perform this action on styles that you uploaded and own.

File Locations

cPanel & WHM stores branding information in the reseller_info.json file, which is found in either the root user's or reseller's brand directory.

If it is 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 specified custom branding information, the cPanel user sees the root 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 will store your items in the following directories;

Reseller's: In this instance "resellername" represents the reseller's username.

Favicon - found in the "/home/resellername/var/cpanel/reseller/brand" directory with the file name "favicon.ico".
Logo - found in the "/home/resellername/var/cpanel/reseller/brand" directory with the file name "logo.png" or "logo.svg". 
Webmail logo - found in the "/home/resellername/var/cpanel/reseller/brand" directory with the file name "webmail.png" or "webmail.svg". 
Custom styles - found in the "/home/resellername/var/cpanel/reseller/styled/stylename" directory "stylename" represents the style's name. If you upload a style with the mystyle.tar.gz filename, the system will store the style's files in the /home/resellername/var/cpanel/reseller/styled/mystyle directory.

For the Root user;

Favicon - found in the "/var/cpanel/customizations/brand" directory with the file name "favicon.ico".
Logo - found in the "/var/cpanel/customizations/brand" directory with the file name "logo.png" or "logo.svg". 
Webmail logo - found in the "/var/cpanel/customizations/brand" directory with the file name "webmail.png" or "webmail.svg". 
Custom styles - found in the "/var/cpanel/customizations/styled/stylename" directory "stylename" represents the style's name. If you upload a style with the mystyle.tar.gz filename, the system will store the style's files in the /home/resellername/var/cpanel/reseller/styled/mystyle directory.

Thanks

Matt Jeffels
PAC Web Hosting

(0 vote(s))
Helpful
Not helpful

Comments (0)