cPanel Plugin File Generator
Posted by Allura on 06 08 2019.
You can use cPanel’s plugin file generator interface to create an installation file for cPanel’s Paper Lantern theme. The installation file will automate the installation process for the plugin and store the desired plugin configuration in the /var/cpanel/cpanel_plugin_generator/ directory as a .tar.gz file.
(WHM > Home > Development > cPanel Plugin File Generator)
Items in cPanel belong to specific groups (like Databases or Files). The items act as links to those interfaces (for example, File Manager or Email Accounts).
Note – You’ll have to be logged in as the root user to access this interface. More information about how to create plugins manually is found in the Guide to cPanel Plugins section. Information about how to add groups and icons to plugins is also found in the Guide to cPanel Plugin section in the Version 11.44 and Later Plugins subsection.
Steps to generate a plugin installation file
You need to make sure that nothing you enter here can adversely affect your server. This is due to the fact that this interface does not authorize the input in the URI and Name text boxes.
Follow these steps to create a plugin installation file:
- Every plugin has to have a unique identifier. Enter it into the Unique Identifier text box. If the name you typed already exists, a warning pops up which will ask you if you want to overwrite the existing one or not. Check it only if you do.
- Type the display name in the text box that says
- Check the Feature Manager Support box in case you want to control access to said plugin using the Feature Manager interface of WHM (WHM > Home > Features > Feature Manager).
- Next, pick the group under which the plugin icon appears from the Group Click the (+) icon to add a new group and enter its name in the text box, New Group Name.
- Now enter the priority value for the icon in the Priority text box. This number ranges between 1 and 99 with lower numbers being higher priority.
- The URI textbox now provides the space to enter the plugin location.
- Select an icon for the plugin by clicking on Remember that icon files must have either PNG or SVG format. Also, icons for Paper Lantern have to be 48×48 pixels. Larger images could render incorrectly since this interface does not resize images.
- You can now add your new item to the New Plugin Information section by clicking on Add Item. Enter the name of the plugin in the text box and click on
- Follow steps 1 through 7 for all the plugins you want to include in the installation file.
Note – You can only use numbers, lower case letters, hyphens (-) and underscores (_) for the name. You also cannot use a name already taken by an existing plugin.
- Click the link at the top of the banner to download the installation file. It’s saved in the format and directory as mentioned in the beginning. The banner goes away once you navigate away from this interface or start creating a new plugin.
You’ll now have to use the /usr/local/cpanel/scripts/install_plugin script to install the downloaded plugin to the Paper Lantern theme. You have to be a root user to use this script.
These are the steps to follow if you want to generate an installation file for a plugin on cPanel.