Child pages
  • EasyApache Profile Stage
Skip to end of metadata
Go to start of metadata

(Home >> Software >> EasyApache 3)

Overview

Important:

This document applies to cPanel & WHM versions 11.40 and later. For previous versions of cPanel & WHM, read our EasyApache Profile Stage - 11.38 documentation.

The EasyApache 3 interface provides a set of options and a list of your server's available profiles. EasyApache uses the profile that you select as a template for your EasyApache build.

If your system is compatible with CloudLinux™, you may see CloudLinux promotions. The server administrator can hide this button.

Warning:

Currently, we no longer develop EasyApache 3 and only release security updates. We have tentatively scheduled EasyApache 3 for deprecation at some point in 2018. You will receive at least three months notification prior to official deprecation. After that time, EasyApache 3 will no longer receive any updates. For more information, read our cPanel Long-Term Support documentation.

We strongly recommend that you upgrade to EasyApache 4. For more information, read our EasyApache 4 documentation. 

Featured documentation

  EasyApache 3

IntroductionFAQ

Change Log Release Notes  

ProfilesCustomization

Tomcat

Migrate from Tomcat 5.5 to 7

How to Deploy Java Applications

Important:

EasyApache 3 does not support Tomcat for new installations. EasyApache 4 does not support Tomcat and we do not plan to provide support in the future. 

Options

At the top of the EasyApache 3 interface, you can select the the following options:

OptionDescription
HelpOpen the Easy::Apache Help interface. This interface contains documentation, system information, and advanced options.
Upload ProfileUpload an EasyApache profile that you created. You can upload the profile from a URL or a computer, and then build your Apache configuration.
About ProfilesGeneral information about EasyApache profiles, what they do, and where cPanel & WHM stores them on your server.
Build HistoryA list of your recent Apache builds, which includes the date and time. You can view the details of the build with the Profile option.
Build Log ManagerThe Build Log Manager interface allows you to download, view, and delete logs of prior Apache builds.
Archives/BackupsWe do not currently support this feature.

Available profiles

Note:

The CLI script for EasyApache (/scripts/easyapache) and WHM's EasyApache interface display the same EasyApache profiles.

You can load or customize any of the following types of profiles:

  • An optimal profile that we recommend.
  • Your most recently saved configuration.
  • A profile that you previously saved or uploaded.
  • A minimally configured basic profile.

Three options exist for each profile:

IconLabelDescription
 Show moreSee more detail about each profile.
Customize profile

Edit the profile's configuration.

Note:

If you customize a profile, the Summary section for the profile does not update to reflect your selections.

Download profileDownload a plaintext copy of the EasyApache profile. Use this option to install the same EasyApache profile across multiple servers.

Optimal profiles for CloudLinux

If you install CloudLinux, you can select the following profiles:

Profile nameDescriptionApache versionPHP versionNotable modules
Basic Apache 2.2Only use this profile if you require Apache 2.2. This profile includes the basic modules that you need to run a minimal web server. We recommend that you use this profile if your previous build with Apache 2.2 failed.2.25.6suEXEC
suPHP mod_security
mpm_prefork
Basic Apache 2.4The default profile that cPanel provides. This profile includes the basic modules that you need to run a minimal web server. We recommend that you use this profile if your previous build failed.2.45.6suEXEC 
suPHP 
mod_security
mpm_prefork
MPM ITK

This profile includes the modules from the Basic profile, but replaces MPM Prefork with MPM ITK to further increase the security of your server.

We introduced the MPM ITK option and the MPM ITK profile to servers that use Apache version 2.2 in the following versions:

    • cPanel & WHM version 11.40.1.17
    • cPanel & WHM version 11.42.1.22
    • cPanel & WHM version 11.44.0.24
    • All builds of cPanel & WHM 11.46 or later
2.25.6

mpm-itk
CageFS

mod_security

Note:

All profiles that we provide for CloudLinux are compatible with CageFS.

Optimal profiles for other operating systems

You can use the following profiles in EasyApache for operating systems other than CloudLinux:

Profile nameDescriptionApache versionPHP versionNotable modules
Basic Apache 2.4

The default profile that cPanel provides. This profile includes the basic modules that you need to run a minimal web server. We recommend that you use this profile if your previous build failed.


2.45.6suEXEC 
suPHP 
mod_security 
mpm_prefork
Basic Apache 2.2

Only use this profile if you require Apache 2.2. This profile includes the basic modules that you need to run a minimal web server. We recommend that you use this profile if your previous build with Apache 2.2 failed.

2.25.6suEXEC  
suPHP  
mod_security   mpm_prefork
Mod Ruid2

This profile includes the modules from the Basic profile. This configuration utilizes Mod Ruid2 to improve the security of your server. We recommend that you select this profile if you use the CGI, DSO, or suPHP PHP handler.

Note:

You can only use this profile if your current build contains Apache 2.2. 

2.25.6mod_ruid2 
mod_security 
mpm_prefork
MPM ITK

This profile includes the modules from the Basic profile but replaces MPM Prefork with MPM ITK to further increase security for your server. MPM ITK creates a more secure environment than Mod Ruid2, but uses more resources.

We introduced the MPM ITK option and the MPM ITK profile to servers that use Apache version 2.2 in the following versions:

    • cPanel & WHM version 11.40.1.16
    • cPanel & WHM version 11.42.1.19
    • cPanel & WHM version 11.44.0.8
    • All cPanel & WHM builds of 11.46 or later
2.25.6

mpm-itk 
CageFS
mod_security

How to select an EasyApache profile and initiate the build process

To build a profile on your server, perform the following steps:

  1. Identify the profile that you wish to build from the list of available profiles.
  2. Select the profile that you wish to build.
  3. Click Build Profile to initiate the build process.

The EasyApache build process

When you initiate the EasyApache build process, EasyApache verifies the new configuration and then applies it to your server. To complete the process, perform the following steps:

  1. To initiate the build process, click Build Profile. If you customized a profile, click Save and Build.
  2. Click OK to confirm that you want to build and install the selected Apache profile.
  3. Read the warning in the window that appears and click I Understand.

    Notes:

    • The build process takes a few minutes.
    • You can use the options at the top of the interface at any point during the build process.
  4. EasyApache displays a new interface with information about the profile.
    • Click Show More Build Details to enlarge the window that details the build process.
    • Click Disable Auto Scroll to prevent the text box from automatically scrolling with the build information.

      Note:

      You cannot reenable the Auto Scroll feature after you select this option.

  5. When the build completes, a prompt to configure suEXEC and PHP appears.
  6. Click Save New Configuration to display the new PHP and suEXEC configuration.
  7. Close the Configure Suexec and PHP window.
    • You can edit the PHP and suEXEC configuration on your server at any time with WHM's Configure PHP and suEXEC interface (Home >> Apache Configuration >> PHP and SuExec Configuration).
  8. When the build process completes, click Download Log if you want to download a detailed, plain-text log.

The EasyApache Help Screen

The Easy::Apache Help interface provides links to in-depth EasyApache documentation, information about your system, and several advanced options for administrators.

Most of the options on the Easy::Apache Help interface correspond to a CLI command. For an exhaustive list of EasyApache-related flags, use the /usr/local/cpanel/scripts/easyapache --help command.

 

EasyApache information features

FeatureDescriptionCommand
Detailed EasyApache documentation can be found here.This link displays cPanel's EasyApache documentation.
Report version info of ea3, cpanel, and apacheThis link displays the versions of EasyApache, cPanel & WHM, and Apache currently installed on your server. Use this information to decide whether you need to run EasyApache to update your software./scripts/easyapache --version
List latest version of Apache, PHP, etc that this installsThis link displays the most recently available versions of Apache and PHP. Compare them to the versions currently on your server to determine whether you need to run EasyApache to update your software./scripts/easyapache --latest-version
Show default apache module informationThis link displays a list of all Apache modules the default EasyApache build installs. Use this information to decide whether the default configuration meets your requirements or if you need to customize your Apache configuration./scripts/easyapache --show-apache-defaults
Cpanel::Easy Framework POD

This link displays information about how to structure and where to place option modules. Option modules allow advanced administrators to place their own options within the EasyApache interface. 

/scripts/easyapache --perldoc command.
Run only the tarball and system package check with verbose informationWHM checks whether all of the necessary compressed files (tarballs) and system packages are up-to-date before it builds Apache. This link performs the file and package check, but does not build Apache. This feature helps administrators who have trouble with their Apache builds identify problem files./scripts/easyapache --only-tarballs-and-pkgs

Troubleshooting options

Use the Help feature in EasyApache to access the following options.

Note:

When you select an option, it only affects the next build. Selections do not remain in effect for any subsequent builds. You must select the desired options each time that you run EasyApache.

OptionDescriptionCommand
Do not check to see that the system’s cPanel is the latest availableDisable any warnings that appear if you do not have the most current version of cPanel & WHM./scripts/easyapache --skip-cpanel-version-check
Include detailed debug data in outputDisplay general debug information in the output while EasyApache builds Apache. Use this detailed output to determine at which step the build failed./scripts/easyapache --debug
Output debug information about calculating the profile _meta->revision keyThis option adds more detail to the build output. Send this information to cPanel support to identify any problems with the build profile./scripts/easyapache --debug-profile-revision
Do not use raw opts supportAdvanced administrators can add raw opts (also known as custom configure flags) to a specific file on the server to customize the configuration of Apache, ModSecurity, or PHP. 
If EasyApache fails to complete, select this option. If the build completes successfully, then you must reconfigure or omit your raw opts.
/scripts/easyapache --skip-rawopts
Do not use raw env supportAdvanced administrators can place environment variables (raw env) values within custom-created files on the server to change the behavior of Apache and PHP. 
If EasyApache fails to complete, select this option to build Apache without your custom environment variables. If the build then completes successfully, you must reconfigure or omit your environment variables.
/scripts/easyapache --skip-rawenv
Do not execute any script hooks

Advanced administrators can use script hooks to trigger scripts that customize the Apache configuration process. These scripts can execute at various points during the Apache build process.
If EasyApache fails to complete, select this option. If the build then completes successfully, you must reconfigure or omit your script hooks. 

Note:

To learn more about script hooks, read the Script Hooks documentation or run one of the following commands: 

  • /scripts/easyapache --help=hooks
  • /scripts/easyapache --help=hooks-advanced 
/scripts/easyapache --skip-hooks
Do not build any opt mods that are not included in ea3 coreAdvanced administrators can add option modules (or opt mods) to the EasyApache interface. For more information about opt mods, click Cpanel::Easy Framework POD in the interface.
If EasyApache fails to complete, select this option to build Apache without your opt mods. If the build completes successfully, you must reconfigure or omit your option modules.
/scripts/easyapache --skip-custom-optmods
Output details about Cpanel::SysPkgs callsThe Cpanel::SysPkgs Perl module confirms whether the necessary software packages for your custom modules exist on the server.
The results from Cpanel::SysPkgs module in the build output. If EasyApache experiences trouble when it builds Apache, this option provides you with useful information about which custom module's software dependencies do not exist on the server.
/scripts/easyapache --output-syspkg-details
Turn on stack trace in cplog messagesThis option causes EasyApache to show the stack, or commands, that lead to an error during the Apache build.
This option provides the entire context of the error and a link to a cPanel web page with helpful information about the error.
/scripts/easyapache --stack
Include process profile data in outputProfile data includes the amount of memory that each process uses and the unique ID (UID) number that the system assigns to each process.
If you select this option, EasyApache adds profile data to the build output, which makes the output extremely verbose. This information can help diagnose problems with the Apache build.
/scripts/easyapache --perl-devel-profiler