Knowledgebase

Introduction

The AppConfig system's utilities automate several AppConfig functions. We introduced these scripts in cPanel & WHM version 11.38.1.

The register_appconfig script

The /usr/local/cpanel/bin/register_appconfig script registers applications with AppConfig, and moves the application's configuration file to the /var/cpanel/apps/ directory.

To use this script, run the following command, where file is the absolute path to the application's AppConfig configuration file:

The unregister_appconfig script

The /usr/local/cpanel/bin/unregister_appconfig script unregisters applications with AppConfig and removes the application's configuration file.

To use this script, run the following command:

In this command, replace app with one of the following arguments:

• The absolute path to the application's AppConfig configuration file.
• The application's internal name.

The is_registered_with_appconfig script

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

To use this script, run the following command, where service is cpanel, whostmgr, or webmail, and appname is the application's internal name:

The script returns the following output:

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

The update_appconfig_apps script

The /usr/local/cpanel/bin/update_appconfig_apps script attempts to call the updatecall script for every AppConfig application.

To use this script, run the following command:

The show_appconfig script

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:

Example output