Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
Guide to WHM Plugins - AppConfig Registration - Developer Documentation - cPanel Documentation
Child pages
  • Guide to WHM Plugins - AppConfig Registration
Skip to end of metadata
Go to start of metadata

 

Introduction

Use AppConfig to register plugins with the WHM interface. AppConfig registration adds plugin icons to the WHM interface automatically. It also configures the plugin's ACL requirements, upgrade script information, and other plugin variables.

Notes:

  • This method is available in cPanel & WHM version 11.32 and later, and is required for cPanel & WHM version 11.38.1 and later. 
  • For more information about AppConfig, read our Guide to WHM Plugins - The AppConfig System documentation.

AppConfig registration

To register your WHM plugin with AppConfig, perform the following steps as the root user:

  1. If it does not already exist, create the /var/cpanel/apps directory.
  2. Run the following command to set the correct directory permissions:

    chmod 755 /var/cpanel/apps
  3. Create an AppConfig configuration file for the plugin.
  4. Run the following command to register the configuration file, where example.conf is the configuration file:

    /usr/local/cpanel/bin/register_appconfig ~/example.conf
  5. Run the following command to confirm that the plugin created its own .conf file in the /var/cpanel/apps/ directory:

    ls -al /var/cpanel/apps

    This command's output should resemble the following example:

    total 12
    drwxr-xr-x  2 root root 4096 Aug  6 22:41 ./
    drwxr-xr-x 83 root root 4096 Aug  7 18:00 ../
    -rw-------  1 root root  259 Aug  6 22:41 example.conf