cPanel Plugins Installation Instructions

Installing a cPanel Plugin is easy. You'll just need to follow a few simple steps after you've got your plugin created and working.

Important: You must run all commands described below as the root user. Otherwise, the commands will execute, but they will not run successfully.

Generating an installation file

To install your cPanel Plugin, you'll need an installation file to provide configuration data for the interface. You can generate one here.

Installing the Plugin

Once you've generated the install file, you'll need to install it.

To do so, follow these steps:

1. Copy the install file to /usr/local/cpanel/bin/ on the server
2. Run /usr/local/cpanel/bin/register_cpanelplugin <full path to install file>

After running the register script, you should see various output. In this output, cPanel is registering your Plugin with the different themes and branding packages on your server. After this script has been run, the Plugin should appear within the cPanel interface on the server.

Uninstalling Plugins

If a Plugin is no longer needed, it can be uninstalled with the following command:

• /usr/local/cpanel/bin/unregister_cpanelplugin <full path to install file>

Rebuilding cPanel's Icon Sprites

If the plugin icon does not show up in the interface, or if you modify the icon, you will need to rebuild cPanel's icon sprites. This can be accomplished through the following command:

• /usr/local/cpanel/bin/rebuild_sprites

Note: The cPanel Plugin Generator is not compatible with transparent images.