cPanel Plugin Registration

Posted: January 4, 2014 in cPanel

In cPanel & WHM 11.38.1, the AppConfig system was expanded. You can now use the AppConfig system to register and display WHM Plugins.

Note: By default, registration is required for WHM addons and is strongly recommend for cPanel & Webmail addons.

Note: Registration is only required if the admin has disabled the Allow apps that have not registered with AppConfig to be run when logged in as a reseller to WHM tweak setting (Home >> Server Configuration >> Tweak Settings). This option defaults to on in version 11.38.1.

You must use AppConfig to register your plugin’s urls, entry url, name, and display name.

Example Errors
The following error will display when you installed mod security plugin.

HTTP error 401

WHM is configured to disallow execution of unregistered applications when logged in as root or a reseller with the “all” ACL. To enable this functionality you must do one of the following: Register this addon using /usr/local/cpanel/bin/register_appconfig (AppConfig), Enable the “Allow apps that have not registered with AppConfig to be run when logged in as root or a reseller with the “all” ACL in WHM” option in “Tweak Settings”, or add permit_unregistered_apps_as_root=1 to /var/cpanel/cpanel.config, and run /usr/local/cpanel/etc/init/startcpsrvd
cPanel Plugin Registration
Create folder if it does not exist.

mkdir /var/cpanel/apps
chmod 755 /var/cpanel/apps

Create a configuration (.conf) file for your plugin. For mod security,

vi addon_modsec.conf

# name

# Service that will serve this app

# Physical path: /usr/local/cpanel/3rdparty/Foo.php
# Literal URL path: $server:$port/$cpsession/3rdparty/Foo.php

# System user to run process as

# Required acls

# Display name as show in the service ui
Then register mod security plugin

/usr/local/cpanel/bin/register_appconfig addon_modsec.conf

Thats all…

In order to unregister, use this command

/usr/local/cpanel/bin/unregister_appconfig addon_modsec.conf

/usr/local/cpanel/bin/show_appconfig — This script displays a YAML-formatted list of applications that are registered with AppConfig and their settings.

  1. Reblogged this on and commented:

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s