Profile

This section of the interface allows you to select the profile WHM will use as a template for building an EasyApache profile. You may choose a pre-existing profile, or compile and use a custom profile, using a pre-existing profile as a template.

Introduction

This section of the interface allows you to select the profile WHM will use as a template for building an Easy Apache profile. You may choose a pre-existing profile, or compile and use a custom profile, using a pre-existing profile as a template.

In addition, several options are available to help you configure Apache to fit your needs. They are:

• Help — This option provides a link to the in-depth EasyApache documentation, which includes technical details to help you decide which versions of PHP and Apache to use, plus additional information. The Help screen also offers a number of additional options that are useful for advanced administrators; for more information, see our Help documentation.
• Upload Profile — This option lets you upload a profile you have already created and use it to build your Apache configuration. You can upload the profile from a URL or from your computer.
• About Profiles — This option opens a small pop-up that contains general information about EasyApache profiles, including what they do and where they reside.
• Build Log Manager — This option lets you download, view, and delete logs of prior Apache builds.
• Archives/Backups — This option is not yet available in the WHM interface, but may be accessed from the command line using the following command: /usr/local/cpanel/scripts/easyapache --restore-archive

The yellow Welcome to Easy::Apache box contains several links to more detailed EA3 documentation, as well as a link to a Quick Reference guide that answers a couple of common questions about customizing Apache.

Build an existing profile

When a profile is “built,” it is installed and used on the server.

To build an existing Apache profile:

1. Select the profile you wish to build.
   • By clicking More Info, you are able to view information about the profile and access 4 options. They are:
     • Click here to view details — Opens a small pop-up that displays the Apache and PHP versions and features active in the corresponding profile. To view the Apache documentation for any of the listed features, you can click its More Info link.
     • Raw — Opens a small pop-up that displays the profile in plain text.
     • Download profile — Downloads a copy of the EA3 profile in plain text. This is useful if you would like to install the same EA3 files across a number of servers without configuring each one individually.
     • About Profiles — Opens a small pop-up that contains general information about EA3 profiles, including what they do and where they reside.
2. Click Build Profile Now.
3. Confirm that you would like to build and install the selected Apache profile by clicking Yes.
4. Read the warning and click I Understand.
   • The build process will take a few minutes; please be patient.
   • At any point during the build process, you may use the 4 links at the top of the page. These links are:
     • Profile details — Opens a small pop-up that displays the Apache and PHP versions and features active in the profile you are building. To view the Apache documentation for any of the listed features, you can click its More Info link.
     • Raw profile — Opens a small pop-up that displays the profile you are building in plain text.
     • Download profile — Downloads a copy of the EA3 profile in plain text. This is useful if you would like to install the same EA3 files across a number of servers without configuring each one individually.
     • About Profiles — Opens a small pop-up that contains general information about EA3 profiles, including what they do and where they reside.
5. WHM will display a new screen with information about the EA3 profile that is being built.
   • Click Show More Build Details to enlarge the window detailing the build process.
   • Click Disable Auto Scroll to prevent the text box from automatically scrolling along with the build information.
     • Note: This option cannot be undone once it is checked.
6. WHM will now let you configure suEXEC and PHP. For details regarding these options, please refer to the PHP and SuExec Configuration documentation.
7. Click Save New Configuration.
   • WHM will display the new PHP and suEXEC configuration. You may close the Configure Suexec and PHP window.
   • To edit the PHP and suEXEC configuration at any point, access the PHP and SuExec Configuration option from WHM’s Apache Configuration screen.

Once the build is complete, you may click Download Log to download a detailed, plain text log of the build process.

Create a custom profile

You can create a custom profile using one of the existing Apache configurations as a template.

To do this:

1. From the list, select the Apache configuration you would like to edit.
   • By clicking More Info, you are able to view information about the profile and access 4 options. They are:
     • Click here to view details — Opens a small pop-up that displays the Apache and PHP versions and features active in the corresponding profile. To view the Apache documentation for any of the listed features, you can click its More Infolink.
     • Raw — Opens a small pop-up that displays the profile in plain text.
     • Download profile — Downloads a copy of the EA3 profile in plain text. This is useful if you would like to install the same EA3 files across a number of servers without configuring each one individually.
     • About Profiles — Opens a small pop-up that contains general information about EA3 profiles, including what they do and where they reside.
2. Click Start customizing based on profile.
   • You will be taken to step 2: the Apache Version screen.

Note: You may delete a profile by clicking Delete next to the profile you wish to delete. You may not delete the default profiles that were created when you installed WHM and cPanel.

The EasyApache Help Screen

This screen, visible when you click the Help link from the EasyApache Profile screen, provides links to the in-depth EasyApache (EA3) documentation, information about your system, and several advanced options for administrators.

Most of the options on this page have a corresponding command which you can type into the CLI, if you prefer to activate the feature from the command line. For an exhaustive list of EA3-related flags you can use, type the following from the command line:

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

Note: When you select a checkbox option, your selection will only affect the very next build — it will not remain in effect for any subsequent builds. You will need to reselect the desired options every time you run EA3.

Detailed EasyApache documentation can be found here.

This link allows you to access the in-depth EasyApache documentation.

Report version info of ea3, cpanel, and apache

Clicking this link causes a screen to appear displaying the versions of EasyApache, cPanel, and Apache that are currently running on your server. Reviewing these and comparing them to the latest available versions (in the link below) can help you decide whether your software is up-to-date or you need to run EasyApache.

To view this information from the command line, type:

/usr/local/cpanel/scripts/easyapache --version

List latest version of Apache, PHP, etc that this installs

When you click this link, WHM displays the most recent versions of Apache and PHP that are available to install on your server. Reviewing these and comparing them to the versions currently running on your server (in the link above) will help you decide whether your software is up-to-date or you need to run EA3.

To view this information from the command line, type:

/usr/local/cpanel/scripts/easyapache --latest-version

Show default apache module information

This link displays a list of all the Apache modules installed in a default EA3 build. This is useful for determining whether the default configuration will meet your needs, or whether you need to customize your Apache configuration.

To view this information from the command line, type:

/usr/local/cpanel/scripts/easyapache --show-apache-defaults

Cpanel::Easy Framework POD

Advanced administrators can place their own options into the EA3 interface. This is done by creating a file called an “option module” (“opt mod”). Click this link to view a screen containing information about how to structure the module and where it must reside on your server in order to work.

This screen is titled “POD” because it is written in the Plain Old Documentation markup language.

To view this information from the command line, type:

/usr/local/cpanel/scripts/easyapache --perldoc

Run only the tarball and system package check with verbose information

Normally, WHM performs a check before building Apache, to ensure that all necessary compressed files (“tarballs”) and pieces of software known as system packages are up-to-date. Clicking this link will cause WHM to perform the check without building Apache.

This feature can be useful for administrators having problems building Apache, as the output displayed by WHM can help you pinpoint problem files.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --only-tarballs-and-pkgs

Do not check to see that the system’s cPanel is the latest available

If your version of cPanel is not the latest available, EasyApache normally displays a warning on the Profile screen. Selecting this option will disable the warning.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --skip-cpanel-version-check

Include detailed debug data in output

When you select this option, WHM includes general debug information in the output it generates when performing the build.

This can be a useful troubleshooting tool. If your configuration of EA3 is having trouble building Apache properly, this detailed output will tell you at which step the build failed.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --debug

Output debug information about calculating the profile _meta->revision key

Clicking this checkbox will include detailed information in the build output about the profile you are attempting to build.

This is useful for troubleshooting, as submitting this information to cPanel support can help us pinpoint any problems with the build profile.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --debug-profile-revision

Use test branch

Selecting this option is not recommended. The test branch is generally unstable and could damage your system. This option is included for internal cPanel testing purposes only.

If the option Use public branch is displayed instead, you are currently running the test branch. In this case, we recommend that you click the checkbox to use the public branch.

Warning: The test branch is generally unstable and could damage your system.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --test-branch

To switch from the test branch to the more stable public branch, type the following from the command line:

/usr/local/cpanel/scripts/easyapache --test-branch=0

Do not use raw opts support

Raw opts (also known as “custom configure flags”) are lines of data that advanced users can add to a specific file on the server in order to customize the configuration of Apache or PHP. For more information on configuring raw opts and which files can be used for raw opts, read this document.

Enabling this option is useful for troubleshooting purposes. If EasyApache is having trouble successfully building Apache, click the checkbox to attempt to build Apache without supporting your custom raw opts. If the build completes successfully, the raw opts need to be reconfigured or omitted.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --skip-rawopts

Do not use raw env support

Environment variables are values that advanced administrators place within custom-created files on the server to change the behavior of Apache and PHP. (There is more information available on configuring environment variables.)

Enabling this option is useful for troubleshooting purposes. If EasyApache is having trouble successfully building Apache, click the checkbox to attempt to build Apache without supporting your custom environment variables. If the build completes successfully, the variables need to be reconfigured or omitted.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --skip-rawenv

Do not execute any hook scripts

Hook scripts are created by advanced administrators who wish to customize the configuration of Apache. These scripts can be executed at various points in the Apache build process.

Enabling this option is useful for troubleshooting purposes. If EA3 is having trouble successfully building Apache, click the checkbox to attempt to build Apache without your custom hook scripts. If the build completes successfully, the scripts need to be reconfigured or omitted.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --skip-hooks

To learn more about hook scripts, type one of the following commands from the command line interface:

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

/usr/local/cpanel/scripts/easyapache --help=hooks-advanced

Do not build any opt mods that are not included in ea3 core

Option modules (or “opt mods”) are options that advanced administrators can add to the EA3 interface. (For more information about configuring opt mods, click Cpanel::Easy Framework POD above.)

Enabling this option is useful for troubleshooting purposes. If EA3 is having trouble successfully building Apache, click the checkbox to attempt to build Apache without any custom opt mods. If the build completes successfully, your custom opt mods need to be reconfigured or omitted.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --skip-custom-optmods

Output details about Cpanel::SysPkgs calls

Cpanel::SysPkgs is a Perl module that checks to make sure that the software packages necessary for your custom modules to operate are present on the server.

Click the checkbox to include details in the build output about SysPkgs’ findings when it is activated during the build. If EA3 is having trouble building Apache, enabling this option can provide you with useful information about which command caused the build to fail.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --output-syspkg-details

Turn on stack trace in cplog messages

Enabling this option will cause WHM to show the history, or “stack,” of commands leading to an error.

This option is useful for troubleshooting, since it provides the entire context of the error, along with a URL linking you to a cPanel web page with helpful information about the error.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --stack

Include process profile data in output

Profile data includes a unique ID number that the system assigns to each process, along with the amount of memory used by each process.

Clicking this checkbox adds the profile data to the build output, making the output extremely verbose. However, this information can be helpful in diagnosing problems with the Apache build. This option can be particularly helpful in locating a memory leak associated with a particular process.

To access this option from the command line, type:

/usr/local/cpanel/scripts/easyapache --perl-devel-profiler