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

Overview

This document describes how to install or uninstall EasyApache 4 on your server. You can migrate your server from EasyApache 3 to EasyApache 4 or install it manually.

You can migrate to EasyApache 4 with one of the following methods:

For more information about the migration process, read our The EasyApache 3 to EasyApache 4 Migration Process documentation.

Important:

  • We deprecated EasyApache 3 on December 31, 2018. To migrate to EasyApache 4, click the EasyApache 4 Migration Tool link at the top of the EasyApache 3 interface (WHM >> Home >> Software >> EasyApache 3). If you do not upgrade to EasyApache 4, you  cannot upgrade to cPanel & WHM version 78.
  • You cannot migrate to or revert from EasyApache 4 on a system that runs cPanel & WHM version 78 or later.
  • You can only migrate a system that runs Tomcat in cPanel & WHM version 76 or above. For more information, read our Tomcat documentation.
  • This section of the interface only exists in cPanel & WHM version 60 or later. In cPanel & WHM version 70 through 76, you must use the EasyApache 4 migration script if you wish to revert.
  • In cPanel & WHM versions 60 through 66, this section of the interface will not appear unless you select either the EDGE or CURRENT tier in WHM's Update Preferences interface (WHM >> Home >> Server Configuration >> Update Preferences). If you wish to migrate from EasyApache 3 to EasyApache 4 and you select either the RELEASE or STABLE tiers, you must use the  /usr/local/cpanel/scripts/migrate_ea3_to_ea4 script.

Requirements

Operating systems

In cPanel & WHM version 56 and later, EasyApache 4 supports all of cPanel & WHM's supported operating systems.

Settings

You must activate the RPMUP setting if you install EasyApache 4 on your system. The system enables this setting by default. To do this, perform one of the following steps:

Apache and PHP

EasyApache 4 only supports Apache version 2.4.

EasyApache 4 supports PHP versions 5.4, 5.5, 5.6, 7.0, 7.1, 7.2, and 7.3.

The cPanel default profile includes PHP versions 7.1 and 7.2.

Important:

  • Each time that you perform a migration from EasyApache 3 to EasyApache 4, the system moves the /usr/local/apache/ directory to the /usr/local/apache.ea3/ directory.
    • If the /usr/local/apache.ea3 directory exists, the system moves the /usr/local/apache/ directory to the /usr/local/apache.ea3.1/directory.
    • If the /usr/local/apache.ea3.1 directory exists when you run a migration, the migration will fail in order to prevent loss of data.
  • The chance of errors dramatically increases if you migrate your system multiple times. If you revert several times, you must manually delete the previous /usr/local/apache.ea3.1/ backup directory to continue. The system automatically preserves the /usr/local/apache/ directory.

Migrate from EasyApache 3 to EasyApache 4

Warning:

EasyApache 3 blocks cPanel & WHM version 78 and higher. You must migrate to EasyApache 4 in cPanel & WHM version 76 or earlier.

To migrate your server from EasyApache 3 to EasyApache 4, perform the following steps:

  1. Navigate to the EasyApache 3 interface (WHM >> Home >> Software >> EasyApache).
  2. Click EasyApache 4 Migration Tool.
  3. Click Migrate. A confirmation message will appear.
  4. To confirm that you wish to migrate, click Yes, run EasyApache 4 Migration. The system will start the EasyApache 4 migration and display the progress log. For more information about the migration process, read our The EasyApache 3 to EasyApache 4 Migration Process documentation.
  5. Click Done.

Notes:

  • If your system runs CloudLinux™ and you experience difficulty with the conversion, you may need to run the CloudLinux conversion script to migrate your system.
  • If your system runs Tomcat, you must use cPanel & WHM version 76 to migrate to EasyApache 4.
  • If your system uses the FCGId Apache module, you must use cPanel & WHM version 76 to migrate to EasyApache 4.
  • If your system uses the FCGId Apache module and your system runs CloudLinux, you must disable the FastCGI option in EasyApache 3 before you start the migration.
  • On systems that do not run CloudLinux, if you receive a message that you must install the Experimental Repository, you must install the repository with the yum install ea4-experimental command, then attempt to migrate the server again.

Servers that run cPanel & WHM versions 52 to 58 must use the EasyApache 4 migration script

Revert to EasyApache 3 from EasyApache 4

Important:

  • You can only uninstall EasyApache 4 if you migrated your system from EasyApache 3.
  • You cannot revert to EasyApache 3 if your system runs cPanel & WHM version 78 or later.
  • This action reverts the system to your previous EasyApache 3 installation and configuration.
  • This action attempts to move the Apache files to a new location and revert the server to the previous state.

To revert your system to EasyApache 3 from EasyApache 4, you must use the EasyApache 4 migration script

To revert your system to EasyApache 3 from EasyApache 4, perform the following steps:

  1. Navigate to the EasyApache 3 interface (WHM >> Home >> Software >> EasyApache 3).
  2. Click Revert. A confirmation message will appear.
  3. To confirm that you wish to revert, click Yes, run EasyApache 4 Revert. The system will start the EasyApache 4 reversion and display the progress log.
  4. Click Done.

To revert your system to EasyApache 3 from EasyApache 4, you must use the EasyApache 4 migration script


Migrate your system on the command line

Use the /usr/local/cpanel/scripts/migrate_ea3_to_ea4 script to install or uninstall EasyApache 4 on the command line.

Migrate to EasyApache 4

  1. Log in to your server via SSH.
  2. Run the following command as the root user:

    /usr/local/cpanel/scripts/migrate_ea3_to_ea4 --run

    Notes:

    • If your system runs CloudLinux™, the migrate_ea3_to_ea4 script downloads and runs CloudLinux's EasyApache 4 migration script.
    • If your system runs CloudLinux, you cannot use options (for example, the --install_profile option) with the EasyApache 4 migration script.
    • If your system runs CloudLinux, you must disable the FastCGI option in EasyApache 3 before you run the migration script.
    • As the migration script runs, the /scripts/migrate_ea3_to_ea4 script copies the /usr/local/lib/php.ini file to the /opt/cpanel/ea-php??/root/etc/php.d/php.ini file and to all installed ea-php versions on your server. To prevent complications, the system comments out lines that resemble the following lines:
      • extension=
      • extension_dir=
      • zend_extension-
    • The system does not adjust any other lines.
    • On systems that do not run CloudLinux, if you receive a message that you must install the Experimental Repository, you must install the repository with the yum install ea4-experimental command, then attempt to migrate the server again.
  3. The interface displays the changes that will occur. To continue, follow the interface's instructions. 

Revert to EasyApache 3

Remember:

You can only uninstall EasyApache 4 if you migrated your system from EasyApache 3.

  1. Log in to your server via SSH.
  2. Run the following command as the root user:

    /usr/local/cpanel/scripts/migrate_ea3_to_ea4 --revert --run
  3. Follow the system's instructions.

Arguments

The migrate_ea3_to_ea4 script accepts the following arguments:

ArgumentDescription
--run

Run the script.

Important:

You must include the --run option.

--helpDisplay the help information.
--revertRevert the system to the previous version and configuration.
--skip_convertDo not convert and install the EasyApache 3 profile. This flag installs the EasyApache 4 cPanel Default Profile unless you use the --install_profile flag.
--install_profile

Do not convert the EasyApache 3 profile. Instead, install the specified profile.

 /scripts/migrate_ea3_to_ea4 --run --install_profile /path/to/profile
--convert_fail

When you convert an EasyApache 3 profile to an EasyApache 4 profile, this flag prevents execution of the script's error-correction code.

Warning:

This may cause a failure when you provision your system. However, you may wish to use this flag for tests.

--allow-unsafe-amount-of-tomcat-users

Migrate a system that possesses more than five Tomcat users.

Notes:

  • This flag only exists on systems that run cPanel & WHM version 76 or higher.
  • Tomcat consumes a high amount of memory. Make certain that your system possesses enough memory before you perform this action.

-y | --y | -yes | --yes

Answer yes to all of the script's yes-or-no questions.
--force

When you add the --force argument to the --run or --revert arguments, the system ignores the protection checks.

Warning:

 This may cause a failure when you provision your system.

--reinstallYum attempts to install the required EasyApache 4 RPMs and attempts to reinstall any currently-installed EasyApache 4 packages.

Install EasyApache 4 on a system without Apache installed

If Apache does not exist on your system and you wish to install EasyApache 4, you can install it manually.

  1. Log in to your server via SSH. 
  2. Run the following commands on the command line as the root user:

    curl https://securedownloads.cpanel.net/EA4/EA4.repo --output /etc/yum.repos.d/EA4.repo
    rpm --install https://securedownloads.cpanel.net/cPanelPublicKey.asc
    yum -y install yum-plugin-universal-hooks ea-cpanel-tools ea-profiles-cpanel
    /usr/local/cpanel/bin/apache_conf_distiller --store-data --reset
    mkdir -p /usr/local/apache/conf
    touch /usr/local/apache/conf/httpd.conf
    mkdir -p /var/cpanel/conf/apache
    touch /var/cpanel/conf/apache/success
    ea_install_profile --install /etc/cpanel/ea4/profiles/cpanel/default.json

    Note:

    If you receive an error when you run the /usr/local/cpanel/bin/apache_conf_distiller --store-data --reset command, ignore it. This error occurs because the httpd binary does not yet exist.

  1. Log in to your server via SSH. 
  2. Run the following commands on the command line as the root user:

    curl https://securedownloads.cpanel.net/EA4/EA4.repo --output /etc/yum.repos.d/EA4.repo
    rpm --install https://securedownloads.cpanel.net/cPanelPublicKey.asc
    yum --enablerepo=epel -y install scl-utils
    perl -pi -e 's/ea4-c\$releasever-/ea4-c6-/' /etc/yum.repos.d/EA4.repo
    yum -y install yum-plugin-universal-hooks ea-cpanel-tools ea-profiles-cpanel
    /usr/local/cpanel/bin/apache_conf_distiller --store-data --reset
    mkdir -p /usr/local/apache/conf
    touch /usr/local/apache/conf/httpd.conf
    mkdir -p /var/cpanel/conf/apache
    touch /var/cpanel/conf/apache/success
    ea_install_profile --install /etc/cpanel/ea4/profiles/cpanel/default.json

    Note:

    If you receive an error when you run the /usr/local/cpanel/bin/apache_conf_distiller --store-data --reset command, you can ignore it. This error occurs because the httpd binary does not yet exist.

  1. Log in to your server via SSH. 
  2. Run the following commands on the command line as the root user, where ## represents your operating system's version:

    wget https://repo.cloudlinux.com/cloudlinux/EA4/cloudlinux-ea4-release-latest-##noarch.rpm
    rpm -Uh cloudlinux-ea4-release-latest-##noarch.rpm
    yum -y install yum-plugin-universal-hooks ea-cpanel-tools ea-profiles-cpanel ea-profiles-cloudlinux
    /usr/local/cpanel/bin/apache_conf_distiller --store-data --reset
    mkdir -p /usr/local/apache/conf
    touch /usr/local/apache/conf/httpd.conf
    mkdir -p /var/cpanel/conf/apache
    touch /var/cpanel/conf/apache/success
    ea_install_profile --install /etc/cpanel/ea4/profiles/cloudlinux/default.json
    

    Note:

    If you receive an error when you run the /usr/local/cpanel/bin/apache_conf_distiller --store-data --reset command, you can ignore it. This error occurs because the httpd binary does not yet exist.


Additional documentation