Feb 11, 2015
cPanel Access Level
Root Administrator
I've written a custom plugin and it's working well. The PHP code is in /usr/local/cpanel/base/frontend/paper_lantern/... and I created a tarball with everything in it and when I run the install_plugin script it adds the icon to cPanel as it should.

But I have to manually copy the PHP file into /usr/local/cpanel/base/frontend/paper_lantern/...

Is there not a way to include the PHP code in the tarball and reference it in install.json such that the install_plugin script will copy it to the right location?

According to the SDK docs:

4. For plugins on servers that run cPanel & WHM version 11.42 and earlier, write a plugin installation script.

6. For plugins on servers that run cPanel & WHM version 11.44 and later, use the /usr/local/cpanel/scripts/install_plugin script to install the plugin.
So I'm assuming it shouldn't be necessary to create an install script.

If I want to make this plugin available to others, do they really have to run the install_plugin AND manually copy the scripts?


Staff member
Apr 11, 2011
Hello :)

The install.json/install_plugin scripts only add the item to the UI, and additional actions would require custom code/installation scripts. Internal case number 155073 is open with our documentation for information about to create a distributable cPanel plugin, which seems to be what you are aiming for.

Thank you.