cPanel Plugin Registration 11.38+

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.

cpanel plugins registration

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.

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Install Free SSL Let’s Encrypt plugin in cPanel

Let’s Encrypt is a trusted, open source certificate authority that offers free SSL certificates...

Install nginx as a reverse proxy cPanel plugin

Install Nginx on your cPanel/WHM server using the Engintron cPanel Plugin as a reverse proxy. It...

Powered by WHMCompleteSolution