EasyApache 4 Interface

Valid for versions 102 through the latest version

Version:

102


Last modified: January 26, 2024

Overview

This interface 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.
  • Only root or resellers with root-level privileges can access the EasyApache 4 interface.

EasyApache 4 Home interface

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

  • Run system update — This link redirects you to the System Update interface (WHM » 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 currently installed packages, 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

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. The EasyApache 4 interface displays this name.
    Note:

    To overwrite an existing profile of the same name, select the Overwrite an existing profile checkbox.

  3. Enter the file name of your profile. Do not include the .json extension.
  4. Optionally, enter a description for your profile. The interface will display this description.
  5. Optionally, enter a comma-separated list of tags.
  6. Click Convert. The system saves the new profile 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. To save you 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. The EasyApache 4 interface displays this name.
    Note:

    To overwrite an existing profile of the same name, select the Overwrite an existing profile checkbox.

  3. Enter the file name of your profile. Do not include a .json extension.
    Note:

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

  4. Enter a description for your profile, if desired.
  5. Click Save.

The system saves the new profile to the /etc/cpanel/ea4/profiles/custom directory.

Upload a profile

Note:

Profile files must use a JSON format. The system will not display files in any other format. For more information, read our EasyApache 4 - Create a Profile documentation.

From a local file

To upload a custom profile from a local file, perform the following steps:

  1. Click Upload a profile.
  2. Click Browse and select the profile that you wish to upload.
    Note:

    To overwrite an existing profile of the same name, select the Overwrite an existing profile checkbox.

  3. Click Upload. The system will upload your file and refresh the EasyApache 4 interface.

From a URL

To upload a file from a URL, perform the following steps:

  1. Click Retrieve from URL.
  2. Enter the URL that you wish to upload in the text box.
  3. Select the checkbox to fetch the URL’s contents.
  4. Click Upload.

The system will upload your file and refresh the EasyApache 4 interface.

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 to 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

Notes:
  • Profiles act as templates and do not save your changes. When you provision a customized profile, your changes 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, read our EasyApache 4 Recommendations documentation.
  • On systems that run Ubuntu®, the package names use a hyphen (-) rather than an underscore (_).

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

  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.
    Notes:
    • 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 appear.
  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 appear.
  6. Select the PHP versions that you wish to install. You can also search for your desired packages.
    Note:

    This interface only installs cPanel & WHM-provided PHP packages. If you wish to install an alternate, vendor-provided version of PHP, you must use a package manager. For more information, read our How to Locate and Install a PHP Version or Extension and Package Manager Basics documentation.

  7. If you select a new version of PHP, the system will detect the PHP extensions that already exist for other installed versions of PHP. You can select the following options:
    Notes:
    • In the following examples, php ## represents the PHP version that you selected.
    • If you do not select one of the following options, the system only installs the selected PHP version and its required extensions.
    • PHP ## and Extensions — This option installs the selected PHP version and all detected extensions.
    • PHP ## only — This option only installs the PHP version and its required extensions.
    • Edit — This option displays the proposed PHP extensions. You can deselect any extensions that you do not wish to install.
  8. Click Next. The available PHP extensions will appear.
  9. 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.
  10. Click Next. The available Ruby packages will appear.
  11. Select the Ruby packages that you wish to install.
    Note:
    • This section only displays Ruby packages if any exist. This section does not exist on Ubuntu systems. You must use Passenger instead. To install Passenger on a system that runs Ubuntu, install the mod-passenger package in the Apache Modules section. For more information about Passenger for Ubuntu, read our Using Passenger Applications documentation.
    • If you enable Passenger, the system will disable Apache’s UserDir module.
  12. Click Next. The available additional packages will appear.
  13. Select the additional packages that you wish to install.
    Note:

    This section only displays additional packages if any exist.

  14. Click Next. The Review section will appear.
  15. Review your selections to confirm the changes. 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.
  16. To accept the changes, click Provision to start the build process.
  17. 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 a package manager. For more information, read our Package Manager Basics documentation.

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

Additional Documentation