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

Overview

Use Apache modules to add functionality to your Apache web server.

How to install an Apache module

Important:

Some modules require further configuration. Read our documentation for the module for more information.

To install an Apache module, perform the following steps in WHM's EasyApache 3 interface (Home >> Software >> EasyApache 3):

  1. Select the Previously Saved Config option.
  2. Click the Start customizing based on profile link.
  3. Click Next Step.
  4. Click Next Step.
  5. Perform one of the following actions to select the module that you wish to use:
    • If the module that you wish to use is in the Short Options List interface, select the option and click Save and Build.
    • If the option is not in the Short Options List interface, click Exhaustive Options List. Select the option and click Save and Build.

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. 

Apache modules

The following tables contain a description of every Apache module that we allow you to build with EasyApache.

Click the name of a module to read about compatibility or other issues with that module within EasyApache.

Important:

The Mod Ruid2 profile is only available if you do not use CloudLinux.

Modules that are in the Basic, Mod Ruid2 and MPM ITK profiles by default

Module NameApache version compatibilityDescription
 2.22.4 
ActionsRuns CGI scripts based on media type or request method
AliasMaps URLs to filesystem paths
AsisSends files that contain their own HTTP headers
AuthBasicBasic authentication module
AuthnDefaultAuthentication fallback module
AuthnFileUser authentication using text files
AuthPassthroughUser authentication that allows a program to use its own authentication method
AuthzDefaultAuthentication fallback module which rejects any authorization request by default
AuthzGroupFileGroup authorization using text files
AuthzHostGroup authorization based on a hostname or IP address
AuthzUserUser authentication base module
AutoIndexAutomatically generates directory indexes
CGIHandles CGI requests
CoreCore Apache module
DeflateCompress content before it is delivered to the client
DirHandles trailing slash redirects and serves directory index files
EnvModifies the environment which is passed to CGI scripts and SSI pages
ExpiresGeneration of Expires and Cache-Control HTTP headers according to user-specified criteria
FileProtectcPanel: Limit webroot read access
FilterSmart filter configuration module
HeadersCustomization of HTTP request and response headers
HttpHandles HTTP requests
IncludeHandles Server-side includes
InfoProvides a comprehensive overview of the server configuration
LogConfigLogs requests to the server
LogioLogs input and output bytes per request
MIMEAssociates the requested filename's extension with the file's behavior and content
NegotiationAllows content negotiation so content can be displayed properly
Proxy HTTP/1.1 proxy/gateway server
ProxyAJPSupports AJP (Apache JServ Protocol) proxy requests
ProxyBalancerProvides load balancing support for HTTP, FTP and AJP13 protocols
ProxyConnectProxy extension for CONNECT-based handling
ProxyFTPSupports FTP proxy requests
ProxyHTTPSupports HTTP proxy requests
ProxyscgiSupports SCGI protocol proxy requests
RewriteUses rules to rewrite requested URLs as requested
ModSecurityWeb application firewall
SetEnvIfSets environment variables based on the request's characteristics
SoLoads executable code and modules at startup or restart
SSLHandles security through the Secure Sockets Layer and Transport Layer Security protocols.
StatusProvides information on server activity and performance
UserDir

Allows user-specific directories to be accessed through a translated path

Important:

This module will not function with the MPM ITK Module.

VersionVersion dependent configuration

Modules that are in the Basic profile

Note:

The Basic profile also includes the modules in the Modules that are in the Basic, Mod Ruid2 and MPM ITK profiles by default section.

Module nameApache version compatibilityDescription
 2.22.4 
MPM PreforkImplements a non-threaded, pre-forking web server
SuPHPExecute PHP scripts as the script owner

Modules that are in the Mod Ruid2 profile

Note:

The Basic profile also includes the modules in the Modules that are in the Basic, Mod Ruid2 and MPM ITK profiles by default section.

Module nameApache version compatibilityDescription
 2.22.4 
MPM PreforkImplements a non-threaded, pre-forking web server
SuPHPExecute PHP scripts as the script owner
ModRuid2Allows HTTP requests to a domain to run as the owner of that domain

Modules that are in the MPM ITK profile

Notes:

  • We introduced 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
Module nameApache version compatibilityDescription
 2.22.4 
MPM ITK

Implements a non-threaded, pre-forking web server

Important:

This module will not function with Apache's mod_userdir module.

[CloudLinux] HostingLimits

Puts CGI/PHP modules into LVE context.

If you install this module, EasyApache will build it automatically.

Additional modules that you can install via EasyApache

Module nameApache version compatibilityDescription
 2.22.4 
AuthDigestUser authentication using MD5 Digest Authentication (RFC2617)
AuthnAliasProvides the ability to create extended authentication providers based on actual providers
AuthnAnonAllows "anonymous" user access to authenticated areas
AuthnDBDUser authentication using an SQL database
AuthnDBMProvides for user authentication using DBM files
AuthnzLDAPAllows an LDAP directory to be used to store the database for HTTP Basic authentication
AuthzDBMGroup authorization using DBM files
MPM EventAn experimental variant of the standard worker MPM
MPM PreforkImplements a non-threaded, pre-forking web server
MPM WorkerImplements a hybrid multi-threaded multi-process web server
MPM ITK

Implements a non-threaded web server that allows each VirtualHost to run under a separate UID and GID.

We introduced the MPM ITK option 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
FCGIdHigh performance alternative to mod_cgi or mod_cgid
BandwidthSpeed and traffic limits
BucketeerFilter: manipulate buckets
CacheContent cache keyed to URIs
CaseFilterFilter: uppercase conversion
CaseFilterInFilter: uppercase conversion (input)
CernMetaCERN httpd metafile semantics
CharsetLiteSpecify character set translation or recoding
DavDistributed Authoring and Versioning (WebDAV) functionality
DAVFsDistributed Authoring and Versioning (WebDAV) functionality
DAVLockDistributed Authoring and Versioning (WebDAV) functionality
DBDManages SQL database connections
DiskCacheContent cache storage manager keyed to URIs
DistCacheDistributed session cache
DumpIODumps all I/O to error log as desired
EchoA simple echo server to illustrate protocol modules
ExtFilterPass the response body through an external program before delivery to the client
FileCacheCaches a static list of files in memory
FrontPage

Microsoft FrontPage support.

Warning:

We do not recommend that you install FrontPage. In order to make FrontPage available in EasyApache, you must install the Custom Module.

IdentRFC 1413 ident lookups
ImageMapServer-side imagemap processing
LDAPLDAP connection pooling and result caching services for use by other LDAP modules
LogForensicForensic Logging of the requests made to the server
MemCacheContent cache keyed to URIs
MimeMagicDetermines the MIME type of a file by looking at a few bytes of its contents
MonoIntegrate ASP into Apache
OptionalFnExportEnable the example for an optional function exporter, which is provided by mod_optional_fn_export
OptionalFnImportEnable the example for an optional function importer, which is provided by mod_optional_fn_import
OptionalHookExportEnable the example for an optional hook exporter, which is provided by mod_optional_hook_export
OptionalHookImportEnable the example optional hook importer, which is provided by mod_optional_hook_import
PerlIntegrate perl into Apache
QoSQuality of Service (QoS) provider for Apache
ModRuid2Allows HTTP requests to a domain to run as the owner of that domain
SpelingAttempts to correct mistaken/mistyped URLs
SuPHPExecute PHP scripts as the script owner
UniqueIdProvides an environment variable with a unique identifier for each request
UserTrackClickstream logging of user activity on a site
VhostAliasProvides for dynamically configured mass virtual hosting
WatchDogProvides infrastructure for other modules to periodically run tasks

CGI/SCGI modules

Module nameApache version compatibilityIncluded in the following profiles by defaultDescription
 2.2

2.4

Basic profile

Mod Ruid2 profileMPM ITK profile  
ActionsRuns CGI scripts based on media type or request method
CGI(default) Handles CGI requests
EnvModifies the environment which is passed to CGI scripts and SSI pages
FCGIdHigh performance alternative to mod_cgi or mod_cgid
HostingLimitsBuilds automatically if you install it on systemPuts CGI/PHP modules into LVE context
ProxyscgiSupports SCGI protocol proxy requests

Multi-processing modules (MPMs)

For more information on MPMs, read our MPM Options documentation.

Module nameApache version compatibilityIncluded in the following profiles by defaultDescription
 2.2

2.4

Basic profile

Mod Ruid2 profileMPM ITK profile 
MPM EventAn experimental variant of the standard worker MPM
MPM PreforkImplements a non-threaded, pre-forking web server
MPM WorkerImplements a hybrid multi-threaded multi-process web server
MPM ITK

Implements a non-threaded web server that allows each VirtualHost to run under a separate UID and GID.

We introduced the MPM ITK option 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

Proxy modules

Module nameApache version compatibilityIncluded in the following profiles by defaultDescription
 2.2

2.4

Basic profile

Mod Ruid2 profileMPM ITK profile  
Proxy

choice-yes

HTTP/1.1 proxy/gateway server
ProxyAJPSupports AJP (Apache JServ Protocol) proxy requests
ProxyBalancerProvides load balancing support for HTTP, FTP and AJP13 protocols
ProxyConnectProxy extension for CONNECT-based handling
ProxyFTPSupports FTP proxy requests
ProxyHTTPSupports HTTP proxy requests

Authentication and authorization modules

Module nameApache version compatibilityIncluded in the following profiles by defaultDescription
 2.2

2.4

Basic profile

Mod Ruid2 profileMPM ITK profile 
AuthBasicBasic authentication module
AuthDigestUser authentication using MD5 Digest Authentication (RFC2617)
AuthPassthroughUser authentication that allows a program to use its own authentication method
AuthnAliasProvides the ability to create extended authentication providers based on actual providers
AuthnAnonAllows "anonymous" user access to authenticated areas
AuthnDBDUser authentication using an SQL database
AuthnDBMProvides for user authentication using DBM files
AuthnDefault(default) Authentication fallback module
AuthnFile(default) User authentication using text files
AuthzGroupFile(default) Group authorization using text files
AuthzHost(default) Group authorization based on a hostname or IP address
AuthzUser(default) User authentication base module
AuthzDefault(default) Authentication fallback module which rejects any authorization request by default
AuthnzLDAPAllows an LDAP directory to be used to store the database for HTTP Basic authentication
AuthzDBMGroup authorization using DBM files

Other Apache modules

Module nameApache version compatibilityIncluded in the following profiles by defaultDescription
 2.2

2.4

Basic profile

Mod Ruid2 profileMPM ITK profile 
AliasMaps URLs to filesystem paths
AsisSends files that contain their own HTTP headers
AutoIndexAutomatically generates directory indexes
BandwidthSpeed and traffic limits
BucketeerFilter: manipulate buckets
CacheContent cache keyed to URIs
CaseFilterFilter: uppercase conversion
CaseFilterInFilter: uppercase conversion (input)
CernMetaCERN httpd metafile semantics
CharsetLiteSpecify character set translation or recoding
CoreCore Apache module
DavDistributed Authoring and Versioning (WebDAV) functionality
DAVFsDistributed Authoring and Versioning (WebDAV) functionality
DAVLockDistributed Authoring and Versioning (WebDAV) functionality
DBDManages SQL database connections
DeflateCompress content before it is delivered to the client
DirHandles trailing slash redirects and serves directory index files
DiskCacheContent cache storage manager keyed to URIs
DistCacheDistributed session cache
DumpIODumps all I/O to error log as desired
EchoA simple echo server to illustrate protocol modules
ExpiresGeneration of Expires and Cache-Control HTTP headers according to user-specified criteria
ExtFilterPass the response body through an external program before delivery to the client
FileCacheCaches a static list of files in memory
FileProtectcPanel: Limit webroot read access
FilterSmart filter configuration module
FrontPage

Microsoft FrontPage support.

Warning:

We do not recommend that you install FrontPage. In order to make FrontPage available in EasyApache, you must install the Custom Module.

HeadersCustomization of HTTP request and response headers
HttpHandles HTTP requests
IdentRFC 1413 ident lookups
ImageMapServer-side imagemap processing
IncludeHandles Server-side includes
InfoProvides a comprehensive overview of the server configuration
LDAPLDAP connection pooling and result caching services for use by other LDAP modules
LogConfigLogs requests to the server
LogioLogs input and output bytes per request
LogForensicForensic Logging of the requests made to the server
MemCacheContent cache keyed to URIs
MIMEAssociates the requested filename's extension with the file's behavior and content
MimeMagicDetermines the MIME type of a file by looking at a few bytes of its contents
MonoIntegrate ASP into Apache
NegotiationAllows content negotiation so content can be displayed properly
OptionalFnExportEnable the example for an optional function exporter, which is provided by mod_optional_fn_export
OptionalFnImportEnable the example for an optional function importer, which is provided by mod_optional_fn_import
OptionalHookExportEnable the example for an optional hook exporter, which is provided by mod_optional_hook_export
OptionalHookImportEnable the example optional hook importer, which is provided by mod_optional_hook_import
PerlIntegrate perl into Apache
QoSQuality of Service (QoS) provider for Apache
RewriteUses rules to rewrite requested URLs as requested
ModRuid2Allows HTTP requests to a domain to run as the owner of that domain
SecurityWeb application firewall
SetEnvIfSets environment variables based on the request's characteristics
SoLoads executable code and modules at startup or restart
SpelingAttempts to correct mistaken/mistyped URLs
SSLHandles security through the Secure Sockets Layer and Transport Layer Security protocols.
StatusProvides information on server activity and performance
SuPHPExecute PHP scripts as the script owner
UniqueIdProvides an environment variable with a unique identifier for each request
UserDirAllows user-specific directories to be accessed through a translated path
UserTrackClickstream logging of user activity on a site
VersionVersion dependent configuration
VhostAliasProvides for dynamically configured mass virtual hosting
WatchDogProvides infrastructure for other modules to periodically run tasks

Additional information

If you want to keep track of the latest Apache news and issues, you will find the following third-party resources useful:

Bug tracker

Mailing lists

List NameSubscribePostArchiveDescription
Announce Subscriben/aArchiveRead Only: Release/Security announcements
Bugs Subscriben/aArchiveRead Only: Bugzilla bug reports
CVS Subscriben/aArchiveRead Only: CVS (source) commits
Dev SubscribePostArchiveDiscussion: Apache development
Docs SubscribePostArchiveDiscussion: Documentation and translation submissions
Users SubscribePostArchiveDiscussion: General user list - installation, configuration, troubleshooting