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

For cPanel & WHM version 64

Overview

The EasyApache 4 interface (Home >> Software >> EasyApache 4) provides a variety of recommendations about the packages you can select. These recommendations exist to provide security and configuration information that might affect the packages that you choose to install. 

Current recommendations

We provide recommendations for the following options that we provide with EasyApache 4. 

DSO

PHP DSO runs as the nobody user by default. In a shared hosting environment, this is a security issue.  We strongly recommend that you install either the ea-apache24-mod_ruid2 Apache module or the ea-apache24-mod_mpm_itk Apache module unless you have single-user system. 

For more information about DSO, read our PHP Handlers documentation. 

Recommendation format

The system stores the recommendations that it provides in an RPM inside the ea-cpanel-tools package, which creates directories and files in the /etc/cpanel/ea4/recommendations/ directory. The RPM contains JSON-formatted files for each recommendation, and places each file in a directory with the same name as the corresponding package. The recommendation file will resemble the following example:

  {
   "on" : "add",
   "name" : "PHP DSO",
   "desc" : "PHP DSO runs as the user by default. In a shared hosting environment, this is a security issue.",
   "level" : "danger",
   "url" : "https://www.example.com",
   "options" : [
      {
         "recommended" : true,
         "text" : "We strongly recommend that you install one of the following packages unless this is a single-user system:",
         "level" : "success",
         "items" : [
            "ea-apache24-mod_ruid2",
            "ea-apache24-mod_mpm_itk"
         ]
      },
      {
         "recommended" : false,
         "text" : "If you use suPHP, you will add some security, but may experience performance issues on your server.",
         "level" : "warning"
      }
   ]
}

 

The JSON file contains the following fields:

FieldDescriptionAccepted values
on

Required.

The action that triggers a recommendation.

Note:

You can only use this field in the top level of the JSON file.

  • add
  • remove
desc

The package's description.

Note:

You can only use this field in the top level of the JSON file.

A valid string.
url

A URL that provides more information.

Note:

You can use this field in both the top level of the JSON file and the options hash.

A valid URL.
name

Required.

The package's label.

Note:

You can only use this field in the top level of the JSON file.

A valid string.
options

Required.

The options to resolve a recommendation.

Note:

You can only use this field in the top level of the JSON file.

An array of hashes that contains the level, items, recommended, text, and url fields.
items

An array of information that corresponds with the text field.

Note:

You can only use this field in the options hash.

A valid array.
recommended

The type of recommendation that the interface will return.

Notes:

  • This field determines which icon displays next to the text in the interface. If you do not include this field, then the interface will not display an icon.
  • You can only use this field in the options hash.
  • true
  • false
text

Required.

The text returned in the user interface.

Note:

You can only use this field in the options hash.

A valid string.
level

The level that triggers a recommendation to appear, based on Bootstrap 3 alert components.

Notes:

  • You can use this field in both the top level of the JSON file and the options hash.
  • This field's value only affects the UI if set to the danger level.
  • primary
  • success
  • info
  • warning
  • danger


The system uses the WHM API 1 Functions - ea4_recommendations function to return these recommendations in the EasyApache 4 interface. 

Additional documentation