Skip to end of metadata
Go to start of metadata

This documentation is for cPanel & WHM version 66.  The "RELEASE" version of our documentation can be found in the Version 64 Documentation space.

(Home >> Software >> EasyApache 4)

Overview

WHM's EasyApache 4 interface (Home >> Software >> EasyApache 4) allows you to update and install Apache, PHP, and other components of your web server.  

Note:

This interface does not display the exact package names. The actual package names on the system start with the ea- prefix.

EasyApache 4 Home interface

When you open the EasyApache 4 interface, the system displays the EasyApache 4 Home interface. The Home interface displays the following sections:

  • Run system update – This link redirects you to the System Update interface (Home >> Software >> System Update) and allows you to update the RPMs on your system. 
  • Currently Installed Packages — This section displays your system's current configuration. Click View all packages to see the packages currently installed on the system, Customize to make changes, or Convert to profile to save the currently installed packages as a profile.
  • Available Profiles — This section displays all of the currently available profiles on your system. 
  • Upload a profile – Click Upload a profile to upload a custom profile. For more information, read our EasyApache 4 - Create a Profile documentation.

Convert to profile

You can convert your system's current configuration with the Convert to profile button. To convert your configuration into a custom profile, perform the following steps:

  1. Click Convert to profile in the Currently Installed Packages section. 
  2. Enter the name of your profile. This is the name that the EasyApache 4 interface will display. 
  3. Enter the file name of your profile. Do not include the .json extension. 
  4. Enter a description for your profile, if desired. The interface will display this description.
  5. Enter any tags that you want to use. 
  6. If you want to overwrite an existing profile of the same name, select the Overwrite an existing profile checkbox.
  7. Click Convert

Your new profile will save to the /etc/cpanel/ea4/profiles/custom directory.

Save as profile

You can save a new profile at any point during the EasyApache 4 configuration process. This allows you to easily configure your profile in the interface, and then save it. To save your configuration as a profile, perform the following steps:

  1. Click Save as profile during the EasyApache 4 configuration process. 
  2. Enter the name of your profile. This is the name that the EasyApache 4 interface will display. 
  3. Enter the file name of your profile. Do not include an extension. 

     

    Note:

    You cannot enter a file name of . or .., or a file name that contains the / or NUL character.

  4. Enter a description for your profile, if desired. The interface will display this description.
  5. Enter any tags that you want to use, separated by commas. 
  6. If you want to overwrite an existing profile of the same name, select the Overwrite an existing profile checkbox.
  7. Click Save

Your new profile will save to the /etc/cpanel/ea4/profiles/custom directory.

Upload a profile

To upload a custom profile, perform the following steps: 

  1. Click Upload a profile.
  2. Click Browse and select the profile that you wish to upload.
  3. If you wish to overwrite an existing custom profile, select the Overwrite an existing profile checkbox. 
  4. Click Upload.
  5. The system will upload your file and refresh the EasyApache 4 interface. 

Note:

 Profile files must be in JSON format. Files that are any other format will not display on the system. For more information, read our EasyApache 4 - Create a Profile documentation.

Install a preconfigured profile

To install a preconfigured profile without any changes, perform the following steps:

  1. Select the profile that you wish to use and click Provision.

  2. The interface displays the Review section. The system compares your current profile and the selected profile and lists the following information:

    • The packages that the system will install.

    • The packages that the system will upgrade.

    • The packages that the system will uninstall.

    • Unaffected packages.

  3. To accept the changes, click Provision

  4. When the provision process completes, click Done

Customize a profile

To install a preconfigured profile with your own customizations, perform the following steps:

Notes:

  • Profiles are templates and do not save your changes. When you provision a customized profile, your changes only affect the Currently Installed Packages only. To create a custom profile, either click Upload a profile and select the profile that you wish to upload or click Save as profile during the customization process. For more information about custom profiles, read our EasyApache 4 - Create a Profile documentation.
  • The EasyApache 4 interface provides a variety of recommendations about the packages that you can select. For more information about the recommendation system, read our EasyApache 4 Recommendations documentation.
  1. Select the profile that you wish to use and click Customize
  2. Select the MPM module that you wish to install. The interface displays any existing conflicts. Click Yes to resolve any conflicts, or No if you do not wish to make the changes. 

    Note:

    • You can only use one Apache MPM module at a time.  
    • To navigate between customization options, click that option's link in the left side of the interface.
  3. Click Next. The available Apache modules will display. 

  4. Select the Apache modules that you wish to install. You can also search for your desired packages. 
  5. Click Next. The available PHP versions will display. 
  6. Select the PHP versions that you wish to install.

    Note:

    Only cPanel & WHM-provided PHP packages display in this interface. If you wish to install an alternate, vendor-provided version of PHP, you must use yum. For more information, read our How to Locate and Install a PHP Version or Extension and Yellowdog Updater, Modified (yum) Basics documentation.

  7. Click Next. The available PHP extensions will display. 
  8. Select the PHP extensions that you wish to install. Select the checkbox for a version of PHP if you wish to filter your results. You can also search for an extension by name.
  9. Click Next. The available Ruby RPMs will display.

  10. Select the Ruby RPMs that you wish to install.

    Note:

    If you enable the mod_passenger module, the system will disable Apache's mod_userdir module.

  11. Click Next. The Review section will appear.
  12. Review your selections to ensure that the changes are acceptable. The Review section displays the following information:
    • The packages that the system will install.

    • The packages that the system will upgrade.

    • The packages that the system will uninstall.

    • Unaffected packages.

  13. To accept the changes, click Provision to start the build process. 
  14. When the provision process completes, click Done

Command line changes

You can perform some changes on the command line with EasyApache 4. To install or uninstall packages manually, you can use yum. For more information, read our Yellowdog Updater, Modified (yum) Basics documentation. 

We also provide some tools to provision profiles in our ea-cpanel-tools RPM.

Additional documentation