Introduction
AppConfig configuration files store each application's AppConfig settings.
- AppConfig configuration files exist in the
/var/cpanel/apps/directory. - AppConfig files must use the
.conffile extension.
Warning:
Changes to the AppConfig configuration file will not take effect until the /usr/local/cpanel/etc/init/startcpsrvd script restarts cPanel & WHM.
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
|
Key |
Type |
Description |
Possible values |
Example |
|
service |
string |
Required The service in which to serve the application. |
Note: This key can only include one value. If your application is available for multiple services, youmust create a configuration file for each service. |
cpanel |
|
user |
string |
The system account that runs the application. For WHM applications, this value defaults to root. |
|
username |
|
phpHandler |
string |
The 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. Notes:
|
A valid application location. |
http://www.example.com/application.php |
|
upgradecall |
string |
An upgrade script that runs whenever cPanel & WHM upgrades. Note: This key is available in cPanel & WHM version 11.38.1 and later. The system passes two arguments to the script:
For example, the system could use the following command to call this script: /usr/local/Example/bin/upgrade 11.42.0.0 11.46.0.0 |
The absolute path to a script on the server. |
/usr/local/Example/bin/upgrade |
WHM applications
|
Key
|
Type
|
Description
|
Possible values
|
Example
|
| url | string |
Required
The application's location.
|
A valid script location, relative to the/usr/local/cpanel/whostmgr/docroot/directory. | /3rdparty/example.php |
| acls | string |
Required
A list of ACLs.
The authenticated user musthave access to at least one of these ACLs in order to access the application.
Note:
This key is available in cPanel & WHM version 11.38.1 and later.
|
|
any |
| entryurl | string |
The URL to use to enter the application through WHM.
If you use this key, WHM automatically creates a link to the application from the WHM interface.
Note:
This key is available in cPanel & WHM version 11.38.1 and later.
|
The path to the application, relative to the/var/cpanel/apps/ directory. | addons/example/index.cgi |
| displayname | string |
The application's display name in the WHM interface.
Note:
This key is available in cPanel & WHM version 11.38.1 and later.
|
A valid string. | My Application |
| icon | string |
The application's icon's filename.
Note:
This key is available in cPanel & WHM version 11.38.1 and later.
|
A valid WHM icon filename. | example_icon.png |
| target | string |
The targeted browser window in which to open the application link.
Note:
This key is available in cPanel & WHM version 11.42 and later.
|
A valid target attribute. | _blank |
cPanel and Webmail applications
|
Key |
Type |
Description |
Possible values |
Example |
|
url |
string |
Required The application's location. |
A valid script location, relative to the/usr/local/cpanel/base/directory. |
/3rdparty/example.php |
|
features |
string |
Required A list of features. The authenticated user must have access to at least one of these features in order to access the application. Note: This key is available in cPanel & WHM version 11.38.1 and later. |
|
any |
Example
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
# The application's service.service=cpanel # Physical path: /usr/local/cpanel/3rdparty/Example.php# Literal URL path: $server:$port/$cpsession/3rdparty/Example.phpurl=/3rdparty/Example.php # System user to run process asuser=cpaneluser # Directory that contains the php.ini file.# (in the /usr/local/cpanel/3rdparty/ directory)phpHandler=Example # Features requiredfeatures=any |