nginx modules
Modules
Contents[hide]
|
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
Nginx core module
This module is required.
| Name | Description |
|---|---|
| Core | Configure error logging, processes, permissions, epoll/kqueue/select/poll events, etc. |
Standard HTTP modules
These modules are automatically compiled in unless explicitly disabled with configure.
| Name | Description | Version | configure argument to disable |
|---|---|---|---|
| HTTP 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 requests from a client. | 0.7.20 | --without-http_limit_req_module |
| Limit Conn | Limit concurrent active 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) --without-http_upstream_least_conn_module (least_conn directive only) --without-http_upstream_keepalive_module (keepalive 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. |
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 | |
| Auth Request | Implements client authorization based on the result of a subrequest. | 1.5.4 | --with-http_auth_request_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 |
| Gunzip | On-the-fly decompressing of gzipped responses. | 1.3.6 | --with-http_gunzip_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 |
| SPDY | SPDY protocol support. | 1.3.15 | --with-http_spdy_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 |
Mail modules
| Name | Description | configure argument |
|---|---|---|
| Mail Core | Core parameters for mail module. | --with-mail |
| POP3 | POP3 settings. | --without-mail_pop3_module |
| IMAP | IMAP settings. | --without-mail_imap_module |
| SMTP | SMTP settings. | --without-mail_smtp_module |
| Auth HTTP | 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 |
Obsoleted articles
Most of the links above points to official up-to-date documentation provided by Nginx, Inc. For historical reasons there is a list of obsoleted wiki articles.
WARNING: these articles may contain outdated, incomplete or even incorrect information.
Please always refer to the official documentation avaiable at http://nginx.org.
Third party modules and Patches
Please see the catalog of 3rd party modules.
References
- Module index by example
- Configuration Notation Reference
- Module comparison matrix with other servers
- Feature Requests and bug reports
- Getting Started
- Configuration Cookbook
- Index of all Directives