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

Overview

Custom Apache and PHP modules, also known as "Opt Mods" and "optmods", add features to the EasyApache system. You can access these modules from the command line and the WHM interface. EasyApache will compile these custom modules, as well the other modules you select, into PHP and Apache.

Important:

EasyApache 4 (EA4) does not use optmods. For information on custom modules, visit cPanel's EasyApache4 Package Builder site.

Before you begin

You can find documentation about custom modules for your server in the following locations:

  • WHM — Navigate to the cPanel::Easy Framework POD documentation in EasyApache 3's Help interface (Home >> Software >> EasyApache 3 >> Help).
  • Command Line — /usr/local/cpanel/scripts/easyapache --perldoc

    Notes:

    • If you experience problems when you build Apache with custom modules, run the /usr/local/cpanel/scripts/easyapache --skip-custom-optmods command. This command causes EasyApache to build Apache and PHP without any custom modules. If Apache and PHP successfully build without the custom modules, then you must correct or omit the custom modules.  
    • This command is also available in the EasyApache Help section of the WHM interface.

Warning:

Currently, EasyApache 3 is no longer in development and only receives security updates. EasyApache 3 is tentatively scheduled 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. 

Install a custom module

To install a custom module, perform the following steps on the command line as the root user:

  1. Download the custom module archive file to your computer.
  2. With your preferred file transfer method, upload the custom module's archive file to your server's /var/cpanel/easy/apache/custom_opt_mods/ directory.

  3. Decompress and unarchive the file with the following command, where $NAME.tar.gz represents the name of the optmod's archive file:

    tar -C /var/cpanel/easy/apache/custom_opt_mods -xvf $NAME.tar.gz

    Important:

    To enable a custom module, you must select the module in the Exhaustive Options List section of the EasyApache 3 interface (Home >> Software >> EasyApache 3).

Remove a custom module

To remove a custom module from the server, delete the files associated with that custom module. This action will remove the custom module from all future builds and the EasyApache interface.

Available modules

Warning:

cPanel does not provide support for custom modules.

ModuleDescriptionCustom module filenameLinks
mod_frontpage

This custom module enables FrontPage™ extensions.

Warnings:

  • We strongly recommend that you do not install FrontPage. Microsoft® discontinued support for FrontPage extensions on Linux servers in 2006.
  • We recommend that you publish content with a different method, such as FTP or WebDAV.
  • Exercise caution if you install FrontPage extensions, as they have been known to cause security issues.
  • FrontPage is only compatible with Apache version 2.2.
  • FrontPage is not compatible with mod_ruid2. If you enable mod_ruid2, you must remove mod_frontpage.
  • mod_frontpage is not compatible with the MPM ITK. If you enable the MPM ITK, you must remove mod_frontpage.
custom_opt_mod-frontpage-20140912.tar.gzDownload
mod_geoIPThis module searches for the IP address of the client web user in the GeoIP database.custom_opt_mod-mod_geoip.tar.gz

Download

Information

mod_wsgiThis module embeds the Python interpreter into Apache for faster Python applications. Information
GD with JIS-mapped Japanese font supportThis module provides JIS-mapped Japanese font support for the GD library under PHP5. custom_opt_mod-php5-gd_jis_mapped_japanese_font_support.tar.gz Download
Turkish locale patch for PHP5This module improves PHP5 support for the Turkish locale.custom_opt_mod-php5-turkish_locale_patch.tar.gzDownload
PHP5.2

This custom module allows you to use PHP version 5.2. You may use this module with mod_ruid2 and Apache version 2.2.

Warnings:

  • We strongly recommend that you do not install PHP 5.2. Installation of this module is at your own risk with no support provided. PHP 5.2 reached end of life on January 6, 2011.
  • You should only use this module to upgrade to a more recent version of PHP.
  • This module is not compatible with FCGI.
  • Select only one of the PHP 5.2 modules. If you extract both modules, the last one you extract will overwrite the other.
  • If you use this module, EasyApache will ignore the PHP options you select from the Exhaustive Options List stage of the EasyApache interface.
custom_opt_mod-PHP5217update.tar.gz Download
PHP5.2 with FCGI

This custom module includes PHP version 5.2 and FCGI. You may use this module with Apache version 2.2.

Warnings:

  • We strongly recommend that you do not install PHP 5.2. Installation of this module is at your own risk with no support provided. PHP 5.2 reached end of life on January 6, 2011.
  • You should only use this module to upgrade to a more recent version of PHP.
  • This module is not compatible with mod_ruid2 .
  • Select only one of the PHP 5.2 modules. If you extract both modules, the last one that you extract will overwrite the other.
  • If you use this module, EasyApache will ignore the PHP options you select from the Exhaustive Options List stage of the EasyApache interface.
custom_opt_mod-PHP5217update-fastcgi.tar.gz Download
suPHP PAM patchThis module allows you to use limits (/etc/security*.conf) with suPHP.custom_opt_mod-suphp_pam_patch.tar.gz

Download

Information

mod_reqtimeoutThis module allows you to mitigate Slowloris attacks.custom_opt_mod-reqtimeout.tgz

Download

Information

mod_remoteipThis module replaces the original client IP address with the useragent IP address that is configured with the RemoteIPHeader directive.custom_opt_mod-remoteip.tgz

Download

Information

mod_pagespeed

This module allows you to install the mod_pagespeed module via EasyApache.

Module maintained at https://github.com/pagespeed/cpanel

Download

Information

PhalconThis module allows you to install the Phalcon PHP framework. For more information on the Phalcon PHP framework, visit the Phalcon website.Module maintained at https://github.com/thecpaneladmin/EA-PhalconPHP

Download

Information