Control cPanel Style Documentation


Contents


  1. Theme requirements
  2. Installation instructions
  3. Upgrade instructions
  4. Customising Control theme
  5. Trouble-shooting and support
  6. Changelog and release history

 

Theme requirements


Control cPanel style is a style for cPanel’s default paper lantern theme. In order to install Control cPanel style, we recommend that you have the latest version of cPanel and WHM installed (minimum version 61), and have set cPanel’s Paper Lantern theme as the default theme.

The current version of Control cPanel style is designed to work with cPanel version 61 – 66.

 

Installation instructions


Please follow the instructions below to download and install the latest version of Control cPanel style.

 

Step 1: download Control cPanel style

To download the latest version of Control cPanel style, please follow the steps below:

  1. Log in to My Account
  2. Select Account Overview from the My Account menu
  3. Scroll down the Account Overview page to the My Products section and select Control cPanel style from the list of available products
  4. Scroll down the Control cPanel style page to the Product Downloads section
  5. Choose the version of the theme you would like to download (we would always recommend using the latest available version of Control cPanel style alongside the latest version of cPanel and WHM) and click the download button
  6. Extract the contents of the downloaded zip file on your computer

 

Step 2: install Control cPanel style

In order to install Control cPanel style, you should be using the latest version of cPanel and WHM (minimum version 61), and have set cPanel’s Paper Lantern theme as the default theme.

After downloading and extracting the Control cPanel style product zip file, you will find a further six .tar.gzarchive files, one for each color scheme. These are the packaged cPanel styles and should not be extracted/unzipped (unless you intend to edit them) as they will need to be uploaded to your server as is.

Follow the steps below to install your preferred style / color scheme:

  1. Log in to WHM and navigate to Home > cPanel > Customization
  2. Select the Customize Style tab
  3. Click on the Upload a Style to reveal the upload interface
  4. Click on the Browse button then navigate to the product download file on your computer and select the appropriate .tar.gzarchive file for the color scheme that you wish to upload
  5. Check the Set this style as my default style checkbox if you wish to set this style as the default style for all current cPanel accounts which have not specified an alternative theme/style and all new accounts
  6. Finally click the Upload button to upload your chosen style

If you wish to upload more than one style / color scheme, repeat the steps above as necessary.

Please note: if you log into cPanel as root, the style will be made available for all users and resellers, if you log in as a reseller the style will only be available to accounts associated to that particular reseller account.

 

Step 3: activate Control cPanel style

If you selected the Set this style as my default style option during upload, the style will be automatically set for all cPanel accounts which have not specified an alternative theme/style and all new accounts.

If you did not select the Set this style as my default style option during upload, you can set any style as the default style, or change the default style at any time, by following the instructions below:

  1. Log in to WHM and navigate to Home > cPanel > Customization
  2. Select the Customize Style tab
  3. Scroll down the list of available styles and click the Set as Default link for your preferred style

If you would like to set Control cPanel style as the active style for a particular or individual cPanel account, you can do this from within cPanel itself, by searching for / navigating to the Change Style option. You will then be presented with a list of available styles, and can select your preferred style by clicking the Apply button.

If you have set Control cPanel style as the default style in WHM for all accounts and would like to prevent users from changing to a different style from within cPanel, you can disable the cPanel Change Style option by following the instructions below:

  1. Log in to WHM and navigate to Home > Packages > Feature Manager
  2. Select a feature list to manage from the Manage feature list select field and click edit (If you have not assigned a particular feature list to your packages, you will need to edit the default feature list, alternatively you can create a new feature list and assign this to packages in em>Home > Packages > Edit a Package)
  3. Uncheck the Change Style option and click Save

 

Upgrade instructions


Firstly, follow the instructions in step 1 above to download the latest version of Control cPanel style.

If you have not previously changed or customized any of the style files, you can simply upload the latest version in place of the previous version following the steps below:

… uplouad steps (including delete old verison)

  1. Log in to WHM and navigate to Home > cPanel > Customization
  2. Select the Customize Style tab
  3. Select the style/color scheme you are intending to update from the list of available styles and click the rubbish bin icon to remove it from the system (you must delete the previous version before uploading the new version)
  4. After deleting the previous version, click on the Upload a Style to reveal the upload interface
  5. Click on the Browse button then navigate to the product download file on your computer and select the appropriate .tar.gzarchive file for the color scheme that you wish to upload
  6. Check the Set this style as my default style checkbox if you wish to set this style as the default style for all current cPanel accounts which have not specified an alternative theme/style and all new accounts
  7. Finally click the Upload button to upload your chosen style

If you have previously customized any of the style files, you must re-apply your customizations to the new version before following the steps above to upgrade.

 

Customizing Control cPanel style


All of our code is fully open, unencrypted and editable, meaning that should for any reason our products provided as are do not suit your exact requirements, you are free to customise the code as necessary. Whilst you are perfectly welcome to do this, please note that our support team is unable to provide support or assistance with this process. We are only able to provide assistance with the installation, configuration and use of our products as provided in accordance with our theme documentation.

Tip: it’s always a good idea to keep a record of any customizations/changes that you make for future reference.

Before customizing the style, you will need to extract the tar.gz archive of the color scheme you intend to customize.

Within the extracted folder, you will the following files and directories:

  • styles.css – contains all of the styles for Control cPanel Style
  • preview.png – a preview image (that is shown in WHM and cPanel Style Chooser
  • img (directory) – contains any image files used by the style

To customize Control cPanel Style, you will need to edit the file styles.css. It is recommended to add any custom styles to the end of the document, as this will make it easier to re-apply your custom styles when you upgrade to future versions.

After you have completed your customizations, you will need to re-archive the folder as a .tar.gz file – you can find a number of software packages to do this for you, or it can be done via the command line. If you want to change the name of the style, you should rename the folder before archiving.

You can then upload your edited cPanel style following the steps above.

 

Trouble-shooting and support


If you can’t find a solution to your problem in this theme documentation or our frequently asked questions, please open a support ticket to request technical support.

 

Changelog and release history


Version Release Date WHM/cPanel Version Compatibility Changelog / Release Notes
1.0.0 10 March 2017 61-62 View Release Notes