FAQ

Page Discussion Edit History

Modules

(Difference between revisions)
(鈫鈥Standard HTTP modules: Deprecating Limit Zone in favour of Limit Conn)
(鈫鈥Standard HTTP modules)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Installing Modules =
 
= Installing Modules =
鈭
Nginx modules must be selected during compile, run time including of modules is not supported. A full summary of the compile-time options, including optional modules can be found in the provided configure script by running "./configure --help"
+
Nginx modules must be selected during compile, run-time selection of modules is not currently supported.  
 +
 
 +
A full summary of the compile-time options, including optional modules, can be found in the provided configure script by running <code>./configure --help</code>
  
 
= Nginx core modules =
 
= Nginx core modules =
 
These modules are required.
 
These modules are required.
  
鈭
{|
+
{| class="modules-index-table"
 
! Name !! Description
 
! Name !! Description
 
|-
 
|-
Line 15: Line 17:
 
|-
 
|-
 
|}
 
|}
鈭
 
  
 
= Standard HTTP modules =
 
= Standard HTTP modules =
 
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.
 
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.
  
鈭
{|
+
{| class="modules-index-table"
 
! Name
 
! Name
 
! Description
 
! Description
Line 48: Line 49:
 
| [[HttpBrowserModule|Browser]]
 
| [[HttpBrowserModule|Browser]]
 
| Interpret "User-Agent" string.
 
| Interpret "User-Agent" string.
鈭
|
+
| 0.4.3
 
| --without-http_browser_module
 
| --without-http_browser_module
 
|-
 
|-
Line 58: Line 59:
 
| [[HttpEmptyGifModule|Empty GIF]]
 
| [[HttpEmptyGifModule|Empty GIF]]
 
| Serve a 1x1 image from memory.
 
| Serve a 1x1 image from memory.
鈭
|
+
| 0.3.10
 
| --without-http_empty_gif_module
 
| --without-http_empty_gif_module
 
|-
 
|-
鈭
| [[HttpFcgiModule|FastCGI]]
+
| [[HttpFastcgiModule|FastCGI]]
 
| FastCGI Support.
 
| FastCGI Support.
 
|
 
|
Line 68: Line 69:
 
| [[HttpGeoModule|Geo]]
 
| [[HttpGeoModule|Geo]]
 
| Set config variables using key/value pairs of IP addresses.
 
| Set config variables using key/value pairs of IP addresses.
鈭
|
+
| 0.1.17
 
| --without-http_geo_module
 
| --without-http_geo_module
 
|-
 
|-
Line 91: Line 92:
 
| [[HttpLimitZoneModule|Limit Zone]]
 
| [[HttpLimitZoneModule|Limit Zone]]
 
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
 
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
鈭
|
+
| 0.5.6
 
| --without-http_limit_zone_module
 
| --without-http_limit_zone_module
 
|-
 
|-
Line 105: Line 106:
 
| [[HttpMapModule|Map]]
 
| [[HttpMapModule|Map]]
 
| Set config variables using arbitrary key/value pairs.
 
| Set config variables using arbitrary key/value pairs.
鈭
|
+
| 0.3.16
 
| --without-http_map_module
 
| --without-http_map_module
 
|-
 
|-
Line 128: Line 129:
 
| --without-http_rewrite_module
 
| --without-http_rewrite_module
 
|-
 
|-
鈭
| [[HttpScgiModule|scgi]]
+
| [[HttpScgiModule|SCGI]]
鈭
| scgi protocol support.
+
| SCGI protocol support.
 
| 0.8.42
 
| 0.8.42
 
| --without-http_scgi_module
 
| --without-http_scgi_module
Line 148: Line 149:
 
| --without-http_upstream_ip_hash_module (ip_hash directive only)
 
| --without-http_upstream_ip_hash_module (ip_hash directive only)
 
|-
 
|-
鈭
| [[HttpUserIdModule|User ID]]
+
| [[HttpUseridModule|User ID]]
 
| Issue identifying cookies.
 
| Issue identifying cookies.
 
|
 
|
 
| --without-http_userid_module
 
| --without-http_userid_module
 
|-
 
|-
鈭
| [[HttpUwsgiModule|uwsgi]]
+
| [[HttpUwsgiModule|uWSGI]]
鈭
| uwsgi protocol support.
+
| uWSGI protocol support.
 
| 0.8.40
 
| 0.8.40
 
| --without-http_uwsgi_module
 
| --without-http_uwsgi_module
Line 167: Line 168:
 
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.
 
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.
  
鈭
{|
+
{| class="modules-index-table"
 
! Name
 
! Name
 
! Description
 
! Description
Line 178: Line 179:
 
| --with-http_addition_module
 
| --with-http_addition_module
 
|-
 
|-
鈭
| [http://nginx.org/pipermail/nginx/2009-November/016812.html Degradation]
+
| [[HttpDegradationModule|Degradation]]
 
| Allow to return 204 or 444 code for some locations on low memory condition.
 
| Allow to return 204 or 444 code for some locations on low memory condition.
 
| 0.8.25
 
| 0.8.25
 
| --with-http_degradation_module
 
| --with-http_degradation_module
 
|-
 
|-
鈭
| [[EmbeddedPerlModule|Embedded Perl]]
+
| [[HttpPerlModule|Embedded Perl]]
 
| Use Perl in Nginx config files.
 
| Use Perl in Nginx config files.
鈭
|  
+
| 0.3.21
 
| --with-http_perl_module
 
| --with-http_perl_module
 
|-
 
|-
鈭
| [[HttpFlvStreamModule|FLV]]
+
| [[HttpFlvModule|FLV]]
 
| Flash Streaming Video
 
| Flash Streaming Video
鈭
|  
+
| 0.4.7
 
| --with-http_flv_module
 
| --with-http_flv_module
 
|-
 
|-
鈭
| [[HttpGeoIPModule|GeoIP]]
+
| [[HttpGeoipModule|GeoIP]]
 
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
 
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
 
| 0.8.6, 0.7.63
 
| 0.8.6, 0.7.63
Line 223: Line 224:
 
| --with-http_random_index_module
 
| --with-http_random_index_module
 
|-
 
|-
鈭
| [[HttpRealIpModule|Real IP]]
+
| [[HttpRealipModule|Real IP]]
 
| For using nginx as backend
 
| For using nginx as backend
鈭
|  
+
| 0.3.8
 
| --with-http_realip_module
 
| --with-http_realip_module
 
|-
 
|-
Line 240: Line 241:
 
| [[HttpStubStatusModule|Stub Status]]
 
| [[HttpStubStatusModule|Stub Status]]
 
| View server statistics.
 
| View server statistics.
鈭
|  
+
| 0.1.18
 
| --with-http_stub_status_module
 
| --with-http_stub_status_module
 
|-
 
|-
Line 250: Line 251:
 
| [[HttpDavModule|WebDAV]]
 
| [[HttpDavModule|WebDAV]]
 
| WebDAV pass-through support.
 
| WebDAV pass-through support.
鈭
|  
+
| 0.3.38
 
| --with-http_dav_module
 
| --with-http_dav_module
 
|-
 
|-
Line 260: Line 261:
  
 
= Mail modules =
 
= Mail modules =
鈭
{|
+
{| class="modules-index-table"
 
! Name
 
! Name
 
! Description
 
! Description
Line 279: Line 280:
 
| --with-mail_ssl_module
 
| --with-mail_ssl_module
 
|}
 
|}
鈭
 
  
 
= Third party modules and Patches =
 
= Third party modules and Patches =
Line 288: Line 288:
 
* [[ConfigNotation| Configuration Notation Reference]]
 
* [[ConfigNotation| Configuration Notation Reference]]
 
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
 
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
鈭
* [[FeatureRequests| Feature Requests]]  
+
* [http://trac.nginx.org/nginx Feature Requests and bug reports]  
 
* [[GettingStarted| Getting Started]]  
 
* [[GettingStarted| Getting Started]]  
 
* [[Configuration| Configuration Cookbook]]
 
* [[Configuration| Configuration Cookbook]]
 
* [[DirectiveIndex| Index of all Directives]]
 
* [[DirectiveIndex| Index of all Directives]]

Latest revision as of 18:22, 5 July 2012

Contents

[edit] Installing Modules

Nginx modules must be selected during compile, run-time selection of modules is not currently supported.

A full summary of the compile-time options, including optional modules, can be found in the provided configure script by running ./configure --help

[edit] Nginx core modules

These modules are required.

Name Description
Main Configure error logging, processes, permissions, etc.
Events Configure epoll, kqueue, select, poll, etc.

[edit] Standard HTTP modules

These modules are automatically compiled in unless explicitly disabled with configure.

Name Description Version configure argument to disable
Core Control ports, locations, error pages, aliases, and other essentials. --without-http
Access Allow/deny based on IP address. --without-http_access_module
Auth Basic Basic HTTP authentication. --without-http_auth_basic_module
Auto Index Generates automatic directory listings. --without-http_autoindex_module
Browser Interpret "User-Agent" string. 0.4.3 --without-http_browser_module
Charset Recode web pages. --without-http_charset_module
Empty GIF Serve a 1x1 image from memory. 0.3.10 --without-http_empty_gif_module
FastCGI FastCGI Support. --without-http_fastcgi_module
Geo Set config variables using key/value pairs of IP addresses. 0.1.17 --without-http_geo_module
Gzip Gzip responses. --without-http_gzip_module
Headers Set arbitrary HTTP response headers.
Index Controls which files are to be used as index.
Limit Requests Limit frequency of connections from a client. 0.7.20 --without-http_limit_req_module
Limit Zone Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead. 0.5.6 --without-http_limit_zone_module
Limit Conn Limit concurrent connections based on a variable. --without-http_limit_conn_module
Log Customize access logs.
Map Set config variables using arbitrary key/value pairs. 0.3.16 --without-http_map_module
Memcached Memcached support. --without-http_memcached_module
Proxy Proxy to upstream servers. --without-http_proxy_module
Referer Filter requests based on Referer header. --without-http_referer_module
Rewrite Request rewriting using regular expressions. --without-http_rewrite_module
SCGI SCGI protocol support. 0.8.42 --without-http_scgi_module
Split Clients Splits clients based on some conditions 0.8.37 --without-http_split_clients_module
SSI Server-side includes. --without-http_ssi_module
Upstream For load-balancing. --without-http_upstream_ip_hash_module (ip_hash directive only)
User ID Issue identifying cookies. --without-http_userid_module
uWSGI uWSGI protocol support. 0.8.40 --without-http_uwsgi_module
X-Accel X-Sendfile-like module.

[edit] Optional HTTP modules

The following modules must be enabled at compile-time with the specified option to configure.

Name Description Version configure argument to enable
Addition Append text to pages. --with-http_addition_module
Degradation Allow to return 204 or 444 code for some locations on low memory condition. 0.8.25 --with-http_degradation_module
Embedded Perl Use Perl in Nginx config files. 0.3.21 --with-http_perl_module
FLV Flash Streaming Video 0.4.7 --with-http_flv_module
GeoIP Creates variables with information from the MaxMind GeoIP binary files. 0.8.6, 0.7.63 --with-http_geoip_module
Google Perftools Google Performance Tools support. 0.6.29 --with-google_perftools_module
Gzip Precompression Serves precompressed versions of static files. 0.6.23 --with-http_gzip_static_module
Image Filter Transform images with Libgd 0.7.54 --with-http_image_filter_module
MP4 Enables mp4 streaming with seeking ability. 1.1.3, 1.0.7 --with-http_mp4_module
Random Index Randomize directory indexes. 0.7.15 --with-http_random_index_module
Real IP For using nginx as backend 0.3.8 --with-http_realip_module
Secure Link Protect pages with a secret key. 0.7.18 --with-http_secure_link_module
SSL HTTPS/SSL support. --with-http_ssl_module
Stub Status View server statistics. 0.1.18 --with-http_stub_status_module
Substitution Replace text in pages --with-http_sub_module
WebDAV WebDAV pass-through support. 0.3.38 --with-http_dav_module
XSLT Post-process pages with XSLT. 0.7.8 --with-http_xslt_module

[edit] Mail modules

Name Description configure argument
Core Nginx is able to handle and proxy the IMAP, POP3, SMTP protocols. --with-mail
--without-mail_pop3_module
--without-mail_imap_module
--without-mail_smtp_module
Auth Use Nginx to authenticate mail services.
Proxy Nginx can proxy IMAP, POP3, and SMTP protocols.
SSL This module ensures SSL/TLS support for POP3/IMAP/SMTP. --with-mail_ssl_module

[edit] Third party modules and Patches

Please see the catalog of 3rd party modules.

[edit] References

Retrieved from "http://wiki.nginx.org/index.php?title=Modules&oldid=2449"