Guide to AppConfig


The AppConfig system configures cPanel & WHM attributes and registers WHM plugins. Use AppConfig to register WHM plugins or to specify application attributes in cPanel, WHM, or Webmail.

Create AppConfig configuration files to specify each application's configuration settings.


  • cPanel & WHM version 11.32 introduced the AppConfig system.
  • In cPanel & WHM version 11.38.1 and later, plugin developers must use AppConfig to register and display WHM plugins. For more information about AppConfig plugin registration, read our AppConfig Registration documentation. 

Update AppConfig files for 11.38.1+

The upgrades to the AppConfig system in cPanel & WHM version 11.38.1 require the following changes to AppConfig configuration files:

  • cPanel and Webmail applications — Add the features key to the AppConfig file.
  • WHM applications — Add the acls key to the AppConfig file.

Optional WHM application updates

To take advantage of the upgrades to the AppConfig system in cPanel & WHM version 11.38.1, perform the following steps:

  1. Create an upgrade script.
    • Use the version arguments that the system passes to upgrade scripts to run the script as soon as the server reaches cPanel & WHM version 11.38.1 or higher.
    • Ensure that the script moves your application to its own subdirectory in the  /usr/local/cpanel/whostmgr/docroot/ directory. For example, move the /cgi/addon_securityadvisor.cgi file to the /cgi/addons/securityadvisor/index.cgifile. 
  2. Create a new AppConfig configuration file. Set the upgrade script as the upgradecall key's value.

Test application

A test application for cPanel & WHM version 11.38.1 is available on Github:

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....