- publishing free software manuals
The Apache HTTP Server Reference Manual
by Apache Software Foundation
Paperback (6"x9"), 862 pages
ISBN 9781906966034
RRP £19.95 ($29.95)

Get a printed copy>>>

3  Apache modules

 3.1  Terms Used to Describe Modules
  3.1.1  Description
  3.1.2  Status
  3.1.3  Source File
  3.1.4  Module Identifier
  3.1.5  Compatibility
 3.2  Terms Used to Describe Directives
  3.2.1  Description
  3.2.2  Syntax
  3.2.3  Default
  3.2.4  Context
  3.2.5  Override
  3.2.6  Status
  3.2.7  Module
  3.2.8  Compatibility
 3.3  Apache Module core
  AcceptFilter Directive
  AcceptPathInfo Directive
  AccessFileName Directive
  AddDefaultCharset Directive
  AddOutputFilterByType Directive
  AllowEncodedSlashes Directive
  AllowOverride Directive
  AuthName Directive
  AuthType Directive
  CGIMapExtension Directive
  ContentDigest Directive
  DefaultType Directive
  Directory Directive
  DirectoryMatch Directive
  DocumentRoot Directive
  EnableMMAP Directive
  EnableSendfile Directive
  ErrorDocument Directive
  ErrorLog Directive
  FileETag Directive
  Files Directive
  FilesMatch Directive
  ForceType Directive
  HostnameLookups Directive
  IfDefine Directive
  IfModule Directive
  Include Directive
  KeepAlive Directive
  KeepAliveTimeout Directive
  Limit Directive
  LimitExcept Directive
  LimitInternalRecursion Directive
  LimitRequestBody Directive
  LimitRequestFieldSize Directive
  LimitRequestFields Directive
  LimitRequestLine Directive
  LimitXMLRequestBody Directive
  Location Directive
  LocationMatch Directive
  LogLevel Directive
  MaxKeepAliveRequests Directive
  NameVirtualHost Directive
  Options Directive
  RLimitCPU Directive
  RLimitMEM Directive
  RLimitNPROC Directive
  Require Directive
  Satisfy Directive
  ScriptInterpreterSource Directive
  ServerAdmin Directive
  ServerAlias Directive
  ServerName Directive
  ServerPath Directive
  ServerRoot Directive
  ServerSignature Directive
  ServerTokens Directive
  SetHandler Directive
  SetInputFilter Directive
  SetOutputFilter Directive
  TimeOut Directive
  TraceEnable Directive
  UseCanonicalName Directive
  UseCanonicalPhysicalPort Directive
  VirtualHost Directive
 3.4  Apache Module mod_actions
  Summary
  Action Directive
  Script Directive
 3.5  Apache Module mod_alias
  Summary
  3.5.1  Order of Processing
  Alias Directive
  AliasMatch Directive
  Redirect Directive
  RedirectMatch Directive
  RedirectPermanent Directive
  RedirectTemp Directive
  ScriptAlias Directive
  ScriptAliasMatch Directive
 3.6  Apache Module mod_asis
  Summary
  3.6.1  Usage
 3.7  Apache Module mod_auth_basic
  Summary
  AuthBasicAuthoritative Directive
  AuthBasicProvider Directive
 3.8  Apache Module mod_auth_digest
  Summary
  3.8.1  Using Digest Authentication
  3.8.2  Working with MS Internet Explorer
  AuthDigestAlgorithm Directive
  AuthDigestDomain Directive
  AuthDigestNcCheck Directive
  AuthDigestNonceFormat Directive
  AuthDigestNonceLifetime Directive
  AuthDigestProvider Directive
  AuthDigestQop Directive
  AuthDigestShmemSize Directive
 3.9  Apache Module mod_authn_alias
  Summary
  3.9.1  Examples
  AuthnProviderAlias Directive
 3.10  Apache Module mod_authn_anon
  Summary
  3.10.1  Example
  Anonymous Directive
  Anonymous_LogEmail Directive
  Anonymous_MustGiveEmail Directive
  Anonymous_NoUserID Directive
  Anonymous_VerifyEmail Directive
 3.11  Apache Module mod_authn_dbd
  Summary
  3.11.1  Configuration Example
  3.11.2  Exposing Login Information
  AuthDBDUserPWQuery Directive
  AuthDBDUserRealmQuery Directive
 3.12  Apache Module mod_authn_dbm
  Summary
  AuthDBMType Directive
  AuthDBMUserFile Directive
 3.13  Apache Module mod_authn_default
  Summary
  AuthDefaultAuthoritative Directive
 3.14  Apache Module mod_authn_file
  Summary
  AuthUserFile Directive
 3.15  Apache Module mod_authnz_ldap
  Summary
  3.15.1  Contents
  3.15.2  Operation
  3.15.3  The Require Directives
  3.15.4  Examples
  3.15.5  Using TLS
  3.15.6  Using SSL
  3.15.7  Exposing Login Information
  3.15.8  Using Microsoft FrontPage with mod_authnz_ldap
  AuthLDAPBindAuthoritative Directive
  AuthLDAPBindDN Directive
  AuthLDAPBindPassword Directive
  AuthLDAPCharsetConfig Directive
  AuthLDAPCompareDNOnServer Directive
  AuthLDAPDereferenceAliases Directive
  AuthLDAPGroupAttribute Directive
  AuthLDAPGroupAttributeIsDN Directive
  AuthLDAPRemoteUserAttribute Directive
  AuthLDAPRemoteUserIsDN Directive
  AuthLDAPUrl Directive
  AuthzLDAPAuthoritative Directive
 3.16  Apache Module mod_authz_dbm
  Summary
  AuthDBMGroupFile Directive
  AuthzDBMAuthoritative Directive
  AuthzDBMType Directive
 3.17  Apache Module mod_authz_default
  Summary
  AuthzDefaultAuthoritative Directive
 3.18  Apache Module mod_authz_groupfile
  Summary
  AuthGroupFile Directive
  AuthzGroupFileAuthoritative Directive
 3.19  Apache Module mod_authz_host
  Summary
  Allow Directive
  Deny Directive
  Order Directive
 3.20  Apache Module mod_authz_owner
  Summary
  3.20.1  Configuration Examples
  AuthzOwnerAuthoritative Directive
 3.21  Apache Module mod_authz_user
  Summary
  AuthzUserAuthoritative Directive
 3.22  Apache Module mod_autoindex
  Summary
  3.22.1  Autoindex Request Query Arguments
  AddAlt Directive
  AddAltByEncoding Directive
  AddAltByType Directive
  AddDescription Directive
  AddIcon Directive
  AddIconByEncoding Directive
  AddIconByType Directive
  DefaultIcon Directive
  HeaderName Directive
  IndexHeadInsert Directive
  IndexIgnore Directive
  IndexOptions Directive
  IndexOrderDefault Directive
  IndexStyleSheet Directive
  ReadmeName Directive
 3.23  Apache Module mod_cache
  Summary
  3.23.1  Related Modules and Directives
  3.23.2  Sample Configuration
  3.23.3  Avoiding the Thundering Herd
  CacheDefaultExpire Directive
  CacheDisable Directive
  CacheEnable Directive
  CacheIgnoreCacheControl Directive
  CacheIgnoreHeaders Directive
  CacheIgnoreNoLastMod Directive
  CacheIgnoreQueryString Directive
  CacheIgnoreURLSessionIdentifiers Directive
  CacheLastModifiedFactor Directive
  CacheLock Directive
  CacheLockMaxAge Directive
  CacheLockPath Directive
  CacheMaxExpire Directive
  CacheStoreNoStore Directive
  CacheStorePrivate Directive
 3.24  Apache Module mod_cern_meta
  Summary
  MetaDir Directive
  MetaFiles Directive
  MetaSuffix Directive
 3.25  Apache Module mod_cgi
  Summary
  3.25.1  CGI Environment variables
  3.25.2  CGI Debugging
  ScriptLog Directive
  ScriptLogBuffer Directive
  ScriptLogLength Directive
 3.26  Apache Module mod_cgid
  Summary
  ScriptSock Directive
 3.27  Apache Module mod_charset_lite
  Summary
  3.27.1  Common Problems
  CharsetDefault Directive
  CharsetOptions Directive
  CharsetSourceEnc Directive
 3.28  Apache Module mod_dav
  Summary
  3.28.1  Enabling WebDAV
  3.28.2  Security Issues
  3.28.3  Complex Configurations
  Dav Directive
  DavDepthInfinity Directive
  DavMinTimeout Directive
 3.29  Apache Module mod_dav_fs
  Summary
  DavLockDB Directive
 3.30  Apache Module mod_dav_lock
  Summary
  DavGenericLockDB Directive
 3.31  Apache Module mod_dbd
  Summary
  3.31.1  Connection Pooling
  3.31.2  Apache DBD API
  3.31.3  SQL Prepared Statements
  3.31.4  SECURITY WARNING
  DBDExptime Directive
  DBDKeep Directive
  DBDMax Directive
  DBDMin Directive
  DBDParams Directive
  DBDPersist Directive
  DBDPrepareSQL Directive
  DBDriver Directive
 3.32  Apache Module mod_deflate
  Summary
  3.32.1  Sample Configurations
  3.32.2  Enabling Compression
  3.32.3  Dealing with proxy servers
  DeflateBufferSize Directive
  DeflateCompressionLevel Directive
  DeflateFilterNote Directive
  DeflateMemLevel Directive
  DeflateWindowSize Directive
 3.33  Apache Module mod_dir
  Summary
  DirectoryIndex Directive
  DirectorySlash Directive
  FallbackResource Directive
 3.34  Apache Module mod_disk_cache
  Summary
  CacheDirLength Directive
  CacheDirLevels Directive
  CacheMaxFileSize Directive
  CacheMinFileSize Directive
  CacheRoot Directive
 3.35  Apache Module mod_dumpio
  Summary
  3.35.1  Enabling dumpio Support
  DumpIOInput Directive
  DumpIOLogLevel Directive
  DumpIOOutput Directive
 3.36  Apache Module mod_echo
  Summary
  ProtocolEcho Directive
 3.37  Apache Module mod_env
  Summary
  PassEnv Directive
  SetEnv Directive
  UnsetEnv Directive
 3.38  Apache Module mod_example
  Summary
  3.38.1  Compiling the example module
  3.38.2  Using the mod_example Module
  Example Directive
 3.39  Apache Module mod_expires
  Summary
  3.39.1  Alternate Interval Syntax
  ExpiresActive Directive
  ExpiresByType Directive
  ExpiresDefault Directive
 3.40  Apache Module mod_ext_filter
  Summary
  3.40.1  Examples
  ExtFilterDefine Directive
  ExtFilterOptions Directive
 3.41  Apache Module mod_file_cache
  Summary
  3.41.1  Using mod_file_cache
  CacheFile Directive
  MMapFile Directive
 3.42  Apache Module mod_filter
  Summary
  3.42.1  Smart Filtering
  3.42.2  Filter Declarations, Providers and Chains
  3.42.3  Configuring the Chain
  3.42.4  Filtering and Response Status
  3.42.5  Examples
  3.42.6  Protocol Handling
  FilterChain Directive
  FilterDeclare Directive
  FilterProtocol Directive
  FilterProvider Directive
  FilterTrace Directive
 3.43  Apache Module mod_headers
  Summary
  3.43.1  Order of Processing
  3.43.2  Early and Late Processing
  3.43.3  Examples
  Header Directive
  RequestHeader Directive
 3.44  Apache Module mod_ident
  Summary
  IdentityCheck Directive
  IdentityCheckTimeout Directive
 3.45  Apache Module mod_imagemap
  Summary
  3.45.1  New Features
  3.45.2  Imagemap File
  3.45.3  Example Mapfile
  3.45.4  Referencing your mapfile
  ImapBase Directive
  ImapDefault Directive
  ImapMenu Directive
 3.46  Apache Module mod_include
  Summary
  3.46.1  Enabling Server-Side Includes
  3.46.2  PATH_INFO with Server Side Includes
  3.46.3  Basic Elements
  3.46.4  Include Variables
  3.46.5  Variable Substitution
  3.46.6  Flow Control Elements
  SSIETag Directive
  SSIEnableAccess Directive
  SSIEndTag Directive
  SSIErrorMsg Directive
  SSILastModified Directive
  SSIStartTag Directive
  SSITimeFormat Directive
  SSIUndefinedEcho Directive
  XBitHack Directive
 3.47  Apache Module mod_info
  Summary
  3.47.1  Security Issues
  3.47.2  Selecting the information shown
  3.47.3  Known Limitations
  AddModuleInfo Directive
 3.48  Apache Module mod_isapi
  Summary
  3.48.1  Usage
  3.48.2  Additional Notes
  3.48.3  Programmer’s Journal
  ISAPIAppendLogToErrors Directive
  ISAPIAppendLogToQuery Directive
  ISAPICacheFile Directive
  ISAPIFakeAsync Directive
  ISAPILogNotSupported Directive
  ISAPIReadAheadBuffer Directive
 3.49  Apache Module mod_ldap
  Summary
  3.49.1  Example Configuration
  3.49.2  LDAP Connection Pool
  3.49.3  LDAP Cache
  3.49.4  Using SSL/TLS
  3.49.5  SSL/TLS Certificates
  LDAPCacheEntries Directive
  LDAPCacheTTL Directive
  LDAPConnectionTimeout Directive
  LDAPOpCacheEntries Directive
  LDAPOpCacheTTL Directive
  LDAPSharedCacheFile Directive
  LDAPSharedCacheSize Directive
  LDAPTrustedClientCert Directive
  LDAPTrustedGlobalCert Directive
  LDAPTrustedMode Directive
  LDAPVerifyServerCert Directive
 3.50  Apache Module mod_log_config
  Summary
  3.50.1  Custom Log Formats
  3.50.2  Security Considerations
  BufferedLogs Directive
  CookieLog Directive
  CustomLog Directive
  LogFormat Directive
  TransferLog Directive
 3.51  Apache Module mod_log_forensic
  Summary
  3.51.1  Forensic Log Format
  3.51.2  Security Considerations
  ForensicLog Directive
 3.52  Apache Module mod_logio
  Summary
  3.52.1  Custom Log Formats
 3.53  Apache Module mod_mem_cache
  Summary
  MCacheMaxObjectCount Directive
  MCacheMaxObjectSize Directive
  MCacheMaxStreamingBuffer Directive
  MCacheMinObjectSize Directive
  MCacheRemovalAlgorithm Directive
  MCacheSize Directive
 3.54  Apache Module mod_mime
  Summary
  3.54.1  Files with Multiple Extensions
  3.54.2  Content encoding
  3.54.3  Character sets and languages
  AddCharset Directive
  AddEncoding Directive
  AddHandler Directive
  AddInputFilter Directive
  AddLanguage Directive
  AddOutputFilter Directive
  AddType Directive
  DefaultLanguage Directive
  ModMimeUsePathInfo Directive
  MultiviewsMatch Directive
  RemoveCharset Directive
  RemoveEncoding Directive
  RemoveHandler Directive
  RemoveInputFilter Directive
  RemoveLanguage Directive
  RemoveOutputFilter Directive
  RemoveType Directive
  TypesConfig Directive
 3.55  Apache Module mod_mime_magic
  Summary
  3.55.1  Format of the Magic File
  3.55.2  Performance Issues
  3.55.3  Notes
  MimeMagicFile Directive
 3.56  Apache Module mod_negotiation
  Summary
  3.56.1  Type maps
  3.56.2  MultiViews
  CacheNegotiatedDocs Directive
  ForceLanguagePriority Directive
  LanguagePriority Directive
 3.57  Apache Module mod_nw_ssl
  Summary
  NWSSLTrustedCerts Directive
  NWSSLUpgradeable Directive
  SecureListen Directive
 3.58  Apache Module mod_proxy
  Summary
  3.58.1  Forward Proxies and Reverse Proxies/Gateways
  3.58.2  Basic Examples
  3.58.3  Workers
  3.58.4  Controlling access to your proxy
  3.58.5  Slow Startup
  3.58.6  Intranet Proxy
  3.58.7  Protocol Adjustments
  3.58.8  Request Bodies
  3.58.9  Reverse Proxy Request Headers
  AllowCONNECT Directive
  BalancerMember Directive
  NoProxy Directive
  Proxy Directive
  ProxyBadHeader Directive
  ProxyBlock Directive
  ProxyDomain Directive
  ProxyErrorOverride Directive
  ProxyFtpDirCharset Directive
  ProxyIOBufferSize Directive
  ProxyMatch Directive
  ProxyMaxForwards Directive
  ProxyPass Directive
  ProxyPassInterpolateEnv Directive
  ProxyPassMatch Directive
  ProxyPassReverse Directive
  ProxyPassReverseCookieDomain Directive
  ProxyPassReverseCookiePath Directive
  ProxyPreserveHost Directive
  ProxyReceiveBufferSize Directive
  ProxyRemote Directive
  ProxyRemoteMatch Directive
  ProxyRequests Directive
  ProxySet Directive
  ProxyStatus Directive
  ProxyTimeout Directive
  ProxyVia Directive
 3.59  Apache Module mod_proxy_ajp
  Summary
  3.59.1  Overview of the protocol
  3.59.2  Basic Packet Structure
  3.59.3  Request Packet Structure
  3.59.4  Response Packet Structure
 3.60  Apache Module mod_proxy_balancer
  Summary
  3.60.1  Load balancer scheduler algorithm
  3.60.2  Load balancer stickyness
  3.60.3  Examples of a balancer configuration
  3.60.4  Request Counting Algorithm
  3.60.5  Weighted Traffic Counting Algorithm
  3.60.6  Pending Request Counting Algorithm
  3.60.7  Exported Environment Variables
  3.60.8  Enabling Balancer Manager Support
  3.60.9  Details on load balancer stickyness
  3.60.10  Troubleshooting load balancer stickyness
 3.61  Apache Module mod_proxy_connect
  Summary
 3.62  Apache Module mod_proxy_ftp
  Summary
  3.62.1  Why doesn’t file type xxx download via FTP?
  3.62.2  How can I force an FTP ASCII download of File xxx?
  3.62.3  How can I do FTP upload?
  3.62.4  How can I access FTP files outside of my home directory?
  3.62.5  How can I hide the FTP cleartext password in my browser’s URL line?
 3.63  Apache Module mod_proxy_http
  Summary
  3.63.1  Environment Variables
 3.64  Apache Module mod_proxy_scgi
  Summary
  3.64.1  Examples
  ProxySCGIInternalRedirect Directive
  ProxySCGISendfile Directive
 3.65  Apache Module mod_reqtimeout
  3.65.1  Examples
  RequestReadTimeout Directive
 3.66  Apache Module mod_rewrite
  Summary
  3.66.1  Quoting Special Characters
  3.66.2  Environment Variables
  3.66.3  Rewriting in Virtual Hosts
  3.66.4  Practical Solutions
  RewriteBase Directive
  RewriteCond Directive
  RewriteEngine Directive
  RewriteLock Directive
  RewriteLog Directive
  RewriteLogLevel Directive
  RewriteMap Directive
  RewriteOptions Directive
  RewriteRule Directive
 3.67  Apache Module mod_setenvif
  Summary
  BrowserMatch Directive
  BrowserMatchNoCase Directive
  SetEnvIf Directive
  SetEnvIfNoCase Directive
 3.68  Apache Module mod_so
  Summary
  3.68.1  Creating Loadable Modules for Windows
  LoadFile Directive
  LoadModule Directive
 3.69  Apache Module mod_speling
  Summary
  CheckCaseOnly Directive
  CheckSpelling Directive
 3.70  Apache Module mod_ssl
  Summary
  3.70.1  Environment Variables
  3.70.2  Custom Log Formats
  SSLCACertificateFile Directive
  SSLCACertificatePath Directive
  SSLCADNRequestFile Directive
  SSLCADNRequestPath Directive
  SSLCARevocationFile Directive
  SSLCARevocationPath Directive
  SSLCertificateChainFile Directive
  SSLCertificateFile Directive
  SSLCertificateKeyFile Directive
  SSLCipherSuite Directive
  SSLCryptoDevice Directive
  SSLEngine Directive
  SSLFIPS Directive
  SSLHonorCipherOrder Directive
  SSLInsecureRenegotiation Directive
  SSLMutex Directive
  SSLOptions Directive
  SSLPassPhraseDialog Directive
  SSLProtocol Directive
  SSLProxyCACertificateFile Directive
  SSLProxyCACertificatePath Directive
  SSLProxyCARevocationFile Directive
  SSLProxyCARevocationPath Directive
  SSLProxyCheckPeerCN Directive
  SSLProxyCheckPeerExpire Directive
  SSLProxyCipherSuite Directive
  SSLProxyEngine Directive
  SSLProxyMachineCertificateFile Directive
  SSLProxyMachineCertificatePath Directive
  SSLProxyProtocol Directive
  SSLProxyVerify Directive
  SSLProxyVerifyDepth Directive
  SSLRandomSeed Directive
  SSLRenegBufferSize Directive
  SSLRequire Directive
  SSLRequireSSL Directive
  SSLSessionCache Directive
  SSLSessionCacheTimeout Directive
  SSLStrictSNIVHostCheck Directive
  SSLUserName Directive
  SSLVerifyClient Directive
  SSLVerifyDepth Directive
 3.71  Apache Module mod_status
  Summary
  3.71.1  Enabling Status Support
  3.71.2  Automatic Updates
  3.71.3  Machine Readable Status File
  ExtendedStatus Directive
  SeeRequestTail Directive
 3.72  Apache Module mod_substitute
  Summary
  Substitute Directive
 3.73  Apache Module mod_suexec
  Summary
  SuexecUserGroup Directive
 3.74  Apache Module mod_unique_id
  Summary
  3.74.1  Theory
 3.75  Apache Module mod_userdir
  Summary
  UserDir Directive
 3.76  Apache Module mod_usertrack
  Summary
  3.76.1  Logging
  3.76.2  2-digit or 4-digit dates for cookies?
  CookieDomain Directive
  CookieExpires Directive
  CookieName Directive
  CookieStyle Directive
  CookieTracking Directive
 3.77  Apache Module mod_version
  Summary
  IfVersion Directive
 3.78  Apache Module mod_vhost_alias
  Summary
  3.78.1  Directory Name Interpolation
  3.78.2  Examples
  VirtualDocumentRoot Directive
  VirtualDocumentRootIP Directive
  VirtualScriptAlias Directive
  VirtualScriptAliasIP Directive
 3.79  Apache Module beos
  Summary
  MaxRequestsPerThread Directive
 3.80  Apache Module mpm_common
  AcceptMutex Directive
  ChrootDir Directive
  CoreDumpDirectory Directive
  EnableExceptionHook Directive
  GracefulShutdownTimeout Directive
  Group Directive
  Listen Directive
  ListenBackLog Directive
  LockFile Directive
  MaxClients Directive
  MaxMemFree Directive
  MaxRequestsPerChild Directive
  MaxSpareThreads Directive
  MinSpareThreads Directive
  PidFile Directive
  ReceiveBufferSize Directive
  ScoreBoardFile Directive
  SendBufferSize Directive
  ServerLimit Directive
  StartServers Directive
  StartThreads Directive
  ThreadLimit Directive
  ThreadStackSize Directive
  ThreadsPerChild Directive
  User Directive
 3.81  Apache Module event
  Summary
  3.81.1  How it Works
  3.81.2  Requirements
 3.82  Apache Module prefork
  Summary
  3.82.1  How it Works
  MaxSpareServers Directive
  MinSpareServers Directive
 3.83  Apache Module mpm_winnt
  Summary
  Win32DisableAcceptEx Directive
 3.84  Apache Module worker
  Summary
  3.84.1  How it Works

ISBN 9781906966034The Apache HTTP Server Reference ManualSee the print edition