Page tree
Skip to end of metadata
Go to start of metadata

 

Introduction

AppConfig configuration files store each plugin's or application's AppConfig settings.

Warnings:

  • The system will not apply changes to AppConfig configuration files until the cpsrvd service restarts. For more information, read our How to Restart Services documentation.
  • Configuration files must exist in the /var/cpanel/apps/ directory and must use the .conf file extension.

File contents

When you create an AppConfig file, use the key=value pairs from the tables below.

Note:

The AppConfig configuration file supports comments.

All applications

KeyTypeDescriptionPossible valuesExample
servicestring

Required

The service that will serve the application.

  • cpanel — cPanel.
  • whostmgr — WHM.
  • webmail— Webmail.

Note:

Supply multiple values as a pipe-separated list (for example, cpanel|whostmgr|webmail).

cpanel
userstring

The system account that runs the application.

For WHM applications, this value defaults to root.

  • A valid WHM username on the server.

  • $authuser — In cPanel & WHM version 11.38.1 and higher, use this value to run the application as the authenticated user.
username
phpConfigstringThe directory that contains the application's php.ini file.

A valid directory name, relative to the /usr/local/cpanel/3rdparty/ directory.

Example

url*

string

Additional URLs through which the system can access your application.

Note:

  • We added this key in cPanel & WHM version 11.38.1.
  • Increment the parameter name to specify multiple URLs (for example, url2 and url3 ).

A valid application location.

http://www.example.com/application.php

WHM applications

KeyTypeDescriptionPossible valuesExample
urlstring

Required

The application's location.

A valid location, relative to the  /usr/local/cpanel/whostmgr/docroot/  directory.

Important:

You must prefix the URL with a slash (/), or your WHM plugin will not function.


/cgi/example.cgi
aclsstring

Required

A list of ACLs.

The authenticated user must possess at least one of these ACLs to access the application.

Note:

We added this key in cPanel & WHM version 11.38.1.

  • A comma-separated list of one or more ACLs.
  • any — Allow all authenticated users to use the application.
any
entryurlstring

The URL to access the application through the WHM interface.

  • If you use this key, WHM creates a link to the application from the WHM interface.
  • If you do not use this key, no menu entry for the item will appear. We strongly recommend that you include this key.

Note:

We added this key in cPanel & WHM version 11.38.1.

A valid location, relative to the   /usr/local/cpanel/whostmgr/docroot/   directory.addons/example/index.cgi
displaynamestring

The application's display name in the WHM interface.

Note:

We added this key in cPanel & WHM version 11.38.1.

A valid string.My Application
iconstring

The application's icon's filename.

Note:

We added this key in cPanel & WHM version 11.38.1.

A valid WHM icon filename.

Note:

For more information, read our Guide to WHM Plugins - Plugin Files documentation.

example_icon.png
targetstring

The targeted browser window in which to open the application link.

In cPanel & WHM version 64 and later, this value defaults to _blank.

Note:

We added this key in cPanel & WHM version 11.38.1.

A valid target attribute.

Notes:

  • In cPanel & WHM version 64, specify mainFrame to open in the current browser tab.
  • In cPanel & WHM version 66 and later, specify _self to open in the current browser tab. 
_blank

 

cPanel and Webmail applications

KeyTypeDescriptionPossible valuesExample
urlstring

Required

The URL to access the application through the cPanel or WHM interface.

A valid script location that exists in the /usr/local/cpanel/base/3rdparty/ directory, relative to the /usr/local/cpanel/base/ directory. 

Important:

You must prefix the URL with a slash (/), or your WHM plugin will not function.

3rdparty/example.php
features string

Required

A list of features.

The authenticated user must possess at least one of these features to access the application.

Note:

We added this key in cPanel & WHM version 11.38.1.

  • A comma-separated list of one or more feature names.
  • any — Allow all authenticated users to use the application.
any

Example

# The application's service.
service=cpanel
  
# Physical path: /usr/local/cpanel/3rdparty/Example.php
# Literal URL path: $server:$port/$cpsession/3rdparty/Example.php
url=/3rdparty/Example.php

# System user to run process as
user=cpaneluser
  
# Directory that contains the php.ini file.
# (in the /usr/local/cpanel/3rdparty/ directory)
phpHandler=Example
 
# Features required
features=any