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

Overview

This document describes the Easy::Apache Help interface, which you can access from within WHM's EasyApache 3 interface (Home >> Software >> EasyApache 3. For general assistance with EasyApache, read the following documentation:

The Easy::Apache Help interface

The Easy::Apache Help interface provides links to our EasyApache documentation, information about your system, and several advanced options for administrators. To access the Easy::Apache Help interface, click the Help link in the Profile stage of WHM's EasyApache 3 interface.

Most of the options in the Easy::Apache Help interface have a corresponding command that you can run via the command line interface (CLI). For an exhaustive list of EasyApache-related flags, run the following command:

/usr/local/cpanel/scripts/easyapache --help


Warning:

cPanel & WHM no longer develops EasyApache 3 and only releases security updates for it. We will deprecate EasyApache 3 on December 31, 2018. After that date, we will no longer update EasyApache 3. In cPanel & WHM version 78, we will remove support for EasyApache 3. For more information, read our cPanel Long-Term Support documentation.

If you do not upgrade to EasyApache 4, you cannot upgrade to cPanel & WHM version 78. 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 new installations of Tomcat.

EasyApache 4 now supports Tomcat 8.5 on an Experimental basis. You must install the Experimental Repository to use Tomcat and create a new Tomcat installation. You cannot migrate from EasyApache 3 to EasyApache 4 if your server runs Tomcat. We will add this functionality in cPanel & WHM version 76. For more information, read our Tomcat documentation.

EasyApache information features

The following features are available via links in WHM's Easy::Apache Help interface:

Link nameDescriptionCommand
Detailed EasyApache documentation can be found here.Click this link to view cPanel's EasyApache documentation.
Report version info of EasyApache, cPanel, and ApacheClick this link to display the version of EasyApache, cPanel, and Apache that your server uses./scripts/easyapache --version
List latest version of Apache, PHP, etc that this installsClick this link to display the most recent versions of Apache and PHP that are available./scripts/easyapache --latest-versions
Show default apache module informationClick this link to display a list of all of the Apache modules that are EasyApache installs in a default build./scripts/easyapache --show-apache-defaults
Cpanel::Easy Framework POD

Click this link to display information on how to write custom modules (opt mods) and where to place their files. Opt mods allow advanced administrators to add their own options within the EasyApache interface. 

Note:

The title of this interface is POD because the information is in the Plain Old Documentation markup language.

For more information about opt mods, read our Custom Modules documentation.

/scripts/easyapache --perldoc
Run only the tarball and system package check with verbose information

Click this link to run a file and package check. The file and package check will not rebuild Apache or PHP. This feature is useful if EasyApache is unable to build Apache due to a package file issue.

EasyApache runs this check each time that you run EasyApache to verify that all of the necessary files and system packages are up-to-date before it builds Apache.

/scripts/easyapache --only-tarballs-and-pkgs

Troubleshooting options

The following options are available in WHM's Easy::Apache Help interface:

Note:

When you select an option, it will only affect the next build. It will not remain in effect for any subsequent builds. Reselect the desired options every time that you run EasyApache.

OptionDescriptionCommand
Do not check to see that the system’s cPanel is the latest availableThis option disables any warnings that appear if your version of cPanel & WHM is not the most recent version./scripts/easyapache --skip-cpanel-version-check
Include detailed debug data in outputThis option displays general debug information in the output while EasyApache builds Apache. This detailed indicates the step at which the build failed./scripts/easyapache --debug
Output debug information about calculating the profile _meta->revision keyThis option adds more detail to the build output. If you experience issues with your EasyApache build, this information may be helpful to send to cPanel support./scripts/easyapache --debug-profile-revision
Do not use raw opts support

If you use raw opts and EasyApache fails to complete, select this option. If the build then completes successfully, reconfigure or omit your raw opts.

For more information on raw opts, read our Raw Opts documentation.

/scripts/easyapache --skip-rawopts
Do not use raw env support

If you customize EasyApache's environmental variables and EasyApache fails to complete, select this option to build Apache without your custom environment variables. If the build completes successfully, reconfigure or omit your environment variables.

For more information on environmental variables, read our Environment Variables documentation.

/scripts/easyapache --skip-rawenv
Do not execute any script hooks

If you use script hooks and EasyApache fails to complete, select this option. If the build completes successfully, reconfigure or omit your script hooks. 
For more information on script hooks, read our Script Hooks documentation. You can also 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 core

If you have opt mods and EasyApache fails to complete, select this option to build Apache without your opt mods. If the build then completes successfully, you will need to reconfigure or omit your option modules.

For more information about opt mods, read our Custom Modules documentation.

For more information about how to write custom opt mods, click the Cpanel::Easy Framework POD link.

/scripts/easyapache --skip-custom-optmods
Output details about Cpanel::SysPkgs callsCpanel::SysPkgs is a Perl module that confirms whether the software packages that are necessary to use your custom modules are present on the server.
Select this option to include the results from SysPkgs in the build output. If EasyApache fails while it builds Apache, this option can provide you with useful information about which custom module does not have a software package that EasyApache depends on.
/scripts/easyapache --output-syspkg-details
Turn on stack trace in cplog messagesThis option causes EasyApache to show the stack of 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 will make the output extremely verbose. However, this information can help you diagnose problems with the Apache build, such as memory leaks.
/scripts/easyapache --perl-devel-profiler