add an entry/application into the cpanel users main page


Jun 14, 2013
cPanel Access Level
Root Administrator

I want to add an help "application" into the main page of cpanel users, in the "preferences" category.
I was wondering how to do that. I use latest version of cpanel (WHM 11.38.0 (build 16))

As far as I understood, I need to:
- create a cPAddon
- enable it in the feature manager
- and insert it somewhere in the theme

1/ create a cPAddon, directly on the server

To create a cPAddon, I tried to follow the documentation, i.e.
- I created this hierarchy under /usr/local/cpanel/cpaddons:
* cPAddonsAvailable/
* cPAddonsMD5/
* MyCompany/Support/
* MyCompany/Support/mycompanySupport/1.0.tar.gz
* MyCompany/Support/mycompanySupport/upgrade/
- I added an entry in
our %vend = (
'MyCompany::Support::mycompanySupport' => { 'version' => 0, 'VERSION' => 0 },

- when done, I see an new entry in "Install cPAddons Site Software", but it is written MyCompany::Support::mycompanySupport", and not the description I put into MyCompany/Support/

If I click on "Update Vendor", I get an error:
Warning: Vendor List failed to be included: Can't locate cPAddonsAvailable/MyCompany/Support/ in @INC (@INC contains: /usr/local/cpanel /usr/local/cpanel/whostmgr/docroot/cgi /usr/local/cpanel/cpaddons /usr/local/cpanel /usr/local/cpanel/3rdparty/perl/514/lib64/perl5/cpanel_lib/x86_64-linux-64int /usr/local/cpanel/3rdparty/perl/514/lib64/perl5/cpanel_lib /usr/local/cpanel/3rdparty/perl/514/lib64/perl5/5.14.3/x86_64-linux-64int /usr/local/cpanel/3rdparty/perl/514/lib64/perl5/5.14.3 /opt/cpanel/perl5/514/site_lib/x86_64-linux-64int /opt/cpanel/perl5/514/site_lib .) at (eval 51) line 1. BEGIN failed--compilation aborted at (eval 51) line 1.
Contact MyCompany::Support::mycompanySupport for support.

If I copy /usr/local/cpanel/cpaddons/MyCompany directory into /usr/local/cpanel/cpaddons/cPAddonAvailable, it works better, but it is not what is written in the documentation

2/ enable it

even after that, I want to make it appears in the user cpanel preferences pane, so I expect to enable it in in the "Feature Manager", but I don't see it. And I guess here it is not the correct way.

So what did I missed?
Thanks in advance

Nicolas Zin


Staff member
Apr 11, 2011
Hello :)

The cPAddons system allows a script to be packaged up so that it can be installed on a user's website, upgraded, uninstalled and otherwise managed from cPanel and WebHost Manager. I believe you are actually seeking to develop a cPanel plugin. Plugins are documented at:

Installing a cPanel Plugin

Thank you.