Guide to AppConfig - AppConfig Utilities

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.

Note:

We recommend that you do not manually save the AppConfig 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:

/usr/local/cpanel/bin/register_appconfig file

The unregister_appconfig script

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

Note:

This script only removes third-party applications. It cannot remove applications that ship with cPanel & WHM.

To use this script, run the following command:

/usr/local/cpanel/bin/unregister_appconfig app

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 cpanelwhostmgr, or webmail, and appname is the application's internal name:

/usr/local/cpanel/bin/is_registered_with_appconfig service appname

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:

/usr/local/cpanel/bin/update_appconfig_apps

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:

/usr/local/cpanel/bin/show_appconfig

Example output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
---
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 
  • 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....