We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Developer Documentation
Child pages
  • Guide to WHM Plugins - AppConfig Checks
Skip to end of metadata
Go to start of metadata

 

Guide to WHM Plugins 

Plugin Files

Installation Scripts

Interfaces

Access Control Lists

ACL Metadata Perl Module

ACL Object Perl Module

ACL Reference Chart

AppConfig Plugin Registration

Add Plugins

Checks

Configuration File

Uninstall Plugins

 

 

Introduction

The AppConfig system's utilities automate several AppConfig functions. This document describes how to perform the following actions via AppConfig utilities:

You can also perform the following other actions via AppConfig utilities:

Important:

AppConfig utilities also return information about specific applications in cPanel and Webmail. However, you cannot use the AppConfig system to register cPanel plugins. To register cPanel plugins, read our Guide to cPanel Plugins - Add Plugins to Version 11.44 and Later documentation.

Notes:

  • We introduced these scripts in cPanel & WHM version 11.38.1.
  • The system retrieves the majority of this data from each application's AppConfig configuration file.

Check plugin registration

The /usr/local/cpanel/bin/is_registered_with_appconfig script checks whether an application registered with a specific service in AppConfig.

To use this script, run the following command:

/usr/local/cpanel/bin/is_registered_with_appconfig service appname
  • Replace service with the desired cPanel & WHM service:
    • cpanel — Check for specific cPanel applications.
    • whostmgr — Check for WHM plugins.
    • webmail — Check for specific Webmail applications.
  • Replace appname with the desired application's internal name.

For example, to check whether the myplugin plugin exists in WHM, run the following command:

/usr/local/cpanel/bin/is_registered_with_appconfig whostmgr myplugin

The script returns the following output:

  • 1 — The application registered in AppConfig with the specified service.
  • 0 — The application did not register in AppConfig with the specified service.

List registered plugins

The /usr/local/cpanel/bin/show_appconfig script prints a YAML-formatted list of AppConfig applications and their configuration settings.

To use this script, run the following command:

/usr/local/cpanel/bin/show_appconfig

Example output

---
cpanel:
  -
    features:
      - webmail
    name: horde
    phpConfig: horde
    url: /horde/
    user: cpanelhorde
  -
    features:
      - logaholic
    name: logaholic
    url: /3rdparty/Logaholic
    user: cpanellogaholic
webmail:
  -
    features:
      - webmail
    name: roundcube
    phpConfig: roundcube
    url: /3rdparty/roundcube/
    user: cpanelroundcube
whostmgr:
  -
    acls:
      - all
    name: internal_dnsclustering_root
    url:
      - /cgi/adjustclusterdns.cgi
      - /cgi/adjustclusteroptions.cgi
    user: root 


WHM Plugins

About WHM Plugins

  • WHM plugins add custom features to the WHM interface.
  • In WHM 11.38.1+, you must use the AppConfig system to register plugins.

Compatible with:

  • WHM 11.32+

Related Documentation