Add an installation script.

You can include an installation script with your WHM plugins.We do not require a specific programming language or other specific details for this script. However, we strongly recommend that you create one, and that it performs at least the following actions:

Check for the appropriate installation directories and create any that do not already exist.

Register the plugin with the AppConfig system.

Copy the plugin files, templates, and icons into the correct locations.

Important:

AppConfig registration does not automatically search for or run installation scripts. Whenever system administrators install plugins, they must decompress the files and run the installation script manually.

Add an icon.

We strongly recommend that you use 48x48 .png images with a transparent background.

Image files must use a supported image file type (.gif, .jpeg, or .png).

Add other assets.

Add any other files or assets to your plugin files. Many WHM plugins include the following additional files:

A LICENSE file provides license information for a plugin.

A README file can provide installation instructions, copyright and license information, and links to documentation and other external resources.

Register your plugin with AppConfig.

To use WHM plugins, you must register them with the AppConfig system. AppConfig registration adds plugin icons to the WHM interface automatically. It also configures the plugin's ACL requirements, upgrade script information, and other plugin variables.

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, Inc. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2018 All rights reserved.

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, Inc. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2018 All rights reserved.