{"id":883,"date":"2021-07-23T12:40:20","date_gmt":"2021-07-23T12:40:20","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/customization\/"},"modified":"2021-07-23T12:40:20","modified_gmt":"2021-07-23T12:40:20","slug":"customization","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/customization\/","title":{"rendered":"Customization"},"content":{"rendered":"<\/p>\n<div class=\"col-md-9\">\n<div class=\"flex-column flex-md-row article-header\">\n<div id=\"versioned-article-header\">\n<p class=\"valid-version-info\"><em>Valid for versions 82 through the latest version<\/em><\/p>\n<\/div>\n<div id=\"version-select-group\" aria-label=\"select versions\">\n<h4>Version:<\/h4>\n<h4>82<\/h4>\n<\/div><\/div>\n<hr>\n<h2 id=\"overview\">Overview<\/h2>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>Changes made in this interface (aside from Public Contact) <strong>only<\/strong> apply to the Paper Lantern theme.<\/p>\n<\/p><\/div>\n<\/div>\n<p>This interface allows you to customize parts of the cPanel and Webmail interfaces. You can:<\/p>\n<ul>\n<li>\n<p>Upload custom logos.<\/p>\n<\/li>\n<li>\n<p>Upload a favicon.<\/p>\n<\/li>\n<li>\n<p>Update parts of the cPanel interface to match your company\u2019s branding.<\/p>\n<\/li>\n<li>\n<p>Upload custom cPanel styles.<\/p>\n<\/li>\n<li>\n<p>Update the contact information on publicly-visible placeholder pages.<\/p>\n<\/li>\n<\/ul>\n<p>For the purposes of cPanel, L.L.C.\u2019s products and documentation, we use the following terms:<\/p>\n<ul>\n<li>\n<p><strong>Branding<\/strong> \u2014 Branding modifies the cPanel interface in order to match your company\u2019s logo and brand.<\/p>\n<ul>\n<li>\n<p>Branding changes include updates to image assets or text labels.<\/p>\n<\/li>\n<li>\n<p>For more information, read our Branding documentation.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p><strong>Includes<\/strong> \u2014 UI includes add custom content to the header or footer of the cPanel interface (but not the WHM interface).<\/p>\n<ul>\n<li>\n<p>You can create UI includes for specific cPanel interfaces, or global UI includes that display on all of cPanel\u2019s interfaces.<\/p>\n<\/li>\n<li>\n<p>For more information, read our UI Includes documentation.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p><strong>Plugin<\/strong> \u2014 A plugin modifies an interface\u2019s features or functionality, and it may also include changes to the interface\u2019s appearance.<\/p>\n<ul>\n<li>\n<p>You can write plugins for the cPanel or WHM interfaces.<\/p>\n<\/li>\n<li>\n<p>You can use the cPanel Style Guide to ensure that your interfaces match the appearance of standard cPanel interfaces.<\/p>\n<\/li>\n<li>\n<p>For more information, read our Guide to cPanel Plugins documentation.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p><strong>Style<\/strong>  \u2014 A style uses CSS, images, and other assets to modify the appearance of the entire cPanel interface without changes to its functionality or features.<\/p>\n<ul>\n<li>\n<p>You can create and apply styles to an entire server or a specific reseller\u2019s accounts, or you can create them for distribution.<\/p>\n<\/li>\n<li>\n<p>For more information, read our cPanel Style Development documentation.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p><strong>Theme<\/strong> \u2014 A theme applies an overlay on the skeletal framework for all of the interfaces.<\/p>\n<ul>\n<li>\n<p>cPanel &#038; WHM currently ships with one default cPanel theme and one default WHM theme.<\/p>\n<\/li>\n<li>\n<p>The Webmail and login interfaces also use themes.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"customize-branding\">Customize Branding<\/h2>\n<p>To customize the cPanel or Webmail interfaces:<\/p>\n<ol>\n<li>\n<p>Enter your company\u2019s name in the <em>Company Name<\/em> text box to brand the interface with your company name.<\/p>\n<ul>\n<li>\n<p>Use this option if you don\u2019t want to upload a custom logo.<\/p>\n<\/li>\n<li>\n<p>If you use this option, your company name will appear in the default cPanel font. <\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<ul>\n<li>\n<p>To change the font style, you <strong>must<\/strong> customize cPanel\u2019s CSS with a custom style.<\/p>\n<\/li>\n<li>\n<p>The <em>Company Name<\/em> value <strong>cannot<\/strong> exceed 50 characters. The cPanel interface truncates it if the name\u2019s width exceeds the width of the user\u2019s browser window.<\/p>\n<\/li>\n<\/ul><\/div>\n<\/div>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Enter your help or support URL in the <em>Help Link<\/em> text box to customize the <em>Help<\/em> link. The <em>Help<\/em> link <strong>won\u2019t<\/strong> appear in the cPanel interface until you enter a custom URL.<\/p>\n<\/li>\n<li>\n<p>Enter your documentation URL in the <em>Documentation Link<\/em> text box to customize the <em>Documentation<\/em> link. If you don\u2019t enter a custom <em>Documentation<\/em> link, the <em>Documentation<\/em> link points to the cPanel, L.L.C. documentation.<\/p>\n<\/li>\n<li>\n<p>Click <em>Browse<\/em> under the desired heading to add your company logo, Webmail logo, or favicon. Then, select the desired file.<\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<ul>\n<li>\n<p>cPanel &#038; WHM has specific icon size and file type requirements. For more information, read our Guide to cPanel Interface Customization &#8211; Custom Icons and Logos documentation.<\/p>\n<\/li>\n<li>\n<p>If you upload a file with this interface, the system saves it as an <code>.svg<\/code> file.<\/p>\n<\/li>\n<li>\n<p>To delete an uploaded logo, click the trash can icon (<img src=\"https:\/\/ssdsunucum.com\/blog\/wp-content\/uploads\/2021\/07\/trashicon.png\" title=\"trashicon\">) for that image file.<\/p>\n<\/li>\n<\/ul><\/div>\n<\/div>\n<\/li>\n<li>\n<p>To apply your changes, click <em>Save<\/em>.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"customize-style\">Customize Style<\/h2>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>You can download an example skeleton style to help you create a new style.<\/p>\n<\/p><\/div>\n<\/div>\n<h3 id=\"upload-a-custom-style\">Upload a custom style<\/h3>\n<p>To upload custom cPanel styles:<\/p>\n<ol>\n<li>\n<p>Click <em>Upload a Style<\/em>.<\/p>\n<\/li>\n<li>\n<p>To select a style to upload, click <em>Browse<\/em>.<\/p>\n<ul>\n<li>\n<p>The system uses the <code>.tar.gz<\/code> file\u2019s name as the style\u2019s name.<\/p>\n<\/li>\n<li>\n<p>You <strong>must<\/strong> upload your custom style as a <code>.tar.gz<\/code> file, which <strong>must<\/strong> contain the <code>styles.css<\/code> file, the <code>styles.min.css<\/code> file, or both. <\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>We <strong>strongly<\/strong> recommend that you include <strong>both<\/strong> files.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>To set the style as the default style, select the <em>Set this style as my default style<\/em> checkbox.<\/p>\n<\/li>\n<li>\n<p>Click <em>Upload<\/em>. <\/p>\n<div class=\"callout callout-warning\">\n<div class=\"callout-heading\">Important:<\/div>\n<div class=\"callout-content\">\n<p>We <strong>strongly<\/strong> recommend that you keep your custom styles up to date to avoid compatibility issues when you upgrade cPanel &#038; WHM. To do this, perform the following actions:<\/p>\n<ul>\n<li>\n<p>Monitor our Change Logs and our Release Notes documentation for updated features and bug fixes.<\/p>\n<\/li>\n<li>\n<p>Make <strong>certain<\/strong> that your server runs on the LTS, STABLE, RELEASE, or CURRENT release tiers, so that it receives any functionality updates.<\/p>\n<\/li>\n<li>\n<p>You can also use a server that runs on the EDGE release tier to test for compatibility and functionality in a controlled environment.<\/p>\n<\/li>\n<\/ul><\/div>\n<\/div>\n<\/li>\n<\/ol>\n<h3 id=\"manage-styles\">Manage styles<\/h3>\n<div class=\"callout callout-warning\">\n<div class=\"callout-heading\">Important:<\/div>\n<div class=\"callout-content\">\n<p>To modify the theme or style for existing accounts, use the <code>\/usr\/local\/cpanel\/scripts\/modify_accounts<\/code> script.<\/p>\n<\/p><\/div>\n<\/div>\n<p>Use the <em>Manage Styles<\/em> section to work with styles. To filter the list of styles, click the desired filter name.<br \/>\nFor each style, you can perform the following actions:<\/p>\n<ul>\n<li>\n<p><em>Set as Default<\/em> \u2014 Click to set a style as the default style for your newly-created accounts.<\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>This action <strong>only<\/strong> sets the default for new accounts that you create. It does <strong>not<\/strong> set the style for existing accounts on the server.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n<li>\n<p><em>Set as Default<\/em> \u2014 Click to set a style as the default style for your newly-created accounts.<\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n        This action <strong>only<\/strong> sets the default for new accounts that you create. It does <strong>not<\/strong> set the style for existing accounts on the server.\n    <\/div>\n<\/div>\n<\/li>\n<li>\n<p><em>Download Style<\/em> \u2014 Click to download the style. You may wish to download existing styles to customize them or use them as a base for new styles.<\/p>\n<\/li>\n<li>\n<p><em>Delete<\/em> \u2014 Click the trash can icon (<img src=\"https:\/\/ssdsunucum.com\/blog\/wp-content\/uploads\/2021\/07\/trashicon.png\" title=\"trashicon\">)  to delete a style. Then, click <em>Delete<\/em> again to confirm the deletion.<\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>You can <strong>only<\/strong> perform this action on styles that you uploaded and own.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n<li>\n<p><em>Delete<\/em> \u2014 Click the trash can icon (<img src=\"https:\/\/ssdsunucum.com\/blog\/wp-content\/uploads\/2021\/07\/trashicon.png\" title=\"trashicon\">)  to delete a style. Then, click <em>Delete<\/em> again to confirm the deletion.<\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n        You can <strong>only<\/strong> perform this action on styles that you uploaded and own.\n    <\/div>\n<\/div>\n<\/li>\n<\/ul>\n<h2 id=\"public-contact\">Public Contact<\/h2>\n<div class=\"callout callout-warning\">\n<div class=\"callout-heading\">Important:<\/div>\n<div class=\"callout-content\">\n<ul>\n<li>\n<p>We <strong>strongly recommend<\/strong> that you update this. Otherwise, customers see the default information, which may hurt your brand.<\/p>\n<\/li>\n<li>\n<p>The cPanel interface will <strong>not<\/strong> show the company name that you enter in the <em>Customize Branding<\/em> tab on placeholder pages.<\/p>\n<\/li>\n<\/ul><\/div>\n<\/div>\n<p>The Account Suspended and Default Webpage interfaces show visitors your contact information. Users will also see it when they search for your contact information.<\/p>\n<ul>\n<li>\n<p>Resellers who own their accounts can add custom information to their main domains.<\/p>\n<\/li>\n<li>\n<p>Main domains for other resellers use the server owner\u2019s information.<\/p>\n<\/li>\n<\/ul>\n<p>For example, when the system displays a placeholder page to a user, they may see the following message:\n<\/p>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-bash\" data-lang=\"bash\">If you are the owner of this website, please contact your hosting provider: webmaster@10.0.2.0<\/code><\/pre>\n<\/div>\n<p>In this example, <code>webmaster@10.0.2.0<\/code> is a link to the hosting provider\u2019s default contact email address. If you update this information, you can choose a specific email address or URL instead.<\/p>\n<p>For information on how to remove this information from the <em>Account Suspended<\/em> and <em>Default Webpage site<\/em> templates, read our Web Template Editor documentation.<\/p>\n<h3 id=\"customize-contact-information\">Customize contact information<\/h3>\n<p>To enter your public contact information:<\/p>\n<ol>\n<li>\n<p>Enter your company\u2019s name in the <em>Public Company Name<\/em> text box.<\/p>\n<\/li>\n<li>\n<p>Enter your company\u2019s URL in the <em>Public Contact URL<\/em> text box.<\/p>\n<\/li>\n<li>\n<p>Click <em>Save<\/em>.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"file-locations\">File locations<\/h2>\n<p>cPanel &#038; WHM stores branding information in the <code>reseller_info.json<\/code> file, which exists in either the <code>root<\/code> user\u2019s or reseller\u2019s brand directory.<\/p>\n<ul>\n<li>\n<p>If the reseller who owns the account has specified custom branding information, the cPanel user sees the reseller\u2019s branding in the cPanel interface.<\/p>\n<\/li>\n<li>\n<p>If the reseller has <strong>not<\/strong> specified custom branding information, but the <code>root<\/code> user <strong>has<\/strong>, the cPanel user sees the <code>root<\/code> user\u2019s branding in the cPanel interface.<\/p>\n<\/li>\n<li>\n<p>If neither the reseller nor the <code>root<\/code> user have specified custom branding information, the cPanel user does <strong>not<\/strong> see any customizations to the cPanel interface.<\/p>\n<\/li>\n<\/ul>\n<p>When you save your customizations through this interface, the system stores your items in the following directories:<\/p>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<ul>\n<li>\n<p><code>resellername<\/code> represents the reseller\u2019s username.<\/p>\n<\/li>\n<li>\n<p><code>stylename<\/code> represents the style\u2019s name. For example, if you upload the <code>mystyle.tar.gz<\/code> file, the system stores the style\u2019s files in the <code>\/home\/resellername\/var\/cpanel\/reseller\/styled\/mystyle<\/code> directory.<\/p>\n<\/li>\n<\/ul><\/div>\n<\/div>\n<p><strong>Reseller<\/strong><\/p>\n<table>\n<thead>\n<tr>\n<th>Item<\/th>\n<th>File path<\/th>\n<th>File name<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Favicon<\/td>\n<td><code>\/home\/resellername\/var\/cpanel\/reseller\/brand<\/code><\/td>\n<td><code>favicon.ico<\/code><\/td>\n<\/tr>\n<tr>\n<td>Logo<\/td>\n<td><code>\/home\/resellername\/var\/cpanel\/reseller\/brand<\/code><\/td>\n<td><code>logo.svg<\/code> <strong>or<\/strong> <code>logo.png<\/code><\/td>\n<\/tr>\n<tr>\n<td>Webmail logo<\/td>\n<td><code>\/home\/resellername\/var\/cpanel\/reseller\/brand<\/code><\/td>\n<td><code>webmail.svg<\/code> <strong>or<\/strong> <code>webmail.png<\/code><\/td>\n<\/tr>\n<tr>\n<td>Custom styles<\/td>\n<td><code>\/home\/resellername\/var\/cpanel\/reseller\/styled\/stylename<\/code><\/td>\n<td>N\/A<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><strong>Root<\/strong><\/p>\n<table>\n<thead>\n<tr>\n<th>Item<\/th>\n<th>File path<\/th>\n<th>File name<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Favicon<\/td>\n<td><code>\/var\/cpanel\/customizations\/brand<\/code><\/td>\n<td><code>favicon.ico<\/code><\/td>\n<\/tr>\n<tr>\n<td>Logo<\/td>\n<td><code>\/var\/cpanel\/customizations\/brand<\/code><\/td>\n<td><code>logo.svg<\/code> <strong>or<\/strong> <code>logo.png<\/code><\/td>\n<\/tr>\n<tr>\n<td>Webmail logo<\/td>\n<td><code>\/var\/cpanel\/customizations\/brand<\/code><\/td>\n<td><code>webmail.svg<\/code> <strong>or<\/strong> <code>webmail.png<\/code><\/td>\n<\/tr>\n<tr>\n<td>Custom styles<\/td>\n<td><code>\/var\/cpanel\/customizations\/styled\/stylename<\/code><\/td>\n<td>N\/A<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n        The system checks for a <code>.svg<\/code> logo first. If no <code>.svg<\/code> logo exists, the system uses the <code>.png<\/code> logo, if one exists.\n    <\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Valid for versions 82 through the latest version Version: 82 Overview Note: Changes made in this interface (aside from Public Contact) only apply to the Paper Lantern theme. 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 &hellip;<\/p>\n","protected":false},"author":1,"featured_media":884,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/883"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=883"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/883\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/884"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=883"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=883"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=883"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}