Introduction
cPanel & WHM version 11.44 and later uses an install.json
file to add icons and groups.This file passes information to cPanel's dynamicui
files when you install your plugin. This method allows the user to install a plugin for both x3 and Paper Lantern.
While you can also add items directly to Paper Lantern's dynamicui
files, we strongly recommend that you use the install.json
file method.
Warning:
The manual method in our Add Plugins to cPanel & WHM 11.42 and earlier documentation does not work in Paper Lantern.
The install.json
file
To create an install.json
file for your plugin, perform the following steps:
-
Create the
install.json
file. - Add one or more groups to the
install.json
file. - Add one or more icons to the
install.json
file. - Include the complete
install.json
file in your compressed installation file.
Note:
When you use the install.json
file method, you must use the install_plugin
script to install your plugin to the cPanel interface.
Add groups
Group entries in install.json
files appear similar to the following example:
{ "name" : "Custom Group", "order" : 11, "type" : "group", "id" : "my_plugins" "implements" : "Filemanager_home"
Parameter |
Type |
Description |
Possible values |
Example |
name |
string |
Required The name of the group, as it will display in the cPanel interface. In dynamicui files, this parameter becomes thegroupdesc key. |
A string value.
|
Custom Group |
order |
integer |
Required The group's order in the cPanel interface. In dynamicui files, this parameter becomes thegrouporder key. |
An integer that represents the order in which the group displays. Note: Groups with a lower ordervalue display first. |
11 |
type |
string |
Required The item's type. This value determines whether the installation process converts the item into a group entry or an icon entry in the dynamicui files. |
Important: For groups, this value must begroup. |
group |
id |
string |
Required The group's internal name. In dynamicui files, this parameter becomes the groupkey. |
A string value. |
my_plugins |
implements |
string |
The app_key value that the create_user_session andget_users_links functions use when you register the plugin. |
The app_key value to override. Note: For a complete list of the variables to use for the app_key parameter, read our Guide to cPanel Interface Customization - Appkeys documentation.
|
FileManager_Home |
Add icons
Icon entries in install.json
files appear similar to the following example:
{ "icon" : "one.png", "group_id" : "my_plugins", "order" : 10000, "name" : "Support", "type" : "link", "id" : "plugin_one", "uri" : "http://support.example.com" "target" : "_blank" },
Use the following parameters to configure each icon:
Parameter |
Type |
Description |
Possible values |
Example |
id |
string |
Required The group's internal name. In dynamicui files, this parameter becomes the groupkey. |
A string value. |
my_plugins |
implements |
string |
The app_key value that the create_user_session andget_users_links functions use when you register the plugin. |
The app_key value to override. Note: For a complete list of the variables to use for the app_key parameter, read our Guide to cPanel Interface Customization - Appkeys documentation.
|
FileManager_Home |
name |
string |
Required The name of the group, as it will display in the cPanel interface. In dynamicui files, this parameter becomes thegroupdesc key. |
A string value.
|
Custom Group |
order |
integer |
Required The group's order in the cPanel interface. In dynamicui files, this parameter becomes thegrouporder key. |
An integer that represents the order in which the group displays. Note: Groups with a lower ordervalue display first. |
11 |
type |
string |
Required The item's type. This value determines whether the installation process converts the item into a group entry or an icon entry in the dynamicui files. |
Important: For groups, this value must begroup. |
group |
Add icons to an existing group
You can also add plugin icons to groups that already exist in Paper Lantern. Use the following group names to add an icon to an existing group:
files
databases
domains
email
metrics
security
software
advanced