Nginx Community - User contributions [en]

HttpRealipModule

2012-05-15T15:44:25Z

Admin: /* set_real_ip_from */

= Synopsis =
This module allows to change the client's IP address to value from request header (e. g. <code>X-Real-IP</code> or <code>X-Forwarded-For</code>).

It is useful if nginx works behind some proxy of L7 load balancer, and the request comes from a local IP, but proxy add request header with client's IP.

This module isn't built by default, enable it with the configure option
<pre>--with-http_realip_module</pre>

Example:
<geshi lang="nginx">
set_real_ip_from 192.168.1.0/24;
set_real_ip_from 192.168.2.1;
real_ip_header X-Real-IP;
</geshi>

= Directives =
== set_real_ip_from ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/set_real_ip_from.txt" />

== real_ip_header ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_header.txt" />

This directive sets the name of the header used for transferring the replacement IP address.

In case of X-Forwarded-For, this module uses the last ip in the X-Forwarded-For header for replacement.

== real_ip_recursive ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_recursive.txt" />

= References =
[http://nginx.org/en/docs/http/ngx_http_realip_module.html Original Documentation]

[http://trac.nginx.org/nginx/ticket/2 trac ticket #2]

HttpGeoipModule

2012-05-15T15:42:30Z

Admin: /* Directives */

= Synopsis =
This module creates ngx_http_geoip_module variables based on the IP-address of the client matched against the [http://www.maxmind.com/ MaxMind] GeoIP binary files. This module appeared in nginx version 0.7.63 and 0.8.6.

Precondition

This module needs the geo databases and the library to read from the database.

There are several options:

* Download the database yourself, e.g.:
<pre>
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
</pre>

* Install a package providing the database. For example in Debian the package is called '''geoip-database'''.
<pre>
aptitude install geoip-database
</pre>

* Install a port providing the database. For example in FreeBSD the port is called "GeoIP".
<pre>
cd /usr/ports/net/GeoIP
make install clean
</pre>

The FreeBSD port provides the GeoLite country database located at /usr/local/share/GeoIP/GeoIP.dat

Note that this is only the country database. You'll need to download the '''city''' database from Maxmind site:
<pre>
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
</pre>
To compile Nginx you'll need the library development files. In Debian they're in the package '''libgeoip-dev'''.
<pre>
aptitude install libgeoip-dev
</pre>
For systems where there's not a packaged version of the library you'll have to compile it from source:
<pre>
wget http://geolite.maxmind.com/download/geoip/api/c/GeoIP.tar.gz
</pre>
Follow the install instructions provided there.

Compile Nginx enabling Geo IP support:
<pre>
./configure --with-http_geoip_module
</pre>

You can check if your installed version of Nginx supports Geo IP with <code>nginx -V</code>. Watch for the <code> --with-http_geoip_module</code>. This means that Geo IP support is enabled.

Here'a a configuration example:
<geshi lang="nginx">
http {
geoip_country GeoIP.dat; # the country IP database
geoip_city GeoLiteCity.dat; # the city IP database
(...)
</geshi>

You can mimic Apache's mod_geoip functionality with PHP-FPM by adding the following fastcgi_param values:

(From [http://kbeezie.com/view/apache-mod_geoip-nginx/ Mimic Apache mod_geoip in Nginx])
<geshi lang="nginx">
fastcgi_param GEOIP_COUNTRY_CODE $geoip_country_code;
fastcgi_param GEOIP_COUNTRY_NAME $geoip_country_name;
</geshi>

= Directives =
== geoip_country ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_country.txt" />

This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country geolocation information. This allows you to get the country corresponding to the given IP. It can be used to determine the visitor's country from the IP address of the client. When set the following variables are available:

* $geoip_country_code — two-letter country code, for example, "RU", "US".
* $geoip_country_code3 — three-letter country code, for example, "RUS", "USA".
* $geoip_country_name — the (verbose) name of the country, for example, "Russian Federation", "United States", &c.

Nginx caches all supplied databases in memory. The country database is small, roughly 1.4M, therefore there's very little penalty in caching it. The city database is much bigger. Hence its memory footprint is larger.

== geoip_city ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_city.txt" />

This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country, city and region geolocation information. This allows you to get that information corresponding to the given IP. It can be used to determine the visitor's geolocation from the IP address of the client. When set the following variables are available:

* '''$geoip_city_country_code''' — two-letter country code, for example, "RU", "US".
* '''$geoip_city_country_code3''' — three-letter country code, for example, "RUS", "USA".
* '''$geoip_city_country_name''' — the name of the country, for example, "Russian Federation", "United States" — if available.
* '''$geoip_region''' — the name of region (province, region, state, province, federal land, and the like), for example, "Moscow City", "DC" — if available.
* '''$geoip_city''' — the name of the city, for example, "Moscow", "Washington", "Lisbon", &c — if available.
* '''$geoip_postal_code''' — zip code or postal code — if available.
* '''$geoip_city_continent_code''' — if available.
* '''$geoip_latitude''' — latitude — if available.
* '''$geoip_longitude''' — longitude — if available.
* '''$geoip_dma_code''' — DMA Code — if available.
* '''$geoip_area_code''' — Area Code — if available.

== geoip_proxy ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_proxy.txt" />

== geoip_proxy_recursive ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_proxy_recursive.txt" />

= References =
[http://nginx.org/en/docs/http/ngx_http_geoip_module.html Original Documentation]

HttpRealipModule

2012-05-15T15:40:05Z

Admin: /* Directives */

= Synopsis =
This module allows to change the client's IP address to value from request header (e. g. <code>X-Real-IP</code> or <code>X-Forwarded-For</code>).

It is useful if nginx works behind some proxy of L7 load balancer, and the request comes from a local IP, but proxy add request header with client's IP.

This module isn't built by default, enable it with the configure option
<pre>--with-http_realip_module</pre>

Example:
<geshi lang="nginx">
set_real_ip_from 192.168.1.0/24;
set_real_ip_from 192.168.2.1;
real_ip_header X-Real-IP;
</geshi>

= Directives =
== set_real_ip_from ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/set_real_ip_from.txt" />

This directive describes the trusted addresses, which transfer accurate address for the replacement. Since 0.8.22 Unix sockets can also be trusted.

== real_ip_header ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_header.txt" />

This directive sets the name of the header used for transferring the replacement IP address.

In case of X-Forwarded-For, this module uses the last ip in the X-Forwarded-For header for replacement.

== real_ip_recursive ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_recursive.txt" />

= References =
[http://nginx.org/en/docs/http/ngx_http_realip_module.html Original Documentation]

[http://trac.nginx.org/nginx/ticket/2 trac ticket #2]

HttpRealipModule

2012-05-15T15:39:49Z

Admin: /* real_ip_header */

= Synopsis =
This module allows to change the client's IP address to value from request header (e. g. <code>X-Real-IP</code> or <code>X-Forwarded-For</code>).

It is useful if nginx works behind some proxy of L7 load balancer, and the request comes from a local IP, but proxy add request header with client's IP.

This module isn't built by default, enable it with the configure option
<pre>--with-http_realip_module</pre>

Example:
<geshi lang="nginx">
set_real_ip_from 192.168.1.0/24;
set_real_ip_from 192.168.2.1;
real_ip_header X-Real-IP;
</geshi>

= Directives =
== set_real_ip_from ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/set_real_ip_from.txt" />

This directive describes the trusted addresses, which transfer accurate address for the replacement. Since 0.8.22 Unix sockets can also be trusted.

== real_ip_header ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_header.txt" />

This directive sets the name of the header used for transferring the replacement IP address.

In case of X-Forwarded-For, this module uses the last ip in the X-Forwarded-For header for replacement.

== real_ip_recursive ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_recursive.txt" />

= References =
[http://nginx.org/en/docs/http/ngx_http_realip_module.html Original Documentation]

[http://trac.nginx.org/nginx/ticket/2 trac ticket #2]

Install

2012-05-15T14:48:21Z

Admin: /* Development */

= After Installing =

The [[Configuration]] page will give you some help getting things going after you get Nginx installed and the [[Pitfalls]] page will help keep you from making mistakes that so many users before you did. These two pages give you the chance to learn from others mistakes and hard work.

= Binary Releases =

== Prebuilt Packages for Linux and BSD ==
Most Linux distributions and BSD variants have Nginx in the usual package repositories and they can be installed via whatever method is normally used to install software (apt-get on Debian, emerge on Gentoo, ports on FreeBSD, etc).

Be aware that these packages are often somewhat out-of-date. If you want the latest features and bugfixes, it's recommended to build from source or use packages directly from nginx.org.

= Official Red Hat/CentOS packages =

To add nginx yum repository, create a file named /etc/yum.repos.d/nginx.repo and paste one of the configurations below:

CentOS:
<pre>
[nginx]
name=nginx repo
baseurl=http://nginx.org/packages/centos/$releasever/$basearch/
gpgcheck=0
enabled=1
</pre>

RHEL:
<pre>
[nginx]
name=nginx repo
baseurl=http://nginx.org/packages/rhel/$releasever/$basearch/
gpgcheck=0
enabled=1
</pre>

Due to differences between how CentOS, RHEL, and Scientific Linux populate the $releasever variable, it is necessary to manually replace $releasever with either "5" (for 5.x) or "6" (for 6.x), depending upon your OS version.

= Official Debian/Ubuntu packages =
Append the appropriate stanza to /etc/apt/sources.list. The [[Pgp]] page explains the signing of the nginx.org released packaging.

Ubuntu 10.04:
<pre>
deb http://nginx.org/packages/ubuntu/ lucid nginx
deb-src http://nginx.org/packages/ubuntu/ lucid nginx
</pre>

Debian 6:
<pre>
deb http://nginx.org/packages/debian/ squeeze nginx
deb-src http://nginx.org/packages/debian/ squeeze nginx
</pre>

== Ubuntu PPA ==
This PPA is maintained by volunteers and is not distributed by nginx.org. It has some additional compiled-in modules and may be more fitting for your environment.

You can get the latest stable version of Nginx from the [https://launchpad.net/~nginx/+archive/development Nginx PPA] on Launchpad:
You will need to have root privileges to perform the following commands.

For Ubuntu 10.04 and newer:
<geshi lang="shell">
sudo -s
nginx=stable # use nginx=development for latest development version
add-apt-repository ppa:nginx/$nginx
apt-get update
apt-get install nginx
</geshi>

If you get an error about add-apt-repository not existing, you will want to install python-software-properties.
For other Debian/Ubuntu based distributions, you can try the lucid variant of the PPA which is the most likely to work on older package sets.

<geshi lang="shell">
sudo -s
nginx=stable # use nginx=development for latest development version
echo "deb http://ppa.launchpad.net/nginx/$nginx/ubuntu lucid main" > /etc/apt/sources.list.d/nginx-$nginx-lucid.list
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C300EE8C
apt-get update
apt-get install nginx
</geshi>

= Official Win32 Binaries =
As of {{Version_Development}}, Nginx is now available as an [http://www.nginx.org/download/nginx-1.2.0.zip official Windows binary].

The Windows version is provided as a binary-only due to the current build process (which currently uses some Wine tools). When the build process has been cleaned up, source will be made available. Igor does not want to support build issues with the current system.

Installation:
<geshi lang="shell">
cd c:\
unzip nginx-1.2.0.zip
ren nginx-1.2.0 nginx
cd nginx
start nginx
</geshi>

Control:
<geshi lang="shell">
nginx -s [ stop | quit | reopen | reload ]
</geshi>

For problems look in c:\nginx\logs\error.log or in EventLog.

In addition, Kevin Worthington maintains earlier [http://www.kevinworthington.com/nginx-for-windows/ Windows] builds of the development branch.

= Source Releases =
There are currently three versions of Nginx available: '''stable (1.0.x)''', '''development (1.1.x)''', and '''legacy (0.8.x)'''. The development branch gets new features and bugfixes sooner but might introduce new bugs as well. Once bugfixes are stabilized they are backported to the stable branch. New features may or may not be backported.

In general, the stable release is recommended, but the development release is typically quite stable as well. See the [[Faq#Is_it_safe_to_use_the_development_branch_in_production.3F|FAQ]].

<br style="clear: both;" />

<ul class="content-download-container">

<li class="content-download-item">
<div class="content-download-link">
== Stable ==
[http://nginx.org/download/nginx-1.2.0.tar.gz Nginx 1.2.0]<br />
April 23, 2012<br />
[http://nginx.org/en/CHANGES changelog]
</div>
</li>

<li class="content-download-item">
<div class="content-download-link">

== Development ==
[http://nginx.org/download/nginx-1.3.0.tar.gz Nginx 1.3.0]<br />
May 15, 2012<br />
[http://nginx.org/en/CHANGES changelog]
</div>
</li>

<li class="content-download-item">
<div class="content-download-link">

== Subversion ==
[svn://svn.nginx.org/nginx svn.nginx.org/nginx]<br />
Includes experimental features and bugfixes<br />
</div>
</li>

</ul>

<br style="clear: both;" />

Older versions can be found [http://sysoev.ru/nginx/download.html here].

== Building Nginx From Source ==

After extracting the source, run these commands from a terminal:

<pre>
./configure
make
sudo make install
</pre>

By default, Nginx will be installed in /usr/local/nginx. You may change this and other options with the [[InstallOptions| compile-time options]].

You might also want to peruse the [[Nginx3rdPartyModules|catalog of third-party modules]], since these must be built at compile-time.

== Other Systems ==

This is a list of other community maintained pages explaining other installations. Please note, that these pages are not thoroughly, if at all, reviewed for accuracy as they are on this page.

[[Installing_on_Solaris_10_u5| Solaris 10u5]]

[[Installing_on_Solaris_11| Solaris 11]]

= References =
[http://sysoev.ru/nginx/docs/install.html Original Documentation]

CliffWells

2012-05-14T17:00:23Z

Admin: /* Cliff Wells */

== Cliff Wells ==

{{#gravatar: email_p1=cliff|email_p2=develix.com|size=40}}

Contact:
*[mailto:cliff@nginx.org cliff@nginx.org]
*[mailto:cliff@develix.com cliff@develix.com]
*[mailto:cliff@twisty-industries.com cliff@twisty-industries.com]

* [http://www.enemyofthestatement.com/ My blog]

Python programmer, Io hacker, web hoster, and one more random jerk on IRC (cwells on freenode).

Current projects:
* [http://github.com/cwells cwells on github]
* [http://breve.twisty-industries.com/ Breve - A Python template engine]
* [http://www.develix.com/ Develix - Web hosting for developers]
* This wiki and general Nginx evangelism

[https://www.ohloh.net/accounts/17418?ref=Detailed https://www.ohloh.net/accounts/17418/widgets/account_detailed.gif]

HttpLimitReqModule

2012-05-11T07:54:46Z

Admin: /* Directives */

= Synopsis =

This module allows you to limit the number of requests for a given session, or as a special case, with one address.

Restriction done using leaky bucket.

= Example Configuration =

<geshi lang="nginx">
http {
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

...

server {

...

location /search/ {
limit_req zone=one burst=5;
}
</geshi>

= Directives =
== limit_req ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />

The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.

For example, the directive

<geshi lang="nginx">
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
location /search/ {
limit_req zone=one burst=5;
}

</geshi>

allows a user no more than 1 request per second on average, with bursts of no more than 5 requests.

If delaying excess requests within a burst is not necessary, you should use the option '''nodelay''':

<pre>
limit_req zone=one burst=5 nodelay;
</pre>

== limit_req_log_level ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_log_level.txt" />

Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".

== limit_req_zone ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />

The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

<pre>
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;
</pre>

In this case, the session state is allocated 10MB as a zone called "one", and the average speed of queries for this zone is limited to 1 request per second.

The sessions are tracked per-user in this case, but note that instead of the variable $remote_addr, we've used the variable $binary_remote_addr, reducing the size of the state to 64 bytes. A 1 MB zone can hold approximately 16000 states of this size.

The speed is set in requests per second or requests per minute. The rate must be an integer, so if you need to specify less than one request per second, say, one request every two seconds, you would specify it as "30r/m".

= References =

[http://nginx.org/en/docs/http/ngx_http_limit_req_module.html Original Documentation]

HttpLimitReqModule

2012-05-11T07:54:15Z

Admin: /* limit_req_zone */

= Synopsis =

This module allows you to limit the number of requests for a given session, or as a special case, with one address.

Restriction done using leaky bucket.

= Example Configuration =

<geshi lang="nginx">
http {
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

...

server {

...

location /search/ {
limit_req zone=one burst=5;
}
</geshi>

= Directives =

== limit_req_log_level ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_log_level.txt" />

Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".

== limit_req_zone ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />

The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

<pre>
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;
</pre>

In this case, the session state is allocated 10MB as a zone called "one", and the average speed of queries for this zone is limited to 1 request per second.

The sessions are tracked per-user in this case, but note that instead of the variable $remote_addr, we've used the variable $binary_remote_addr, reducing the size of the state to 64 bytes. A 1 MB zone can hold approximately 16000 states of this size.

The speed is set in requests per second or requests per minute. The rate must be an integer, so if you need to specify less than one request per second, say, one request every two seconds, you would specify it as "30r/m".

== limit_req ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />

The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.

For example, the directive

<geshi lang="nginx">
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
location /search/ {
limit_req zone=one burst=5;
}

</geshi>

allows a user no more than 1 request per second on average, with bursts of no more than 5 requests.

If delaying excess requests within a burst is not necessary, you should use the option '''nodelay''':

<pre>
limit_req zone=one burst=5 nodelay;
</pre>

= References =

[http://nginx.org/en/docs/http/ngx_http_limit_req_module.html Original Documentation]

HttpLimitReqModule

2012-05-11T07:53:59Z

Admin: /* limit_req */

= Synopsis =

This module allows you to limit the number of requests for a given session, or as a special case, with one address.

Restriction done using leaky bucket.

= Example Configuration =

<geshi lang="nginx">
http {
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

...

server {

...

location /search/ {
limit_req zone=one burst=5;
}
</geshi>

= Directives =

== limit_req_log_level ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_log_level.txt" />

Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".

== limit_req_zone ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />

The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

<pre>
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;
</pre>

In this case, the session state is allocated 10MB as a zone called "one", and the average speed of queries for this zone is limited to 1 request per second.

The sessions are tracked per-user in this case, but note that instead of the variable $remote_addr, we've used the variable $binary_remote_addr, reducing the size of the state to 64 bytes. A 1 MB zone can hold approximately 16000 states of this size.

The speed is set in requests per second or requests per minute. The rate must be an integer, so if you need to specify less than one request per second, say, one request every two seconds, you would specify it as "30r/m".

== limit_req_zone ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />

The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.

For example, the directive

<geshi lang="nginx">
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
location /search/ {
limit_req zone=one burst=5;
}

</geshi>

allows a user no more than 1 request per second on average, with bursts of no more than 5 requests.

If delaying excess requests within a burst is not necessary, you should use the option '''nodelay''':

<pre>
limit_req zone=one burst=5 nodelay;
</pre>

= References =

[http://nginx.org/en/docs/http/ngx_http_limit_req_module.html Original Documentation]

HttpLimitReqModule

2012-05-11T07:52:58Z

Admin: /* limit_req_zone */

= Synopsis =

This module allows you to limit the number of requests for a given session, or as a special case, with one address.

Restriction done using leaky bucket.

= Example Configuration =

<geshi lang="nginx">
http {
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

...

server {

...

location /search/ {
limit_req zone=one burst=5;
}
</geshi>

= Directives =

== limit_req_log_level ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_log_level.txt" />

Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".

== limit_req ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />

The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

<pre>
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;
</pre>

In this case, the session state is allocated 10MB as a zone called "one", and the average speed of queries for this zone is limited to 1 request per second.

The sessions are tracked per-user in this case, but note that instead of the variable $remote_addr, we've used the variable $binary_remote_addr, reducing the size of the state to 64 bytes. A 1 MB zone can hold approximately 16000 states of this size.

The speed is set in requests per second or requests per minute. The rate must be an integer, so if you need to specify less than one request per second, say, one request every two seconds, you would specify it as "30r/m".

== limit_req_zone ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />

The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.

For example, the directive

<geshi lang="nginx">
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
location /search/ {
limit_req zone=one burst=5;
}

</geshi>

allows a user no more than 1 request per second on average, with bursts of no more than 5 requests.

If delaying excess requests within a burst is not necessary, you should use the option '''nodelay''':

<pre>
limit_req zone=one burst=5 nodelay;
</pre>

= References =

[http://nginx.org/en/docs/http/ngx_http_limit_req_module.html Original Documentation]

User talk:LanfrancoMancini

2012-05-03T09:03:29Z

Admin: Created page with "This feels too much like spam. Once you become an actual contributor, I'm more likely to allow such links (or if the business were even remotely Nginx-related somehow)."

This feels too much like spam. Once you become an actual contributor, I'm more likely to allow such links (or if the business were even remotely Nginx-related somehow).

User:LanfrancoMancini

2012-05-03T09:02:09Z

Admin:

Lanfranco Mancini is a writer/blogger working as a marketing specialist for an NY-based IT consulting firm based offering IT solutions for businesses such as managed IT services and tech support services.

Modules

2012-05-03T00:34:26Z

Admin: /* References */

= 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 <code>./configure --help</code>

= Nginx core modules =
These modules are required.

{| class="modules-index-table"
! Name !! Description
|-
| [[CoreModule|Main]]
| Configure error logging, processes, permissions, etc.
|-
| [[EventsModule|Events]]
| Configure epoll, kqueue, select, poll, etc.
|-
|}

= Standard HTTP modules =
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to disable
|-
| [[HttpCoreModule|Core]]
| Control ports, locations, error pages, aliases, and other essentials.
|
| --without-http
|-
| [[HttpAccessModule|Access]]
| Allow/deny based on IP address.
|
| --without-http_access_module
|-
| [[HttpAuthBasicModule|Auth Basic]]
| Basic HTTP authentication.
|
| --without-http_auth_basic_module
|-
| [[HttpAutoindexModule|Auto Index]]
| Generates automatic directory listings.
|
| --without-http_autoindex_module
|-
| [[HttpBrowserModule|Browser]]
| Interpret "User-Agent" string.
|
| --without-http_browser_module
|-
| [[HttpCharsetModule|Charset]]
| Recode web pages.
|
| --without-http_charset_module
|-
| [[HttpEmptyGifModule|Empty GIF]]
| Serve a 1x1 image from memory.
|
| --without-http_empty_gif_module
|-
| [[HttpFastcgiModule|FastCGI]]
| FastCGI Support.
|
| --without-http_fastcgi_module
|-
| [[HttpGeoModule|Geo]]
| Set config variables using key/value pairs of IP addresses.
|
| --without-http_geo_module
|-
| [[HttpGzipModule|Gzip]]
| Gzip responses.
|
| --without-http_gzip_module
|-
| [[HttpHeadersModule|Headers]]
| Set arbitrary HTTP response headers.
|
|-
| [[HttpIndexModule|Index]]
| Controls which files are to be used as index.
|
|-
| [[HttpLimitReqModule|Limit Requests]]
| Limit frequency of connections from a client.
| 0.7.20
| --without-http_limit_req_module
|-
| [[HttpLimitZoneModule|Limit Zone]]
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
|
| --without-http_limit_zone_module
|-
| [[HttpLimitConnModule|Limit Conn]]
| Limit concurrent connections based on a variable.
|
| --without-http_limit_conn_module
|-
| [[HttpLogModule|Log]]
| Customize access logs.
|
|-
| [[HttpMapModule|Map]]
| Set config variables using arbitrary key/value pairs.
|
| --without-http_map_module
|-
| [[HttpMemcachedModule|Memcached]]
| Memcached support.
|
| --without-http_memcached_module
|-
| [[HttpProxyModule|Proxy]]
| Proxy to upstream servers.
|
| --without-http_proxy_module
|-
| [[HttpRefererModule|Referer]]
| Filter requests based on <code>Referer</code> header.
|
| --without-http_referer_module
|-
| [[HttpRewriteModule|Rewrite]]
| Request rewriting using regular expressions.
|
| --without-http_rewrite_module
|-
| [[HttpScgiModule|SCGI]]
| SCGI protocol support.
| 0.8.42
| --without-http_scgi_module
|-
| [[HttpSplitClientsModule|Split Clients]]
| Splits clients based on some conditions
| 0.8.37
| --without-http_split_clients_module
|-
| [[HttpSsiModule|SSI]]
| Server-side includes.
|
| --without-http_ssi_module
|-
| [[HttpUpstreamModule|Upstream]]
| For load-balancing.
|
| --without-http_upstream_ip_hash_module (ip_hash directive only)
|-
| [[HttpUseridModule|User ID]]
| Issue identifying cookies.
|
| --without-http_userid_module
|-
| [[HttpUwsgiModule|uWSGI]]
| uWSGI protocol support.
| 0.8.40
| --without-http_uwsgi_module
|-
| [[X-accel|X-Accel]]
| X-Sendfile-like module.
|
|
|}

= Optional HTTP modules =
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to enable
|-
| [[HttpAdditionModule|Addition]]
| Append text to pages.
|
| --with-http_addition_module
|-
| [[HttpDegradationModule|Degradation]]
| Allow to return 204 or 444 code for some locations on low memory condition.
| 0.8.25
| --with-http_degradation_module
|-
| [[HttpPerlModule|Embedded Perl]]
| Use Perl in Nginx config files.
|
| --with-http_perl_module
|-
| [[HttpFlvModule|FLV]]
| Flash Streaming Video
|
| --with-http_flv_module
|-
| [[HttpGeoipModule|GeoIP]]
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
| 0.8.6, 0.7.63
| --with-http_geoip_module
|-
| [[GooglePerftoolsModule|Google Perftools]]
| Google Performance Tools support.
| 0.6.29
| --with-google_perftools_module
|-
| [[HttpGzipStaticModule|Gzip Precompression]]
| Serves precompressed versions of static files.
| 0.6.23
| --with-http_gzip_static_module
|-
| [[HttpImageFilterModule|Image Filter]]
| Transform images with Libgd
| 0.7.54
| --with-http_image_filter_module
|-
| [[HttpMp4Module|MP4]]
| Enables mp4 streaming with seeking ability.
| 1.1.3, 1.0.7
| --with-http_mp4_module
|-
| [[HttpRandomIndexModule|Random Index]]
| Randomize directory indexes.
| 0.7.15
| --with-http_random_index_module
|-
| [[HttpRealipModule|Real IP]]
| For using nginx as backend
|
| --with-http_realip_module
|-
| [[HttpSecureLinkModule|Secure Link]]
| Protect pages with a secret key.
| 0.7.18
| --with-http_secure_link_module
|-
| [[HttpSslModule|SSL]]
| HTTPS/SSL support.
|
| --with-http_ssl_module
|-
| [[HttpStubStatusModule|Stub Status]]
| View server statistics.
|
| --with-http_stub_status_module
|-
| [[HttpSubModule|Substitution]]
| Replace text in pages
|
| --with-http_sub_module
|-
| [[HttpDavModule|WebDAV]]
| WebDAV pass-through support.
|
| --with-http_dav_module
|-
| [[HttpXsltModule|XSLT]]
| Post-process pages with XSLT.
| 0.7.8
| --with-http_xslt_module
|}

= Mail modules =
{| class="modules-index-table"
! Name
! Description
! configure argument
|-
| [[MailCoreModule|Core]]
| Nginx is able to handle and proxy the IMAP, POP3, SMTP protocols.
| --with-mail<br>--without-mail_pop3_module<br>--without-mail_imap_module<br>--without-mail_smtp_module
|-
| [[MailAuthModule|Auth]]
| Use Nginx to authenticate mail services.
|-
| [[MailProxyModule|Proxy]]
| Nginx can proxy IMAP, POP3, and SMTP protocols.
|-
| [[MailSslModule|SSL]]
| This module ensures SSL/TLS support for POP3/IMAP/SMTP.
| --with-mail_ssl_module
|}

= Third party modules and Patches =
Please see the catalog of [[3rdPartyModules|3rd party modules]].

= References =
* [[ModulesByExample|Module index by example]]
* [[ConfigNotation| Configuration Notation Reference]]
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
* [http://trac.nginx.org/nginx Feature Requests and bug reports]
* [[GettingStarted| Getting Started]]
* [[Configuration| Configuration Cookbook]]
* [[DirectiveIndex| Index of all Directives]]

ModuleComparisonMatrix

2012-05-03T00:32:50Z

Admin:

= Module comparison matrix =

Looking for Nginx's mod_rewrite or mod_perl? The following table attempts to summarize modules for Nginx that are comparable to modules available for other web servers.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpUpstreamModule| HTTP Upstream Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_proxy_balancer.html mod_proxy_balancer] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core]
|-
| [[NginxHttpAccessModule| Access Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_access.html mod_access] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccess mod_access]
|-
| [[NginxHttpAuthBasicModule| Auth Basic Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_auth.html mod_auth] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAuth mod_auth]
|-
| [[NginxHttpAutoindexModule| AutoIndex Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html mod_autoindex] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModDirlisting mod_dirlisting]
|-
| [[NginxHttpBrowserModule| Browser Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpCharsetModule| Charset Module]] || ''none'' || ''none''
|-
| [[NginxHttpEmptyGifModule| Empty GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpFcgiModule| FastCGI Module]] || [http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html mod_fastcgi] , [http://fastcgi.coremail.cn/ mod_fcgid] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFastCGI mod_fastcgi]
|-
| [[NginxHttpGeoModule| GEO Module]] || [http://www.maxmind.com/app/mod_geoip mod_geoip] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModGeoip mod_geoip]
|-
| [[NginxHttpGzipModule| Gzip Compression Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_deflate.html mod_deflate] || [http://trac.lighttpd.net/trac/wiki/Mod_Deflate mod_deflate]
|-
| [[NginxHttpGzipStaticModule| Gzip Pre-Compression Module]] || ''none'' || ''none''
|-
| [[NginxHttpHeadersModule| HTTP Headers Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_headers.html mod_headers] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSetEnv mod_setenv]
|-
| [[NginxHttpRefererModule| HTTP Referer Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpLimitZoneModule| Limit Zone Module]] || [http://dominia.org/djao/limitipconn2.html mod_limitipconn] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModEvasive mod_evasive]
|-
| [[NginxHttpLogModule| Log Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_log_config.html mod_log_config] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccessLog mod_accesslog]
|-
| [[NginxHttpMapModule| Map Module]] || ? || ?
|-
| [[NginxHttpMemcachedModule| Memcached Module]] || ''none'' || ''none''
|-
| [[NginxHttpProxyModule| Proxy Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_proxy.html mod_proxy] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpRewriteModule| Rewrite Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html mod_rewrite] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRewrite mod_rewrite]
|-
| [[NginxHttpSsiModule| SSI Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_include.html mod_include] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSSI mod_ssi]
|-
| [[NginxHttpUserIdModule| UserID Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_usertrack.html mod_usertrack] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModUserTrack mod_usertrack]
|-
| [[NginxHttpAdditionModule| Addition Module]] || [http://tangent.org/index.pl?lastnode_id=478&node_id=362 mod_layout] || ?
|-
| [[NginxEmbeddedPerlModule| Embedded Perl Module]] || [http://perl.apache.org/ mod_perl] || ''none''
|-
| [[NginxHttpFlvStreamModule| FLV Module]] || [http://journal.paul.querna.org/articles/2006/07/11/mod_flvx mod_flvx] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFLVStreaming mod_flv_streaming]
|-
| [[NginxHttpRealIpModule| Real IP Module]] || [http://stderr.net/apache/rpaf/ mod_rpaf] || [http://trac.lighttpd.net/trac/wiki/Docs/ModExtForward mod_extforward]
|-
| [[NginxHttpSslModule| SSL Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_ssl.html mod_ssl] || [http://trac.lighttpd.net/trac/wiki/Docs%3ASSL SSL]
|-
| [[NginxHttpStubStatusModule| Stub Status Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_status.html mod_status] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModStatus mod_status]
|-
| [[NginxHttpSubModule| Substitution Module]] || [http://apache.webthing.com/mod_line_edit/ mod_line_edit] || ?
|-
| [[NginxHttpDavModule| WebDAV Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_dav.html mod_dav] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModWebDAV mod_webdav]
|-
| [[NginxUserDir| UserDir Equivalent]] || [http://httpd.apache.org/docs/2.0/mod/mod_userdir.html mod_userdir] || [http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs#mod_userdir mod_userdir]
|-
|}

ModuleComparisonMatrix

2012-05-03T00:32:12Z

Admin: /* Module comparison matrix */

= Module comparison matrix =

Looking for Nginx's mod_rewrite or mod_perl? The following table attempts to summarize modules for Nginx that are comparable to modules available for other web servers.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpUpstreamModule| HTTP Upstream Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_proxy_balancer.html mod_proxy_balancer] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core]
|-
| [[NginxHttpAccessModule| Access Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_access.html mod_access] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccess mod_access]
|-
| [[NginxHttpAuthBasicModule| Auth Basic Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_auth.html mod_auth] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAuth mod_auth]
|-
| [[NginxHttpAutoindexModule| AutoIndex Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html mod_autoindex] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModDirlisting mod_dirlisting]
|-
| [[NginxHttpBrowserModule| Browser Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpCharsetModule| Charset Module]] || ''none'' || ''none''
|-
| [[NginxHttpEmptyGifModule| Empty GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpFcgiModule| FastCGI Module]] || [http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html mod_fastcgi] , [http://fastcgi.coremail.cn/ mod_fcgid] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFastCGI mod_fastcgi]
|-
| [[NginxHttpGeoModule| GEO Module]] || [http://www.maxmind.com/app/mod_geoip mod_geoip] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModGeoip mod_geoip]
|-
| [[NginxHttpGzipModule| Gzip Compression Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_deflate.html mod_deflate] || [http://trac.lighttpd.net/trac/wiki/Mod_Deflate mod_deflate]
|-
| [[NginxHttpGzipStaticModule| Gzip Pre-Compression Module]] || ''none'' || ''none''
|-
| [[NginxHttpHeadersModule| HTTP Headers Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_headers.html mod_headers] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSetEnv mod_setenv]
|-
| [[NginxHttpRefererModule| HTTP Referer Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpLimitZoneModule| Limit Zone Module]] || [http://dominia.org/djao/limitipconn2.html mod_limitipconn] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModEvasive mod_evasive]
|-
| [[NginxHttpLogModule| Log Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_log_config.html mod_log_config] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccessLog mod_accesslog]
|-
| [[NginxHttpMapModule| Map Module]] || ? || ?
|-
| [[NginxHttpMemcachedModule| Memcached Module]] || ''none'' || ''none''
|-
| [[NginxHttpProxyModule| Proxy Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_proxy.html mod_proxy] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpRewriteModule| Rewrite Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html mod_rewrite] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRewrite mod_rewrite]
|-
| [[NginxHttpSsiModule| SSI Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_include.html mod_include] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSSI mod_ssi]
|-
| [[NginxHttpUserIdModule| UserID Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_usertrack.html mod_usertrack] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModUserTrack mod_usertrack]
|-
| [[NginxHttpAdditionModule| Addition Module]] || [http://tangent.org/index.pl?lastnode_id=478&node_id=362 mod_layout] || ?
|-
| [[NginxEmbeddedPerlModule| Embedded Perl Module]] || [http://perl.apache.org/ mod_perl] || ''none''
|-
| [[NginxHttpFlvStreamModule| FLV Module]] || [http://journal.paul.querna.org/articles/2006/07/11/mod_flvx mod_flvx] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFLVStreaming mod_flv_streaming]
|-
| [[NginxHttpRealIpModule| Real IP Module]] || [http://stderr.net/apache/rpaf/ mod_rpaf] || [http://trac.lighttpd.net/trac/wiki/Docs/ModExtForward mod_extforward]
|-
| [[NginxHttpSslModule| SSL Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_ssl.html mod_ssl] || [http://trac.lighttpd.net/trac/wiki/Docs%3ASSL SSL]
|-
| [[NginxHttpStubStatusModule| Stub Status Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_status.html mod_status] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModStatus mod_status]
|-
| [[NginxHttpSubModule| Substitution Module]] || [http://apache.webthing.com/mod_line_edit/ mod_line_edit] || ?
|-
| [[NginxHttpDavModule| WebDAV Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_dav.html mod_dav] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModWebDAV mod_webdav]
|-
| [[NginxUserDir| UserDir Equivalent]] || [http://httpd.apache.org/docs/2.0/mod/mod_userdir.html mod_userdir] || [http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs#mod_userdir mod_userdir]
|-
|}

== Third-Party Nginx modules ==

The following Nginx modules are not distributed with the Nginx source.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpCircleGifModule| Circle GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpUpstreamRequestHashModule| Upstream Hash Module]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [http://xph.us/software/nginx-notice/ Notice Module] || ||
|-
| [[NginxNgxZip| ngx_zip]] || ''none'' || ''none''
|-
| [[NginxNgx_rrd_graph| ngx_rrd_graph]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRRDTool mod_rrdtool]
|-
| [[NginxNgxSCGIModule| SCGI Module]] || [http://quixote.python.ca/scgi.dev/ ?] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSCGI mod_scgi]
|-
| [[NginxHttpUploadProgressModule| Upload Progress Module]] || ? || [http://trac.lighttpd.net/trac/wiki/Docs:ModUploadProgress mod_uploadprogress]
|-
| [[NginxNgxWSGIModule| WSGI Module]] || [http://code.google.com/p/modwsgi/ mod_wsgi] || ?
|}

== Requested Nginx modules ==

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| ''none'' || [http://httpd.apache.org/docs/2.0/mod/mod_mem_cache.html mod_mem_cache] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMemCache mod_mem_cache]
|-
| ''none'' || [http://www.backhand.org/mod_backhand/ mod_backhand] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpSecureDownload| Secure Download Module]] || [http://www.synd.info/downloads/releases/ mod_auth_token] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSecDownload mod_secdownload]
|-
| ''none'' || [http://www.modsecurity.org/ mod_security] || ?
|-
| ''none'' || ? || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMySQLVhost mod_mysql_vhost]
|-
| ''none'' || [http://httpd.apache.org/docs/2.1/mod/mod_proxy_ajp.html mod_proxy_ajp] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core (mod_proxy_backend_ajp13)]

ModuleComparisonMatrix

2012-05-03T00:31:40Z

Admin: /* Requested Nginx modules */

== Module comparison matrix ==

Looking for Nginx's mod_rewrite or mod_perl? The following table attempts to summarize modules for Nginx that are comparable to modules available for other web servers.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpUpstreamModule| HTTP Upstream Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_proxy_balancer.html mod_proxy_balancer] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core]
|-
| [[NginxHttpAccessModule| Access Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_access.html mod_access] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccess mod_access]
|-
| [[NginxHttpAuthBasicModule| Auth Basic Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_auth.html mod_auth] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAuth mod_auth]
|-
| [[NginxHttpAutoindexModule| AutoIndex Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html mod_autoindex] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModDirlisting mod_dirlisting]
|-
| [[NginxHttpBrowserModule| Browser Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpCharsetModule| Charset Module]] || ''none'' || ''none''
|-
| [[NginxHttpEmptyGifModule| Empty GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpFcgiModule| FastCGI Module]] || [http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html mod_fastcgi] , [http://fastcgi.coremail.cn/ mod_fcgid] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFastCGI mod_fastcgi]
|-
| [[NginxHttpGeoModule| GEO Module]] || [http://www.maxmind.com/app/mod_geoip mod_geoip] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModGeoip mod_geoip]
|-
| [[NginxHttpGzipModule| Gzip Compression Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_deflate.html mod_deflate] || [http://trac.lighttpd.net/trac/wiki/Mod_Deflate mod_deflate]
|-
| [[NginxHttpGzipStaticModule| Gzip Pre-Compression Module]] || ''none'' || ''none''
|-
| [[NginxHttpHeadersModule| HTTP Headers Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_headers.html mod_headers] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSetEnv mod_setenv]
|-
| [[NginxHttpRefererModule| HTTP Referer Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpLimitZoneModule| Limit Zone Module]] || [http://dominia.org/djao/limitipconn2.html mod_limitipconn] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModEvasive mod_evasive]
|-
| [[NginxHttpLogModule| Log Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_log_config.html mod_log_config] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccessLog mod_accesslog]
|-
| [[NginxHttpMapModule| Map Module]] || ? || ?
|-
| [[NginxHttpMemcachedModule| Memcached Module]] || ''none'' || ''none''
|-
| [[NginxHttpProxyModule| Proxy Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_proxy.html mod_proxy] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpRewriteModule| Rewrite Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html mod_rewrite] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRewrite mod_rewrite]
|-
| [[NginxHttpSsiModule| SSI Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_include.html mod_include] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSSI mod_ssi]
|-
| [[NginxHttpUserIdModule| UserID Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_usertrack.html mod_usertrack] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModUserTrack mod_usertrack]
|-
| [[NginxHttpAdditionModule| Addition Module]] || [http://tangent.org/index.pl?lastnode_id=478&node_id=362 mod_layout] || ?
|-
| [[NginxEmbeddedPerlModule| Embedded Perl Module]] || [http://perl.apache.org/ mod_perl] || ''none''
|-
| [[NginxHttpFlvStreamModule| FLV Module]] || [http://journal.paul.querna.org/articles/2006/07/11/mod_flvx mod_flvx] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFLVStreaming mod_flv_streaming]
|-
| [[NginxHttpRealIpModule| Real IP Module]] || [http://stderr.net/apache/rpaf/ mod_rpaf] || [http://trac.lighttpd.net/trac/wiki/Docs/ModExtForward mod_extforward]
|-
| [[NginxHttpSslModule| SSL Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_ssl.html mod_ssl] || [http://trac.lighttpd.net/trac/wiki/Docs%3ASSL SSL]
|-
| [[NginxHttpStubStatusModule| Stub Status Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_status.html mod_status] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModStatus mod_status]
|-
| [[NginxHttpSubModule| Substitution Module]] || [http://apache.webthing.com/mod_line_edit/ mod_line_edit] || ?
|-
| [[NginxHttpDavModule| WebDAV Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_dav.html mod_dav] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModWebDAV mod_webdav]
|-
| [[NginxUserDir| UserDir Equivalent]] || [http://httpd.apache.org/docs/2.0/mod/mod_userdir.html mod_userdir] || [http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs#mod_userdir mod_userdir]
|-
|}

== Third-Party Nginx modules ==

The following Nginx modules are not distributed with the Nginx source.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpCircleGifModule| Circle GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpUpstreamRequestHashModule| Upstream Hash Module]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [http://xph.us/software/nginx-notice/ Notice Module] || ||
|-
| [[NginxNgxZip| ngx_zip]] || ''none'' || ''none''
|-
| [[NginxNgx_rrd_graph| ngx_rrd_graph]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRRDTool mod_rrdtool]
|-
| [[NginxNgxSCGIModule| SCGI Module]] || [http://quixote.python.ca/scgi.dev/ ?] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSCGI mod_scgi]
|-
| [[NginxHttpUploadProgressModule| Upload Progress Module]] || ? || [http://trac.lighttpd.net/trac/wiki/Docs:ModUploadProgress mod_uploadprogress]
|-
| [[NginxNgxWSGIModule| WSGI Module]] || [http://code.google.com/p/modwsgi/ mod_wsgi] || ?
|}

== Requested Nginx modules ==

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| ''none'' || [http://httpd.apache.org/docs/2.0/mod/mod_mem_cache.html mod_mem_cache] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMemCache mod_mem_cache]
|-
| ''none'' || [http://www.backhand.org/mod_backhand/ mod_backhand] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpSecureDownload| Secure Download Module]] || [http://www.synd.info/downloads/releases/ mod_auth_token] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSecDownload mod_secdownload]
|-
| ''none'' || [http://www.modsecurity.org/ mod_security] || ?
|-
| ''none'' || ? || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMySQLVhost mod_mysql_vhost]
|-
| ''none'' || [http://httpd.apache.org/docs/2.1/mod/mod_proxy_ajp.html mod_proxy_ajp] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core (mod_proxy_backend_ajp13)]

ModuleComparisonMatrix

2012-05-03T00:31:26Z

Admin: /* Third-Party Nginx modules */

== Module comparison matrix ==

Looking for Nginx's mod_rewrite or mod_perl? The following table attempts to summarize modules for Nginx that are comparable to modules available for other web servers.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpUpstreamModule| HTTP Upstream Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_proxy_balancer.html mod_proxy_balancer] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core]
|-
| [[NginxHttpAccessModule| Access Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_access.html mod_access] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccess mod_access]
|-
| [[NginxHttpAuthBasicModule| Auth Basic Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_auth.html mod_auth] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAuth mod_auth]
|-
| [[NginxHttpAutoindexModule| AutoIndex Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html mod_autoindex] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModDirlisting mod_dirlisting]
|-
| [[NginxHttpBrowserModule| Browser Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpCharsetModule| Charset Module]] || ''none'' || ''none''
|-
| [[NginxHttpEmptyGifModule| Empty GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpFcgiModule| FastCGI Module]] || [http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html mod_fastcgi] , [http://fastcgi.coremail.cn/ mod_fcgid] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFastCGI mod_fastcgi]
|-
| [[NginxHttpGeoModule| GEO Module]] || [http://www.maxmind.com/app/mod_geoip mod_geoip] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModGeoip mod_geoip]
|-
| [[NginxHttpGzipModule| Gzip Compression Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_deflate.html mod_deflate] || [http://trac.lighttpd.net/trac/wiki/Mod_Deflate mod_deflate]
|-
| [[NginxHttpGzipStaticModule| Gzip Pre-Compression Module]] || ''none'' || ''none''
|-
| [[NginxHttpHeadersModule| HTTP Headers Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_headers.html mod_headers] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSetEnv mod_setenv]
|-
| [[NginxHttpRefererModule| HTTP Referer Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpLimitZoneModule| Limit Zone Module]] || [http://dominia.org/djao/limitipconn2.html mod_limitipconn] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModEvasive mod_evasive]
|-
| [[NginxHttpLogModule| Log Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_log_config.html mod_log_config] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccessLog mod_accesslog]
|-
| [[NginxHttpMapModule| Map Module]] || ? || ?
|-
| [[NginxHttpMemcachedModule| Memcached Module]] || ''none'' || ''none''
|-
| [[NginxHttpProxyModule| Proxy Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_proxy.html mod_proxy] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpRewriteModule| Rewrite Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html mod_rewrite] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRewrite mod_rewrite]
|-
| [[NginxHttpSsiModule| SSI Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_include.html mod_include] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSSI mod_ssi]
|-
| [[NginxHttpUserIdModule| UserID Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_usertrack.html mod_usertrack] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModUserTrack mod_usertrack]
|-
| [[NginxHttpAdditionModule| Addition Module]] || [http://tangent.org/index.pl?lastnode_id=478&node_id=362 mod_layout] || ?
|-
| [[NginxEmbeddedPerlModule| Embedded Perl Module]] || [http://perl.apache.org/ mod_perl] || ''none''
|-
| [[NginxHttpFlvStreamModule| FLV Module]] || [http://journal.paul.querna.org/articles/2006/07/11/mod_flvx mod_flvx] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFLVStreaming mod_flv_streaming]
|-
| [[NginxHttpRealIpModule| Real IP Module]] || [http://stderr.net/apache/rpaf/ mod_rpaf] || [http://trac.lighttpd.net/trac/wiki/Docs/ModExtForward mod_extforward]
|-
| [[NginxHttpSslModule| SSL Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_ssl.html mod_ssl] || [http://trac.lighttpd.net/trac/wiki/Docs%3ASSL SSL]
|-
| [[NginxHttpStubStatusModule| Stub Status Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_status.html mod_status] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModStatus mod_status]
|-
| [[NginxHttpSubModule| Substitution Module]] || [http://apache.webthing.com/mod_line_edit/ mod_line_edit] || ?
|-
| [[NginxHttpDavModule| WebDAV Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_dav.html mod_dav] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModWebDAV mod_webdav]
|-
| [[NginxUserDir| UserDir Equivalent]] || [http://httpd.apache.org/docs/2.0/mod/mod_userdir.html mod_userdir] || [http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs#mod_userdir mod_userdir]
|-
|}

== Third-Party Nginx modules ==

The following Nginx modules are not distributed with the Nginx source.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpCircleGifModule| Circle GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpUpstreamRequestHashModule| Upstream Hash Module]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [http://xph.us/software/nginx-notice/ Notice Module] || ||
|-
| [[NginxNgxZip| ngx_zip]] || ''none'' || ''none''
|-
| [[NginxNgx_rrd_graph| ngx_rrd_graph]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRRDTool mod_rrdtool]
|-
| [[NginxNgxSCGIModule| SCGI Module]] || [http://quixote.python.ca/scgi.dev/ ?] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSCGI mod_scgi]
|-
| [[NginxHttpUploadProgressModule| Upload Progress Module]] || ? || [http://trac.lighttpd.net/trac/wiki/Docs:ModUploadProgress mod_uploadprogress]
|-
| [[NginxNgxWSGIModule| WSGI Module]] || [http://code.google.com/p/modwsgi/ mod_wsgi] || ?
|}

== Requested Nginx modules ==

{| border="1"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| ''none'' || [http://httpd.apache.org/docs/2.0/mod/mod_mem_cache.html mod_mem_cache] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMemCache mod_mem_cache]
|-
| ''none'' || [http://www.backhand.org/mod_backhand/ mod_backhand] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpSecureDownload| Secure Download Module]] || [http://www.synd.info/downloads/releases/ mod_auth_token] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSecDownload mod_secdownload]
|-
| ''none'' || [http://www.modsecurity.org/ mod_security] || ?
|-
| ''none'' || ? || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMySQLVhost mod_mysql_vhost]
|-
| ''none'' || [http://httpd.apache.org/docs/2.1/mod/mod_proxy_ajp.html mod_proxy_ajp] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core (mod_proxy_backend_ajp13)]

ModuleComparisonMatrix

2012-05-03T00:31:12Z

Admin: /* Module comparison matrix */

== Module comparison matrix ==

Looking for Nginx's mod_rewrite or mod_perl? The following table attempts to summarize modules for Nginx that are comparable to modules available for other web servers.

{| class="modules-index-table"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpUpstreamModule| HTTP Upstream Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_proxy_balancer.html mod_proxy_balancer] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core]
|-
| [[NginxHttpAccessModule| Access Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_access.html mod_access] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccess mod_access]
|-
| [[NginxHttpAuthBasicModule| Auth Basic Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_auth.html mod_auth] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAuth mod_auth]
|-
| [[NginxHttpAutoindexModule| AutoIndex Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html mod_autoindex] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModDirlisting mod_dirlisting]
|-
| [[NginxHttpBrowserModule| Browser Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpCharsetModule| Charset Module]] || ''none'' || ''none''
|-
| [[NginxHttpEmptyGifModule| Empty GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpFcgiModule| FastCGI Module]] || [http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html mod_fastcgi] , [http://fastcgi.coremail.cn/ mod_fcgid] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFastCGI mod_fastcgi]
|-
| [[NginxHttpGeoModule| GEO Module]] || [http://www.maxmind.com/app/mod_geoip mod_geoip] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModGeoip mod_geoip]
|-
| [[NginxHttpGzipModule| Gzip Compression Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_deflate.html mod_deflate] || [http://trac.lighttpd.net/trac/wiki/Mod_Deflate mod_deflate]
|-
| [[NginxHttpGzipStaticModule| Gzip Pre-Compression Module]] || ''none'' || ''none''
|-
| [[NginxHttpHeadersModule| HTTP Headers Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_headers.html mod_headers] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSetEnv mod_setenv]
|-
| [[NginxHttpRefererModule| HTTP Referer Module]] || [http://httpd.apache.org/docs/2.2/mod/mod_setenvif.html mod_setenvif] || ?
|-
| [[NginxHttpLimitZoneModule| Limit Zone Module]] || [http://dominia.org/djao/limitipconn2.html mod_limitipconn] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModEvasive mod_evasive]
|-
| [[NginxHttpLogModule| Log Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_log_config.html mod_log_config] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModAccessLog mod_accesslog]
|-
| [[NginxHttpMapModule| Map Module]] || ? || ?
|-
| [[NginxHttpMemcachedModule| Memcached Module]] || ''none'' || ''none''
|-
| [[NginxHttpProxyModule| Proxy Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_proxy.html mod_proxy] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpRewriteModule| Rewrite Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html mod_rewrite] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRewrite mod_rewrite]
|-
| [[NginxHttpSsiModule| SSI Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_include.html mod_include] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModSSI mod_ssi]
|-
| [[NginxHttpUserIdModule| UserID Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_usertrack.html mod_usertrack] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModUserTrack mod_usertrack]
|-
| [[NginxHttpAdditionModule| Addition Module]] || [http://tangent.org/index.pl?lastnode_id=478&node_id=362 mod_layout] || ?
|-
| [[NginxEmbeddedPerlModule| Embedded Perl Module]] || [http://perl.apache.org/ mod_perl] || ''none''
|-
| [[NginxHttpFlvStreamModule| FLV Module]] || [http://journal.paul.querna.org/articles/2006/07/11/mod_flvx mod_flvx] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModFLVStreaming mod_flv_streaming]
|-
| [[NginxHttpRealIpModule| Real IP Module]] || [http://stderr.net/apache/rpaf/ mod_rpaf] || [http://trac.lighttpd.net/trac/wiki/Docs/ModExtForward mod_extforward]
|-
| [[NginxHttpSslModule| SSL Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_ssl.html mod_ssl] || [http://trac.lighttpd.net/trac/wiki/Docs%3ASSL SSL]
|-
| [[NginxHttpStubStatusModule| Stub Status Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_status.html mod_status] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModStatus mod_status]
|-
| [[NginxHttpSubModule| Substitution Module]] || [http://apache.webthing.com/mod_line_edit/ mod_line_edit] || ?
|-
| [[NginxHttpDavModule| WebDAV Module]] || [http://httpd.apache.org/docs/2.0/mod/mod_dav.html mod_dav] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModWebDAV mod_webdav]
|-
| [[NginxUserDir| UserDir Equivalent]] || [http://httpd.apache.org/docs/2.0/mod/mod_userdir.html mod_userdir] || [http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs#mod_userdir mod_userdir]
|-
|}

== Third-Party Nginx modules ==

The following Nginx modules are not distributed with the Nginx source.

{| border="1"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| [[NginxHttpCircleGifModule| Circle GIF Module]] || ''none'' || ''none''
|-
| [[NginxHttpUpstreamRequestHashModule| Upstream Hash Module]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [http://xph.us/software/nginx-notice/ Notice Module] || ||
|-
| [[NginxNgxZip| ngx_zip]] || ''none'' || ''none''
|-
| [[NginxNgx_rrd_graph| ngx_rrd_graph]] || ''none'' || [http://trac.lighttpd.net/trac/wiki/Docs%3AModRRDTool mod_rrdtool]
|-
| [[NginxNgxSCGIModule| SCGI Module]] || [http://quixote.python.ca/scgi.dev/ ?] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSCGI mod_scgi]
|-
| [[NginxHttpUploadProgressModule| Upload Progress Module]] || ? || [http://trac.lighttpd.net/trac/wiki/Docs:ModUploadProgress mod_uploadprogress]
|-
| [[NginxNgxWSGIModule| WSGI Module]] || [http://code.google.com/p/modwsgi/ mod_wsgi] || ?
|}

== Requested Nginx modules ==

{| border="1"
|-
| '''Nginx module''' || '''Apache module''' || '''Lighttpd module'''
|-
| ''none'' || [http://httpd.apache.org/docs/2.0/mod/mod_mem_cache.html mod_mem_cache] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMemCache mod_mem_cache]
|-
| ''none'' || [http://www.backhand.org/mod_backhand/ mod_backhand] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxy mod_proxy]
|-
| [[NginxHttpSecureDownload| Secure Download Module]] || [http://www.synd.info/downloads/releases/ mod_auth_token] || [http://trac.lighttpd.net/trac/wiki/Docs:ModSecDownload mod_secdownload]
|-
| ''none'' || [http://www.modsecurity.org/ mod_security] || ?
|-
| ''none'' || ? || [http://trac.lighttpd.net/trac/wiki/Docs%3AModMySQLVhost mod_mysql_vhost]
|-
| ''none'' || [http://httpd.apache.org/docs/2.1/mod/mod_proxy_ajp.html mod_proxy_ajp] || [http://trac.lighttpd.net/trac/wiki/Docs%3AModProxyCore mod_proxy_core (mod_proxy_backend_ajp13)]

3rdPartyModules

2012-05-03T00:26:13Z

Admin: /* Third party modules */

= Third party modules =
These modules are not officially supported and may not be compatible across versions of Nginx. Nevertheless many of them may prove useful to many people. Enjoy at your own risk.

== Compiling third party modules ==
Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

<pre>
./configure --add-module=/path/to/module1/source \
--add-module=/path/to/module2/source
</pre>

You can use as many <code>--add-module</code> arguments as needed.

Be aware that some modules may require additional libraries to be installed on your system.

== Writing your own module ==
[http://www.evanmiller.org/ Evan Miller] has written the [http://www.evanmiller.org/nginx-modules-guide.html definitive guide] to Nginx module development. But some parts of it are a little out of date. You've been warned.

A github search turned up the [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]. It seems to be more up to date.

See also the tools at the bottom of this page.

= Known modules =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [[AcceptLanguageModule|Accept Language]]
| Parses the <code>Accept-Language</code> header and gives the most suitable locale from a list of supported locales.
| Guillaume Maury
| [http://github.com/giom/nginx_accept_language_module Download]
|-
| [[HttpAccessKeyModule|Access Key]]
| Denies access unless the request URL contains an access key.
| Mykola Grechukh
| [http://wiki.nginx.org/File:Nginx-accesskey-2.0.3.tar.gz Download]
|-
| [http://github.com/rsms/afcgi AFCGI]
| Asynchronous/multiplexing FastCGI for nginx (incl. ref server implementation)
| [http://github.com/rsms rsms]
| [http://github.com/rsms/afcgi Download]
|-
| [http://github.com/agentzh/array-var-nginx-module Array Var]
| Add support for array variables to nginx config files
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/array-var-nginx-module/tags Download]
|-
| [[HttpAuthDigestModule|Auth Digest]]
| HTTP Digest Authentication.
| [http://samizdat.cc Christian Swinehart]
| [https://github.com/samizdatco/nginx-http-auth-digest Download]
|-
| [http://web.iti.upv.es/~sto/nginx/ Auth PAM]
| HTTP Basic Authentication using PAM.
| Sergio Talens-Oliag
| [http://web.iti.upv.es/~sto/nginx/ngx_http_auth_pam_module-1.2.tar.gz Download]
|-
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Auth Request]
| Allows authorization based on subrequest result.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Download]
|-
| [http://github.com/simpl/ngx_auto_lib Auto Lib]
| Reuse pre-compiled/installed versions of OpenSSL, PCRE and Zlib without re-compiling them each time Nginx is compiled
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/tags Download]
|-
| [http://github.com/anomalizer/ngx_aws_auth AWS auth]
| Generate security headers for GET requests to Amazon S3.
| [http://anomalizer.net/statistically-incorrect Arvind Jayaprakash]
| [http://github.com/anomalizer/ngx_aws_auth/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Cache Purge]
| Module adding ability to purge content from FastCGI, proxy, and uWSGI caches.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Download]
|-
| [[HttpChunkinModule|Chunkin]]
| HTTP 1.1 chunked-encoding request body support for Nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/chunkin-nginx-module/tags Download]
|-
| [[HttpCircleGifModule|Circle GIF]]
| Generates simple circle images with the colors and size specified in the URL.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/nginx_circle_gif/ Download]
|-
| [http://ngx-ctpp.vbart.info/ CT++]
| Embeds [http://ctpp.havoc.ru/en/whatis.html CT++ (or CTPP2)] VM, the execution part of a high-performance template engine system.
| [http://vbart.info/ Valentin V. Bartenev]
| [http://dl.vbart.ru/ngx-ctpp/ngx_ctpp2-0.5.tar.gz Download]
|-
| [http://github.com/simpl/ngx_devel_kit Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/tags Download]
|-
| [[HttpDrizzleModule|Drizzle]]
| Make nginx talk directly to mysql and drizzle by libdrizzle.
| [http://github.com/chaoslawful/ chaoslawful], [http://agentzh.org/ agentzh], Piotr Sikora
| [http://github.com/chaoslawful/drizzle-nginx-module/tags Download]
|-
| [http://github.com/kali/nginx-dynamic-etags Dynamic etags]
| Nginx module for etags on dynamic content
| [http://github.com/kali kali]
| [http://github.com/kali/nginx-dynamic-etags Download]
|-
| [[HttpEchoModule|Echo]]
| Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/echo-nginx-module/tags Download]
|-
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Enhanced Memcached]
| Repackaging of the standard memcached module to add features : custom http headers, hash keys, store entries in memcached with post http request, flush, key namespace
| [https://github.com/bpaquet Bertrand Paquet]
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Download]
|-
| [http://github.com/agentzh/encrypted-session-nginx-module Encrypted Session]
| encrypt and decrypt nginx variable values, can be used for light-weight session-based authentication
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/encrypted-session-nginx-module/tags Download]
|-
| [http://github.com/vkholodkov/nginx-eval-module Eval]
| A module for evaluating memcached or proxy response into variable.
| [http://github.com/vkholodkov/ vkholodkov]
| [http://github.com/vkholodkov/nginx-eval-module Download]
|-
| [http://github.com/agentzh/nginx-eval-module Eval (agentzh's fork)]
| Enhanced ngx_eval that can capture arbitrary subrequest's responses into nginx variables (can even with output filters enabled)
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/nginx-eval-module/tags Download]
|-
| [[Expressz|Expressz]]
| First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).
| [http://www.acronymlabs.com/ Jason Giedymin at AcronymLabs]
|-
| [http://github.com/ry/nginx-ey-balancer/tree/master EY Balancer]
| Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.
| Ry Dahl
| [http://github.com/ry/nginx-ey-balancer/tarball/master Download]
|-
| [http://wiki.nginx.org/NgxFancyIndex Fancy Indexes]
| Like the built-in [[Modules#HTTP_Auto_Index|autoindex]] module, but fancier.
| Adrian Perez de Castro
| [http://gitorious.org/ngx-fancyindex/ngx-fancyindex Download]
|-
| [[HttpFormInputModule|Form Input]]
| This module reads HTTP POST request body and parse the arguments into nginx variables.
| [http://vimedia.org/ Calio], [http://agentzh.org agentzh]
| [http://github.com/calio/form-input-nginx-module/tags Download]
|-
| [[Http3rdPartyGeoIPModule|GeoIP]]
| Country code lookups via the [http://www.maxmind.com/ MaxMind] GeoIP API.
| [http://www.spilgames.com/ SPIL GAMES]
| [[File:Nginx-geoip-0.2.tar.gz|Download]]
|-
| [http://github.com/mdirolf/nginx-gridfs GridFS]
| Nginx module for serving files from MongoDB's GridFS.
| [http://github.com/mdirolf mdirolf]
| [http://github.com/mdirolf/nginx-gridfs Download]
|-
| [[HttpHeadersMoreModule|Headers More]]
| Set and clear input and output headers...more than "add"!
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/headers-more-nginx-module/tags Download]
|-
| [[HttpHealthcheckModule|HTTP Healthcheck]]
| Health check HTTP servers inside an upstream so you don't forward requests to bad hosts
| Jack Lindamood
|
|-
| [https://github.com/Lax/ngx_http_accounting_module HTTP Accounting]
| Realtime netflow and status code monitor solution for nginx, need less memory and cpu than realtime log analyzing. Useful for http traffic accounting based on nginx config logic ( per-location-traffic or per-server-traffic ).
| [http://www.liulantao.com/portal/ Liu Lantao]
| [https://github.com/Lax/ngx_http_accounting_module Download]
|-
| [http://pushmodule.slact.net/ HTTP Push]
| Turn Nginx into an adept long-polling HTTP Push (Comet) server.
| Leo Ponomarev
| [http://pushmodule.slact.net/downloads/nginx_http_push_module-0.69.tar.gz Download]
|-
| [[HttpPushStreamModule|HTTP Push Stream]]
| Turn Nginx into an adept stream HTTP Push (Comet) server.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-push-stream-module/downloads Download]
|-
| [[HttpRedis|HTTP Redis]]
| [http://redis.io/ Redis] support.
| Sergey A. Osokin <osa@FreeBSD.ORG.ru>
| [http://people.FreeBSD.ORG/~osa/ngx_http_redis-0.3.5.tar.gz Download]
|-
| [https://github.com/kung-fu-tzu/ngx_http_js_module#readme JavaScript]
| Embedding [http://www.mozilla.org/js/spidermonkey/ SpiderMonkey]. Full port of Perl module and more.
| [https://github.com/kung-fu-tzu Peter Leonov]
| [https://github.com/kung-fu-tzu/ngx_http_js_module/downloads Download]
|-
| [[HttpIconvModule|Iconv]]
| A character encoding conversion nginx module using libiconv.
| [http://vimedia.org/ Calio], [http://agentzh.org/ agentzh]
| [http://github.com/calio/iconv-nginx-module/tags Download]
|-
| [[HttpLogRequestSpeed|Log Request Speed]]
| Log the time it took to process each request.
| [https://github.com/replay Mauro Stettler]
|
|-
| [https://github.com/replay/ngx_http_lower_upper_case Lower Upper Case]
| Simple module to upper-/lowercase a string in the Nginx config
| [https://github.com/replay Mauro Stettler]
| [https://github.com/replay/ngx_http_lower_upper_case Download]
|-
| [http://wiki.nginx.org/HttpLuaModule Lua]
| Embed the power of Lua into nginx
| [http://github.com/chaoslawful chaoslawful], [http://agentzh.org/ agentzh]
| [http://github.com/chaoslawful/lua-nginx-module/tags Download]
|-
| [https://github.com/alacner/nginx_lua_module Luafile]
| Embed the power of Lua into nginx very easy.
| [http://alacner.com alacner]
| [https://github.com/alacner/nginx_lua_module/tarball/master Download]
|-
| [[HttpMemcModule|Memc]]
| An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/memc-nginx-module/tags Download]
|-
| [http://www.grid.net.ru/nginx/mogilefs.en.html Mogilefs]
| Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/download/nginx_mogilefs_module-1.0.2.tar.gz Download]
|-
| [[MP4StreamingLite|MP4 Streaming Lite]]
| Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.
| Jiang Hong
| [[MP4StreamingLite|Download]]
|-
| [http://naxsi.googlecode.com Naxsi]
| Web Application Firewall for nginx.
| Thibault Koechlin
| [http://naxsi.googlecode.com Download]
|-
| [http://xph.us/software/nginx-notice/ Notice]
| Serve static file to POST requests.
| Keith Rarick
| [http://xph.us/software/nginx-notice/nginx-notice-2.tar.gz Download]
|-
| [http://wiki.nginx.org/HttpOwnerMatchModule OwnerMatch]
| This module provides a simple file owner-based access control.
| [https://heiher.info Heiher]
| [http://heiher.info/sftp/files/Nginx-0.8.54-Add-OwnerMatch-module.patch Download]
|-
| [http://mauro-stettler.blogspot.com/2011/08/pecl-memcache-standard-loadbalancer-for.html PHP-Memache Standard Hash]
| This is a loadbalancer that imitates the PHP-Memcache standard hash's behaviour
| Mauro Stettler
| [https://github.com/replay/ngx_http_php_memcache_standard_balancer Download]
|-
| [https://github.com/replay/ngx_http_php_session PHP Session Parser]
| Extract values that are stored in a serialized PHP session
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_php_session Download]
|-
| [http://labs.frickle.com/nginx_ngx_postgres/ Postgres]
| Upstream module that allows nginx to communicate directly with PostgreSQL database.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_postgres/ Download]
|-
| [http://vitki.net/pubcookie Pubcookie]
| Adds [http://www.pubcookie.org Pubcookie]-based cross-site authentication method to Nginx.
| [http://www.vitki.net/ Vitki]
| [http://vitki.net/pubcookie#Installation Download]
|-
| [http://github.com/agentzh/rds-csv-nginx-module RDS CSV]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit Comma-Separated Values (CSV).
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-csv-nginx-module/tags Download]
|-
| [http://github.com/agentzh/rds-json-nginx-module RDS JSON]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit JSON data.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-json-nginx-module/tags Download]
|-
| [[HttpRedis2Module|Redis2]]
| Upstream module for the full [http://redis.io/ Redis] 2.0 protocol
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/redis2-nginx-module/tags Download]
|-
| [https://github.com/yuri-gushin/Roboo Roboo]
| HTTP Robot mitigator utilizing advanced non-interactive HTTP challenge/response mechanisms
| [http://www.ecl-labs.org/ Yuri Gushin, Alex Behar]
| [https://github.com/yuri-gushin/Roboo/downloads Download]
|-
| [[NginxNgx_rrd_graph|RRD Graph]]
| This module provides an HTTP interface to [http://oss.oetiker.ch/rrdtool/ RRDtool]'s graphing facilities.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/mod_rrd_graph Download]
|-
| [[HttpSecureDownload|Secure Download]]
| Create expiring links.
| [https://github.com/replay Mauro Stettler], Szymon Modzelewski
| [http://github.com/replay/ngx_http_secure_download Download]
|-
| [http://github.com/liseen/set-cconv-nginx-module/ Set CConv]
| Conversion between Simplified Chinese and Traditional Chinese at rewrite phase
| [http://github.com/liseen/ Liseen Wan]
| [http://github.com/liseen/set-cconv-nginx-module/ Download]
|-
| [http://github.com/simpl/ngx_http_set_hash Set Hash]
| Set a variable to a variety of hash functions (upper/lowercase), including MD5, SHA1 and Murmurhash 2
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_hash/tags Download]
|-
| [http://github.com/simpl/ngx_http_set_lang Set Lang]
| Set a variable to indicate the language based on a variety of sources including cookies, GET/POST variables, Accept Language header and more
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_lang/downloads Download]
|-
| [http://wiki.nginx.org/HttpSetMiscModule Set Misc]
| Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)
| [http://agentzh.org agentzh], [http://vimedia.org/ Calio], [http://github.com/shrimp/ shrimp]
| [http://github.com/agentzh/set-misc-nginx-module/tags Download]
|-
| [http://nginx-sflow-module.googlecode.com sFlow]
| Operational performance monitoring with standard [http://sflow.org sFlow] protocol
| Neil McKee
| [http://code.google.com/p/nginx-sflow-module/downloads/list Download]
|-
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ SlowFS Cache]
| Module adding ability to cache static files.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ Download]
|-
| [https://github.com/muhgatus/spnego-http-auth-nginx-module SPNEGO]
| Support for SPNEGO/gssapi in nginx.
| [https://github.com/mike503 mike503]/[https://github.com/muhgatus/ muhgatus]
| [https://github.com/muhgatus/spnego-http-auth-nginx-module Download]
|-
| [http://wiki.nginx.org/HttpSRCacheModule SR Cache]
| Transparent subrequest-based caching layout for arbitrary nginx locations (can be used with ngx_memc + memcached!)
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/srcache-nginx-module/tags Download]
|-
| [http://github.com/mikewest/nginx-static-etags Static etags]
| Nginx doesn't generate etags for static content. I'd like it to. Let's see if I can remember some C from college.
| [http://github.com/mikewest mikewest]
| [http://github.com/mikewest/nginx-static-etags Download]
|-
| [https://github.com/zebrafishlabs/nginx-statsd Statsd]
| Adds the ability for Nginx to interacting with statsd.
| [https://github.com/zebrafishlabs zebrafishlabs]
| [https://github.com/zebrafishlabs/nginx-statsd Download]
|-
| [http://code.google.com/p/nginx-sticky-module/ Sticky upstream]
| A nginx module to add an upstream server persistance using cookies.
| [http://code.google.com/u/jerome@loyet.net/ Jérôme Loyet]
| [http://code.google.com/p/nginx-sticky-module/downloads/list Download]
|-
| [[HttpStripModule|Strip]]
| Whitespace remover.
| [http://evanmiller.org Evan Miller]
| [[File:mod_strip-0.1.tar.gz|Download]]
|-
| [http://wiki.nginx.org/HttpSubsModule Substitutions]
| A filter module which can do both regular expression and fixed string substitutions on response bodies.
| [http://yaoweibin.cn Weibin Yao]
| [http://code.google.com/p/substitutions4nginx/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_supervisord/ Supervisord]
| Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_supervisord/ Download]
|-
| [http://www.grid.net.ru/nginx/upload.en.html Upload]
| Parses <code>multipart/form-data</code> allowing arbitrary handling of uploaded files.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/upload.en.html#download Download]
|-
| [[HttpUploadProgressModule|Upload Progress]]
| Tracks and reports upload progress.
| Brice Figureau
| [http://github.com/masterzen/nginx-upload-progress-module/downloads Download]
|-
| [[HttpUpstreamConsistentHash|Upstream Consistent Hash]]
| Select backend based on Consistent hash ring.
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_consistent_hash Download]
|-
| [[HttpUpstreamFairModule|Upstream Fair Balancer]]
| Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.
| Gregory Nosek
| [http://github.com/gnosek/nginx-upstream-fair Download]
|-
| [[HttpUpstreamRequestHashModule|Upstream Hash]]
| Provides simple upstream load distribution by hashing a configurable variable.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/nginx_upstream_hash/ Download]
|-
| [[HttpUpstreamKeepaliveModule|Upstream Keepalive]]
| Provides keep-alive connections to memcached upstreams.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_upstream_keepalive/ Download]
|-
| [https://github.com/wandenberg/nginx-video-thumbextractor-module Video Thumb Extractor]
| Nginx module to extract thumbs from a video file.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-video-thumbextractor-module/downloads Download]
|-
| [[NgxWSGIModule|WSGI]]
| [http://en.wikipedia.org/wiki/Wsgi WSGI] implementation for Nginx. Allows easy deployment of Python applications.
| Manlio Perillo
| [http://hg.mperillo.ath.cx/nginx/mod_wsgi/ Download]
|-
| [http://github.com/agentzh/xss-nginx-module XSS]
| Native support for cross-site scripting (XSS) in an nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/xss-nginx-module/tags Download]
|-
| [[NgxZip|Zip]]
| Assemble ZIP archives on the fly.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/mod_zip/ Download]
|-
| [[Extended status module|Extended status module]]
| Extended status module for nginx
| 최영석(Choi Youngseok), 李金虎(Li Jinhu)
| [http://github.com/zealot83/ngx_http_extended_status_module Download]
|-
|}

= Tools for module developers =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [http://github.com/simpl/ngx_auto_lib Nginx Auto Lib Core]
| Reusable file for module developers to include with their modules to easily and consistently handle including external libraries; used in the Auto Lib module and included in the Nginx Development Kit
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/downloads Download]
|-
| [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/downloads Download]
|}

= Third party patches =
These patches must be applied to the Nginx source code tree. There's no guarantee these patches will apply to a particular version of Nginx.

As with third party modules, these patches are not officially supported. Your mileage may vary.

{| class="modules-index-table"
! Description
! Author
! Link
|-
| Log to syslog.
| Marlon de Boer
| [http://bugs.gentoo.org/attachment.cgi?id=197180 Patch against 0.8.4] (works on 0.7.x and 0.8.x) | [http://dl.dropbox.com/u/5836407/Patches/Nginx_0.8.49-syslog-support.txt Patch for version 0.8.49 with 'sh is not bash' fix] | [https://github.com/yaoweibin/nginx_syslog_patch Syslog Patch for Nginx 0.8.54+]
|-
| Disable nginx's memory pool to help valgrind and other tools (for nginx C developers only)
| [http://github.com/shrimp/ shrimp], [http://agentzh.spaces.live.com/ agentzh]
| [http://github.com/shrimp/no-pool-nginx Git repository for the patch]
|-
| SSL Session tickets distributed via memcached
| [http://hezmatt.org/~mpalmer/blog/2011/07/24/followup-to-ssl-session-caching-with-nginx.html Matthew Palmer]
| [https://github.com/mpalmer/nginx Git repository for changes]
|}

= References =
* [http://github.com/search?type=Repositories&language=c&q=nginx&repo=&langOverride=&x=13&y=17&start_value=1 github search]

3rdPartyModules

2012-05-03T00:24:44Z

Admin: /* Third party modules */

= Third party modules =
These modules are not officially supported. Nevertheless many of them may prove useful to many people. Enjoy at your own risk.

== Compiling third party modules ==
Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

<pre>
./configure --add-module=/path/to/module1/source \
--add-module=/path/to/module2/source
</pre>

You can use as many <code>--add-module</code> arguments as needed.

Be aware that some modules may require additional libraries to be installed on your system.

== Writing your own module ==
[http://www.evanmiller.org/ Evan Miller] has written the [http://www.evanmiller.org/nginx-modules-guide.html definitive guide] to Nginx module development. But some parts of it are a little out of date. You've been warned.

A github search turned up the [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]. It seems to be more up to date.

See also the tools at the bottom of this page.

= Known modules =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [[AcceptLanguageModule|Accept Language]]
| Parses the <code>Accept-Language</code> header and gives the most suitable locale from a list of supported locales.
| Guillaume Maury
| [http://github.com/giom/nginx_accept_language_module Download]
|-
| [[HttpAccessKeyModule|Access Key]]
| Denies access unless the request URL contains an access key.
| Mykola Grechukh
| [http://wiki.nginx.org/File:Nginx-accesskey-2.0.3.tar.gz Download]
|-
| [http://github.com/rsms/afcgi AFCGI]
| Asynchronous/multiplexing FastCGI for nginx (incl. ref server implementation)
| [http://github.com/rsms rsms]
| [http://github.com/rsms/afcgi Download]
|-
| [http://github.com/agentzh/array-var-nginx-module Array Var]
| Add support for array variables to nginx config files
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/array-var-nginx-module/tags Download]
|-
| [[HttpAuthDigestModule|Auth Digest]]
| HTTP Digest Authentication.
| [http://samizdat.cc Christian Swinehart]
| [https://github.com/samizdatco/nginx-http-auth-digest Download]
|-
| [http://web.iti.upv.es/~sto/nginx/ Auth PAM]
| HTTP Basic Authentication using PAM.
| Sergio Talens-Oliag
| [http://web.iti.upv.es/~sto/nginx/ngx_http_auth_pam_module-1.2.tar.gz Download]
|-
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Auth Request]
| Allows authorization based on subrequest result.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Download]
|-
| [http://github.com/simpl/ngx_auto_lib Auto Lib]
| Reuse pre-compiled/installed versions of OpenSSL, PCRE and Zlib without re-compiling them each time Nginx is compiled
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/tags Download]
|-
| [http://github.com/anomalizer/ngx_aws_auth AWS auth]
| Generate security headers for GET requests to Amazon S3.
| [http://anomalizer.net/statistically-incorrect Arvind Jayaprakash]
| [http://github.com/anomalizer/ngx_aws_auth/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Cache Purge]
| Module adding ability to purge content from FastCGI, proxy, and uWSGI caches.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Download]
|-
| [[HttpChunkinModule|Chunkin]]
| HTTP 1.1 chunked-encoding request body support for Nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/chunkin-nginx-module/tags Download]
|-
| [[HttpCircleGifModule|Circle GIF]]
| Generates simple circle images with the colors and size specified in the URL.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/nginx_circle_gif/ Download]
|-
| [http://ngx-ctpp.vbart.info/ CT++]
| Embeds [http://ctpp.havoc.ru/en/whatis.html CT++ (or CTPP2)] VM, the execution part of a high-performance template engine system.
| [http://vbart.info/ Valentin V. Bartenev]
| [http://dl.vbart.ru/ngx-ctpp/ngx_ctpp2-0.5.tar.gz Download]
|-
| [http://github.com/simpl/ngx_devel_kit Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/tags Download]
|-
| [[HttpDrizzleModule|Drizzle]]
| Make nginx talk directly to mysql and drizzle by libdrizzle.
| [http://github.com/chaoslawful/ chaoslawful], [http://agentzh.org/ agentzh], Piotr Sikora
| [http://github.com/chaoslawful/drizzle-nginx-module/tags Download]
|-
| [http://github.com/kali/nginx-dynamic-etags Dynamic etags]
| Nginx module for etags on dynamic content
| [http://github.com/kali kali]
| [http://github.com/kali/nginx-dynamic-etags Download]
|-
| [[HttpEchoModule|Echo]]
| Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/echo-nginx-module/tags Download]
|-
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Enhanced Memcached]
| Repackaging of the standard memcached module to add features : custom http headers, hash keys, store entries in memcached with post http request, flush, key namespace
| [https://github.com/bpaquet Bertrand Paquet]
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Download]
|-
| [http://github.com/agentzh/encrypted-session-nginx-module Encrypted Session]
| encrypt and decrypt nginx variable values, can be used for light-weight session-based authentication
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/encrypted-session-nginx-module/tags Download]
|-
| [http://github.com/vkholodkov/nginx-eval-module Eval]
| A module for evaluating memcached or proxy response into variable.
| [http://github.com/vkholodkov/ vkholodkov]
| [http://github.com/vkholodkov/nginx-eval-module Download]
|-
| [http://github.com/agentzh/nginx-eval-module Eval (agentzh's fork)]
| Enhanced ngx_eval that can capture arbitrary subrequest's responses into nginx variables (can even with output filters enabled)
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/nginx-eval-module/tags Download]
|-
| [[Expressz|Expressz]]
| First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).
| [http://www.acronymlabs.com/ Jason Giedymin at AcronymLabs]
|-
| [http://github.com/ry/nginx-ey-balancer/tree/master EY Balancer]
| Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.
| Ry Dahl
| [http://github.com/ry/nginx-ey-balancer/tarball/master Download]
|-
| [http://wiki.nginx.org/NgxFancyIndex Fancy Indexes]
| Like the built-in [[Modules#HTTP_Auto_Index|autoindex]] module, but fancier.
| Adrian Perez de Castro
| [http://gitorious.org/ngx-fancyindex/ngx-fancyindex Download]
|-
| [[HttpFormInputModule|Form Input]]
| This module reads HTTP POST request body and parse the arguments into nginx variables.
| [http://vimedia.org/ Calio], [http://agentzh.org agentzh]
| [http://github.com/calio/form-input-nginx-module/tags Download]
|-
| [[Http3rdPartyGeoIPModule|GeoIP]]
| Country code lookups via the [http://www.maxmind.com/ MaxMind] GeoIP API.
| [http://www.spilgames.com/ SPIL GAMES]
| [[File:Nginx-geoip-0.2.tar.gz|Download]]
|-
| [http://github.com/mdirolf/nginx-gridfs GridFS]
| Nginx module for serving files from MongoDB's GridFS.
| [http://github.com/mdirolf mdirolf]
| [http://github.com/mdirolf/nginx-gridfs Download]
|-
| [[HttpHeadersMoreModule|Headers More]]
| Set and clear input and output headers...more than "add"!
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/headers-more-nginx-module/tags Download]
|-
| [[HttpHealthcheckModule|HTTP Healthcheck]]
| Health check HTTP servers inside an upstream so you don't forward requests to bad hosts
| Jack Lindamood
|
|-
| [https://github.com/Lax/ngx_http_accounting_module HTTP Accounting]
| Realtime netflow and status code monitor solution for nginx, need less memory and cpu than realtime log analyzing. Useful for http traffic accounting based on nginx config logic ( per-location-traffic or per-server-traffic ).
| [http://www.liulantao.com/portal/ Liu Lantao]
| [https://github.com/Lax/ngx_http_accounting_module Download]
|-
| [http://pushmodule.slact.net/ HTTP Push]
| Turn Nginx into an adept long-polling HTTP Push (Comet) server.
| Leo Ponomarev
| [http://pushmodule.slact.net/downloads/nginx_http_push_module-0.69.tar.gz Download]
|-
| [[HttpPushStreamModule|HTTP Push Stream]]
| Turn Nginx into an adept stream HTTP Push (Comet) server.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-push-stream-module/downloads Download]
|-
| [[HttpRedis|HTTP Redis]]
| [http://redis.io/ Redis] support.
| Sergey A. Osokin <osa@FreeBSD.ORG.ru>
| [http://people.FreeBSD.ORG/~osa/ngx_http_redis-0.3.5.tar.gz Download]
|-
| [https://github.com/kung-fu-tzu/ngx_http_js_module#readme JavaScript]
| Embedding [http://www.mozilla.org/js/spidermonkey/ SpiderMonkey]. Full port of Perl module and more.
| [https://github.com/kung-fu-tzu Peter Leonov]
| [https://github.com/kung-fu-tzu/ngx_http_js_module/downloads Download]
|-
| [[HttpIconvModule|Iconv]]
| A character encoding conversion nginx module using libiconv.
| [http://vimedia.org/ Calio], [http://agentzh.org/ agentzh]
| [http://github.com/calio/iconv-nginx-module/tags Download]
|-
| [[HttpLogRequestSpeed|Log Request Speed]]
| Log the time it took to process each request.
| [https://github.com/replay Mauro Stettler]
|
|-
| [https://github.com/replay/ngx_http_lower_upper_case Lower Upper Case]
| Simple module to upper-/lowercase a string in the Nginx config
| [https://github.com/replay Mauro Stettler]
| [https://github.com/replay/ngx_http_lower_upper_case Download]
|-
| [http://wiki.nginx.org/HttpLuaModule Lua]
| Embed the power of Lua into nginx
| [http://github.com/chaoslawful chaoslawful], [http://agentzh.org/ agentzh]
| [http://github.com/chaoslawful/lua-nginx-module/tags Download]
|-
| [https://github.com/alacner/nginx_lua_module Luafile]
| Embed the power of Lua into nginx very easy.
| [http://alacner.com alacner]
| [https://github.com/alacner/nginx_lua_module/tarball/master Download]
|-
| [[HttpMemcModule|Memc]]
| An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/memc-nginx-module/tags Download]
|-
| [http://www.grid.net.ru/nginx/mogilefs.en.html Mogilefs]
| Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/download/nginx_mogilefs_module-1.0.2.tar.gz Download]
|-
| [[MP4StreamingLite|MP4 Streaming Lite]]
| Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.
| Jiang Hong
| [[MP4StreamingLite|Download]]
|-
| [http://naxsi.googlecode.com Naxsi]
| Web Application Firewall for nginx.
| Thibault Koechlin
| [http://naxsi.googlecode.com Download]
|-
| [http://xph.us/software/nginx-notice/ Notice]
| Serve static file to POST requests.
| Keith Rarick
| [http://xph.us/software/nginx-notice/nginx-notice-2.tar.gz Download]
|-
| [http://wiki.nginx.org/HttpOwnerMatchModule OwnerMatch]
| This module provides a simple file owner-based access control.
| [https://heiher.info Heiher]
| [http://heiher.info/sftp/files/Nginx-0.8.54-Add-OwnerMatch-module.patch Download]
|-
| [http://mauro-stettler.blogspot.com/2011/08/pecl-memcache-standard-loadbalancer-for.html PHP-Memache Standard Hash]
| This is a loadbalancer that imitates the PHP-Memcache standard hash's behaviour
| Mauro Stettler
| [https://github.com/replay/ngx_http_php_memcache_standard_balancer Download]
|-
| [https://github.com/replay/ngx_http_php_session PHP Session Parser]
| Extract values that are stored in a serialized PHP session
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_php_session Download]
|-
| [http://labs.frickle.com/nginx_ngx_postgres/ Postgres]
| Upstream module that allows nginx to communicate directly with PostgreSQL database.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_postgres/ Download]
|-
| [http://vitki.net/pubcookie Pubcookie]
| Adds [http://www.pubcookie.org Pubcookie]-based cross-site authentication method to Nginx.
| [http://www.vitki.net/ Vitki]
| [http://vitki.net/pubcookie#Installation Download]
|-
| [http://github.com/agentzh/rds-csv-nginx-module RDS CSV]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit Comma-Separated Values (CSV).
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-csv-nginx-module/tags Download]
|-
| [http://github.com/agentzh/rds-json-nginx-module RDS JSON]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit JSON data.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-json-nginx-module/tags Download]
|-
| [[HttpRedis2Module|Redis2]]
| Upstream module for the full [http://redis.io/ Redis] 2.0 protocol
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/redis2-nginx-module/tags Download]
|-
| [https://github.com/yuri-gushin/Roboo Roboo]
| HTTP Robot mitigator utilizing advanced non-interactive HTTP challenge/response mechanisms
| [http://www.ecl-labs.org/ Yuri Gushin, Alex Behar]
| [https://github.com/yuri-gushin/Roboo/downloads Download]
|-
| [[NginxNgx_rrd_graph|RRD Graph]]
| This module provides an HTTP interface to [http://oss.oetiker.ch/rrdtool/ RRDtool]'s graphing facilities.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/mod_rrd_graph Download]
|-
| [[HttpSecureDownload|Secure Download]]
| Create expiring links.
| [https://github.com/replay Mauro Stettler], Szymon Modzelewski
| [http://github.com/replay/ngx_http_secure_download Download]
|-
| [http://github.com/liseen/set-cconv-nginx-module/ Set CConv]
| Conversion between Simplified Chinese and Traditional Chinese at rewrite phase
| [http://github.com/liseen/ Liseen Wan]
| [http://github.com/liseen/set-cconv-nginx-module/ Download]
|-
| [http://github.com/simpl/ngx_http_set_hash Set Hash]
| Set a variable to a variety of hash functions (upper/lowercase), including MD5, SHA1 and Murmurhash 2
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_hash/tags Download]
|-
| [http://github.com/simpl/ngx_http_set_lang Set Lang]
| Set a variable to indicate the language based on a variety of sources including cookies, GET/POST variables, Accept Language header and more
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_lang/downloads Download]
|-
| [http://wiki.nginx.org/HttpSetMiscModule Set Misc]
| Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)
| [http://agentzh.org agentzh], [http://vimedia.org/ Calio], [http://github.com/shrimp/ shrimp]
| [http://github.com/agentzh/set-misc-nginx-module/tags Download]
|-
| [http://nginx-sflow-module.googlecode.com sFlow]
| Operational performance monitoring with standard [http://sflow.org sFlow] protocol
| Neil McKee
| [http://code.google.com/p/nginx-sflow-module/downloads/list Download]
|-
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ SlowFS Cache]
| Module adding ability to cache static files.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ Download]
|-
| [https://github.com/muhgatus/spnego-http-auth-nginx-module SPNEGO]
| Support for SPNEGO/gssapi in nginx.
| [https://github.com/mike503 mike503]/[https://github.com/muhgatus/ muhgatus]
| [https://github.com/muhgatus/spnego-http-auth-nginx-module Download]
|-
| [http://wiki.nginx.org/HttpSRCacheModule SR Cache]
| Transparent subrequest-based caching layout for arbitrary nginx locations (can be used with ngx_memc + memcached!)
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/srcache-nginx-module/tags Download]
|-
| [http://github.com/mikewest/nginx-static-etags Static etags]
| Nginx doesn't generate etags for static content. I'd like it to. Let's see if I can remember some C from college.
| [http://github.com/mikewest mikewest]
| [http://github.com/mikewest/nginx-static-etags Download]
|-
| [https://github.com/zebrafishlabs/nginx-statsd Statsd]
| Adds the ability for Nginx to interacting with statsd.
| [https://github.com/zebrafishlabs zebrafishlabs]
| [https://github.com/zebrafishlabs/nginx-statsd Download]
|-
| [http://code.google.com/p/nginx-sticky-module/ Sticky upstream]
| A nginx module to add an upstream server persistance using cookies.
| [http://code.google.com/u/jerome@loyet.net/ Jérôme Loyet]
| [http://code.google.com/p/nginx-sticky-module/downloads/list Download]
|-
| [[HttpStripModule|Strip]]
| Whitespace remover.
| [http://evanmiller.org Evan Miller]
| [[File:mod_strip-0.1.tar.gz|Download]]
|-
| [http://wiki.nginx.org/HttpSubsModule Substitutions]
| A filter module which can do both regular expression and fixed string substitutions on response bodies.
| [http://yaoweibin.cn Weibin Yao]
| [http://code.google.com/p/substitutions4nginx/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_supervisord/ Supervisord]
| Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_supervisord/ Download]
|-
| [http://www.grid.net.ru/nginx/upload.en.html Upload]
| Parses <code>multipart/form-data</code> allowing arbitrary handling of uploaded files.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/upload.en.html#download Download]
|-
| [[HttpUploadProgressModule|Upload Progress]]
| Tracks and reports upload progress.
| Brice Figureau
| [http://github.com/masterzen/nginx-upload-progress-module/downloads Download]
|-
| [[HttpUpstreamConsistentHash|Upstream Consistent Hash]]
| Select backend based on Consistent hash ring.
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_consistent_hash Download]
|-
| [[HttpUpstreamFairModule|Upstream Fair Balancer]]
| Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.
| Gregory Nosek
| [http://github.com/gnosek/nginx-upstream-fair Download]
|-
| [[HttpUpstreamRequestHashModule|Upstream Hash]]
| Provides simple upstream load distribution by hashing a configurable variable.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/nginx_upstream_hash/ Download]
|-
| [[HttpUpstreamKeepaliveModule|Upstream Keepalive]]
| Provides keep-alive connections to memcached upstreams.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_upstream_keepalive/ Download]
|-
| [https://github.com/wandenberg/nginx-video-thumbextractor-module Video Thumb Extractor]
| Nginx module to extract thumbs from a video file.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-video-thumbextractor-module/downloads Download]
|-
| [[NgxWSGIModule|WSGI]]
| [http://en.wikipedia.org/wiki/Wsgi WSGI] implementation for Nginx. Allows easy deployment of Python applications.
| Manlio Perillo
| [http://hg.mperillo.ath.cx/nginx/mod_wsgi/ Download]
|-
| [http://github.com/agentzh/xss-nginx-module XSS]
| Native support for cross-site scripting (XSS) in an nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/xss-nginx-module/tags Download]
|-
| [[NgxZip|Zip]]
| Assemble ZIP archives on the fly.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/mod_zip/ Download]
|-
| [[Extended status module|Extended status module]]
| Extended status module for nginx
| 최영석(Choi Youngseok), 李金虎(Li Jinhu)
| [http://github.com/zealot83/ngx_http_extended_status_module Download]
|-
|}

= Tools for module developers =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [http://github.com/simpl/ngx_auto_lib Nginx Auto Lib Core]
| Reusable file for module developers to include with their modules to easily and consistently handle including external libraries; used in the Auto Lib module and included in the Nginx Development Kit
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/downloads Download]
|-
| [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/downloads Download]
|}

= Third party patches =
These patches must be applied to the Nginx source code tree. There's no guarantee these patches will apply to a particular version of Nginx.

As with third party modules, these patches are not officially supported. Your mileage may vary.

{| class="modules-index-table"
! Description
! Author
! Link
|-
| Log to syslog.
| Marlon de Boer
| [http://bugs.gentoo.org/attachment.cgi?id=197180 Patch against 0.8.4] (works on 0.7.x and 0.8.x) | [http://dl.dropbox.com/u/5836407/Patches/Nginx_0.8.49-syslog-support.txt Patch for version 0.8.49 with 'sh is not bash' fix] | [https://github.com/yaoweibin/nginx_syslog_patch Syslog Patch for Nginx 0.8.54+]
|-
| Disable nginx's memory pool to help valgrind and other tools (for nginx C developers only)
| [http://github.com/shrimp/ shrimp], [http://agentzh.spaces.live.com/ agentzh]
| [http://github.com/shrimp/no-pool-nginx Git repository for the patch]
|-
| SSL Session tickets distributed via memcached
| [http://hezmatt.org/~mpalmer/blog/2011/07/24/followup-to-ssl-session-caching-with-nginx.html Matthew Palmer]
| [https://github.com/mpalmer/nginx Git repository for changes]
|}

= References =
* [http://github.com/search?type=Repositories&language=c&q=nginx&repo=&langOverride=&x=13&y=17&start_value=1 github search]

3rdPartyModules

2012-05-03T00:24:12Z

Admin: /* Tools for module developers */

3rdPartyModules

2012-05-03T00:23:44Z

Admin: /* Third party patches */

= Third party modules =
These modules are not officially supported. Nevertheless many of them may prove useful to many people. Enjoy at your own risk.

== Compiling third party modules ==
Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

<pre>
./configure --add-module=/path/to/module1/source \
--add-module=/path/to/module2/source
</pre>

You can use as many <code>--add-module</code> arguments as needed.

Be aware that some modules may require additional libraries to be installed on your system.

== Writing your own module ==
[http://www.evanmiller.org/ Evan Miller] has written the [http://www.evanmiller.org/nginx-modules-guide.html definitive guide] to Nginx module development. But some parts of it are a little out of date. You've been warned.

A github search turned up the [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]. It seems to be more up to date.

See also the tools at the bottom of this page.

= Known modules =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [[AcceptLanguageModule|Accept Language]]
| Parses the <code>Accept-Language</code> header and gives the most suitable locale from a list of supported locales.
| Guillaume Maury
| [http://github.com/giom/nginx_accept_language_module Download]
|-
| [[HttpAccessKeyModule|Access Key]]
| Denies access unless the request URL contains an access key.
| Mykola Grechukh
| [http://wiki.nginx.org/File:Nginx-accesskey-2.0.3.tar.gz Download]
|-
| [http://github.com/rsms/afcgi AFCGI]
| Asynchronous/multiplexing FastCGI for nginx (incl. ref server implementation)
| [http://github.com/rsms rsms]
| [http://github.com/rsms/afcgi Download]
|-
| [http://github.com/agentzh/array-var-nginx-module Array Var]
| Add support for array variables to nginx config files
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/array-var-nginx-module/tags Download]
|-
| [[HttpAuthDigestModule|Auth Digest]]
| HTTP Digest Authentication.
| [http://samizdat.cc Christian Swinehart]
| [https://github.com/samizdatco/nginx-http-auth-digest Download]
|-
| [http://web.iti.upv.es/~sto/nginx/ Auth PAM]
| HTTP Basic Authentication using PAM.
| Sergio Talens-Oliag
| [http://web.iti.upv.es/~sto/nginx/ngx_http_auth_pam_module-1.2.tar.gz Download]
|-
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Auth Request]
| Allows authorization based on subrequest result.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Download]
|-
| [http://github.com/simpl/ngx_auto_lib Auto Lib]
| Reuse pre-compiled/installed versions of OpenSSL, PCRE and Zlib without re-compiling them each time Nginx is compiled
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/tags Download]
|-
| [http://github.com/anomalizer/ngx_aws_auth AWS auth]
| Generate security headers for GET requests to Amazon S3.
| [http://anomalizer.net/statistically-incorrect Arvind Jayaprakash]
| [http://github.com/anomalizer/ngx_aws_auth/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Cache Purge]
| Module adding ability to purge content from FastCGI, proxy, and uWSGI caches.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Download]
|-
| [[HttpChunkinModule|Chunkin]]
| HTTP 1.1 chunked-encoding request body support for Nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/chunkin-nginx-module/tags Download]
|-
| [[HttpCircleGifModule|Circle GIF]]
| Generates simple circle images with the colors and size specified in the URL.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/nginx_circle_gif/ Download]
|-
| [http://ngx-ctpp.vbart.info/ CT++]
| Embeds [http://ctpp.havoc.ru/en/whatis.html CT++ (or CTPP2)] VM, the execution part of a high-performance template engine system.
| [http://vbart.info/ Valentin V. Bartenev]
| [http://dl.vbart.ru/ngx-ctpp/ngx_ctpp2-0.5.tar.gz Download]
|-
| [http://github.com/simpl/ngx_devel_kit Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/tags Download]
|-
| [[HttpDrizzleModule|Drizzle]]
| Make nginx talk directly to mysql and drizzle by libdrizzle.
| [http://github.com/chaoslawful/ chaoslawful], [http://agentzh.org/ agentzh], Piotr Sikora
| [http://github.com/chaoslawful/drizzle-nginx-module/tags Download]
|-
| [http://github.com/kali/nginx-dynamic-etags Dynamic etags]
| Nginx module for etags on dynamic content
| [http://github.com/kali kali]
| [http://github.com/kali/nginx-dynamic-etags Download]
|-
| [[HttpEchoModule|Echo]]
| Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/echo-nginx-module/tags Download]
|-
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Enhanced Memcached]
| Repackaging of the standard memcached module to add features : custom http headers, hash keys, store entries in memcached with post http request, flush, key namespace
| [https://github.com/bpaquet Bertrand Paquet]
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Download]
|-
| [http://github.com/agentzh/encrypted-session-nginx-module Encrypted Session]
| encrypt and decrypt nginx variable values, can be used for light-weight session-based authentication
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/encrypted-session-nginx-module/tags Download]
|-
| [http://github.com/vkholodkov/nginx-eval-module Eval]
| A module for evaluating memcached or proxy response into variable.
| [http://github.com/vkholodkov/ vkholodkov]
| [http://github.com/vkholodkov/nginx-eval-module Download]
|-
| [http://github.com/agentzh/nginx-eval-module Eval (agentzh's fork)]
| Enhanced ngx_eval that can capture arbitrary subrequest's responses into nginx variables (can even with output filters enabled)
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/nginx-eval-module/tags Download]
|-
| [[Expressz|Expressz]]
| First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).
| [http://www.acronymlabs.com/ Jason Giedymin at AcronymLabs]
|-
| [http://github.com/ry/nginx-ey-balancer/tree/master EY Balancer]
| Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.
| Ry Dahl
| [http://github.com/ry/nginx-ey-balancer/tarball/master Download]
|-
| [http://wiki.nginx.org/NgxFancyIndex Fancy Indexes]
| Like the built-in [[Modules#HTTP_Auto_Index|autoindex]] module, but fancier.
| Adrian Perez de Castro
| [http://gitorious.org/ngx-fancyindex/ngx-fancyindex Download]
|-
| [[HttpFormInputModule|Form Input]]
| This module reads HTTP POST request body and parse the arguments into nginx variables.
| [http://vimedia.org/ Calio], [http://agentzh.org agentzh]
| [http://github.com/calio/form-input-nginx-module/tags Download]
|-
| [[Http3rdPartyGeoIPModule|GeoIP]]
| Country code lookups via the [http://www.maxmind.com/ MaxMind] GeoIP API.
| [http://www.spilgames.com/ SPIL GAMES]
| [[File:Nginx-geoip-0.2.tar.gz|Download]]
|-
| [http://github.com/mdirolf/nginx-gridfs GridFS]
| Nginx module for serving files from MongoDB's GridFS.
| [http://github.com/mdirolf mdirolf]
| [http://github.com/mdirolf/nginx-gridfs Download]
|-
| [[HttpHeadersMoreModule|Headers More]]
| Set and clear input and output headers...more than "add"!
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/headers-more-nginx-module/tags Download]
|-
| [[HttpHealthcheckModule|HTTP Healthcheck]]
| Health check HTTP servers inside an upstream so you don't forward requests to bad hosts
| Jack Lindamood
|
|-
| [https://github.com/Lax/ngx_http_accounting_module HTTP Accounting]
| Realtime netflow and status code monitor solution for nginx, need less memory and cpu than realtime log analyzing. Useful for http traffic accounting based on nginx config logic ( per-location-traffic or per-server-traffic ).
| [http://www.liulantao.com/portal/ Liu Lantao]
| [https://github.com/Lax/ngx_http_accounting_module Download]
|-
| [http://pushmodule.slact.net/ HTTP Push]
| Turn Nginx into an adept long-polling HTTP Push (Comet) server.
| Leo Ponomarev
| [http://pushmodule.slact.net/downloads/nginx_http_push_module-0.69.tar.gz Download]
|-
| [[HttpPushStreamModule|HTTP Push Stream]]
| Turn Nginx into an adept stream HTTP Push (Comet) server.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-push-stream-module/downloads Download]
|-
| [[HttpRedis|HTTP Redis]]
| [http://redis.io/ Redis] support.
| Sergey A. Osokin <osa@FreeBSD.ORG.ru>
| [http://people.FreeBSD.ORG/~osa/ngx_http_redis-0.3.5.tar.gz Download]
|-
| [https://github.com/kung-fu-tzu/ngx_http_js_module#readme JavaScript]
| Embedding [http://www.mozilla.org/js/spidermonkey/ SpiderMonkey]. Full port of Perl module and more.
| [https://github.com/kung-fu-tzu Peter Leonov]
| [https://github.com/kung-fu-tzu/ngx_http_js_module/downloads Download]
|-
| [[HttpIconvModule|Iconv]]
| A character encoding conversion nginx module using libiconv.
| [http://vimedia.org/ Calio], [http://agentzh.org/ agentzh]
| [http://github.com/calio/iconv-nginx-module/tags Download]
|-
| [[HttpLogRequestSpeed|Log Request Speed]]
| Log the time it took to process each request.
| [https://github.com/replay Mauro Stettler]
|
|-
| [https://github.com/replay/ngx_http_lower_upper_case Lower Upper Case]
| Simple module to upper-/lowercase a string in the Nginx config
| [https://github.com/replay Mauro Stettler]
| [https://github.com/replay/ngx_http_lower_upper_case Download]
|-
| [http://wiki.nginx.org/HttpLuaModule Lua]
| Embed the power of Lua into nginx
| [http://github.com/chaoslawful chaoslawful], [http://agentzh.org/ agentzh]
| [http://github.com/chaoslawful/lua-nginx-module/tags Download]
|-
| [https://github.com/alacner/nginx_lua_module Luafile]
| Embed the power of Lua into nginx very easy.
| [http://alacner.com alacner]
| [https://github.com/alacner/nginx_lua_module/tarball/master Download]
|-
| [[HttpMemcModule|Memc]]
| An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/memc-nginx-module/tags Download]
|-
| [http://www.grid.net.ru/nginx/mogilefs.en.html Mogilefs]
| Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/download/nginx_mogilefs_module-1.0.2.tar.gz Download]
|-
| [[MP4StreamingLite|MP4 Streaming Lite]]
| Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.
| Jiang Hong
| [[MP4StreamingLite|Download]]
|-
| [http://naxsi.googlecode.com Naxsi]
| Web Application Firewall for nginx.
| Thibault Koechlin
| [http://naxsi.googlecode.com Download]
|-
| [http://xph.us/software/nginx-notice/ Notice]
| Serve static file to POST requests.
| Keith Rarick
| [http://xph.us/software/nginx-notice/nginx-notice-2.tar.gz Download]
|-
| [http://wiki.nginx.org/HttpOwnerMatchModule OwnerMatch]
| This module provides a simple file owner-based access control.
| [https://heiher.info Heiher]
| [http://heiher.info/sftp/files/Nginx-0.8.54-Add-OwnerMatch-module.patch Download]
|-
| [http://mauro-stettler.blogspot.com/2011/08/pecl-memcache-standard-loadbalancer-for.html PHP-Memache Standard Hash]
| This is a loadbalancer that imitates the PHP-Memcache standard hash's behaviour
| Mauro Stettler
| [https://github.com/replay/ngx_http_php_memcache_standard_balancer Download]
|-
| [https://github.com/replay/ngx_http_php_session PHP Session Parser]
| Extract values that are stored in a serialized PHP session
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_php_session Download]
|-
| [http://labs.frickle.com/nginx_ngx_postgres/ Postgres]
| Upstream module that allows nginx to communicate directly with PostgreSQL database.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_postgres/ Download]
|-
| [http://vitki.net/pubcookie Pubcookie]
| Adds [http://www.pubcookie.org Pubcookie]-based cross-site authentication method to Nginx.
| [http://www.vitki.net/ Vitki]
| [http://vitki.net/pubcookie#Installation Download]
|-
| [http://github.com/agentzh/rds-csv-nginx-module RDS CSV]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit Comma-Separated Values (CSV).
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-csv-nginx-module/tags Download]
|-
| [http://github.com/agentzh/rds-json-nginx-module RDS JSON]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit JSON data.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-json-nginx-module/tags Download]
|-
| [[HttpRedis2Module|Redis2]]
| Upstream module for the full [http://redis.io/ Redis] 2.0 protocol
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/redis2-nginx-module/tags Download]
|-
| [https://github.com/yuri-gushin/Roboo Roboo]
| HTTP Robot mitigator utilizing advanced non-interactive HTTP challenge/response mechanisms
| [http://www.ecl-labs.org/ Yuri Gushin, Alex Behar]
| [https://github.com/yuri-gushin/Roboo/downloads Download]
|-
| [[NginxNgx_rrd_graph|RRD Graph]]
| This module provides an HTTP interface to [http://oss.oetiker.ch/rrdtool/ RRDtool]'s graphing facilities.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/mod_rrd_graph Download]
|-
| [[HttpSecureDownload|Secure Download]]
| Create expiring links.
| [https://github.com/replay Mauro Stettler], Szymon Modzelewski
| [http://github.com/replay/ngx_http_secure_download Download]
|-
| [http://github.com/liseen/set-cconv-nginx-module/ Set CConv]
| Conversion between Simplified Chinese and Traditional Chinese at rewrite phase
| [http://github.com/liseen/ Liseen Wan]
| [http://github.com/liseen/set-cconv-nginx-module/ Download]
|-
| [http://github.com/simpl/ngx_http_set_hash Set Hash]
| Set a variable to a variety of hash functions (upper/lowercase), including MD5, SHA1 and Murmurhash 2
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_hash/tags Download]
|-
| [http://github.com/simpl/ngx_http_set_lang Set Lang]
| Set a variable to indicate the language based on a variety of sources including cookies, GET/POST variables, Accept Language header and more
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_lang/downloads Download]
|-
| [http://wiki.nginx.org/HttpSetMiscModule Set Misc]
| Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)
| [http://agentzh.org agentzh], [http://vimedia.org/ Calio], [http://github.com/shrimp/ shrimp]
| [http://github.com/agentzh/set-misc-nginx-module/tags Download]
|-
| [http://nginx-sflow-module.googlecode.com sFlow]
| Operational performance monitoring with standard [http://sflow.org sFlow] protocol
| Neil McKee
| [http://code.google.com/p/nginx-sflow-module/downloads/list Download]
|-
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ SlowFS Cache]
| Module adding ability to cache static files.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ Download]
|-
| [https://github.com/muhgatus/spnego-http-auth-nginx-module SPNEGO]
| Support for SPNEGO/gssapi in nginx.
| [https://github.com/mike503 mike503]/[https://github.com/muhgatus/ muhgatus]
| [https://github.com/muhgatus/spnego-http-auth-nginx-module Download]
|-
| [http://wiki.nginx.org/HttpSRCacheModule SR Cache]
| Transparent subrequest-based caching layout for arbitrary nginx locations (can be used with ngx_memc + memcached!)
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/srcache-nginx-module/tags Download]
|-
| [http://github.com/mikewest/nginx-static-etags Static etags]
| Nginx doesn't generate etags for static content. I'd like it to. Let's see if I can remember some C from college.
| [http://github.com/mikewest mikewest]
| [http://github.com/mikewest/nginx-static-etags Download]
|-
| [https://github.com/zebrafishlabs/nginx-statsd Statsd]
| Adds the ability for Nginx to interacting with statsd.
| [https://github.com/zebrafishlabs zebrafishlabs]
| [https://github.com/zebrafishlabs/nginx-statsd Download]
|-
| [http://code.google.com/p/nginx-sticky-module/ Sticky upstream]
| A nginx module to add an upstream server persistance using cookies.
| [http://code.google.com/u/jerome@loyet.net/ Jérôme Loyet]
| [http://code.google.com/p/nginx-sticky-module/downloads/list Download]
|-
| [[HttpStripModule|Strip]]
| Whitespace remover.
| [http://evanmiller.org Evan Miller]
| [[File:mod_strip-0.1.tar.gz|Download]]
|-
| [http://wiki.nginx.org/HttpSubsModule Substitutions]
| A filter module which can do both regular expression and fixed string substitutions on response bodies.
| [http://yaoweibin.cn Weibin Yao]
| [http://code.google.com/p/substitutions4nginx/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_supervisord/ Supervisord]
| Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_supervisord/ Download]
|-
| [http://www.grid.net.ru/nginx/upload.en.html Upload]
| Parses <code>multipart/form-data</code> allowing arbitrary handling of uploaded files.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/upload.en.html#download Download]
|-
| [[HttpUploadProgressModule|Upload Progress]]
| Tracks and reports upload progress.
| Brice Figureau
| [http://github.com/masterzen/nginx-upload-progress-module/downloads Download]
|-
| [[HttpUpstreamConsistentHash|Upstream Consistent Hash]]
| Select backend based on Consistent hash ring.
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_consistent_hash Download]
|-
| [[HttpUpstreamFairModule|Upstream Fair Balancer]]
| Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.
| Gregory Nosek
| [http://github.com/gnosek/nginx-upstream-fair Download]
|-
| [[HttpUpstreamRequestHashModule|Upstream Hash]]
| Provides simple upstream load distribution by hashing a configurable variable.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/nginx_upstream_hash/ Download]
|-
| [[HttpUpstreamKeepaliveModule|Upstream Keepalive]]
| Provides keep-alive connections to memcached upstreams.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_upstream_keepalive/ Download]
|-
| [https://github.com/wandenberg/nginx-video-thumbextractor-module Video Thumb Extractor]
| Nginx module to extract thumbs from a video file.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-video-thumbextractor-module/downloads Download]
|-
| [[NgxWSGIModule|WSGI]]
| [http://en.wikipedia.org/wiki/Wsgi WSGI] implementation for Nginx. Allows easy deployment of Python applications.
| Manlio Perillo
| [http://hg.mperillo.ath.cx/nginx/mod_wsgi/ Download]
|-
| [http://github.com/agentzh/xss-nginx-module XSS]
| Native support for cross-site scripting (XSS) in an nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/xss-nginx-module/tags Download]
|-
| [[NgxZip|Zip]]
| Assemble ZIP archives on the fly.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/mod_zip/ Download]
|-
| [[Extended status module|Extended status module]]
| Extended status module for nginx
| 최영석(Choi Youngseok), 李金虎(Li Jinhu)
| [http://github.com/zealot83/ngx_http_extended_status_module Download]
|-
|}

== Tools for module developers ==
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [http://github.com/simpl/ngx_auto_lib Nginx Auto Lib Core]
| Reusable file for module developers to include with their modules to easily and consistently handle including external libraries; used in the Auto Lib module and included in the Nginx Development Kit
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/downloads Download]
|-
| [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/downloads Download]
|}

= Third party patches =
These patches must be applied to the Nginx source code tree. There's no guarantee these patches will apply to a particular version of Nginx.

As with third party modules, these patches are not officially supported. Your mileage may vary.

{| class="modules-index-table"
! Description
! Author
! Link
|-
| Log to syslog.
| Marlon de Boer
| [http://bugs.gentoo.org/attachment.cgi?id=197180 Patch against 0.8.4] (works on 0.7.x and 0.8.x) | [http://dl.dropbox.com/u/5836407/Patches/Nginx_0.8.49-syslog-support.txt Patch for version 0.8.49 with 'sh is not bash' fix] | [https://github.com/yaoweibin/nginx_syslog_patch Syslog Patch for Nginx 0.8.54+]
|-
| Disable nginx's memory pool to help valgrind and other tools (for nginx C developers only)
| [http://github.com/shrimp/ shrimp], [http://agentzh.spaces.live.com/ agentzh]
| [http://github.com/shrimp/no-pool-nginx Git repository for the patch]
|-
| SSL Session tickets distributed via memcached
| [http://hezmatt.org/~mpalmer/blog/2011/07/24/followup-to-ssl-session-caching-with-nginx.html Matthew Palmer]
| [https://github.com/mpalmer/nginx Git repository for changes]
|}

= References =
* [http://github.com/search?type=Repositories&language=c&q=nginx&repo=&langOverride=&x=13&y=17&start_value=1 github search]

3rdPartyModules

2012-05-03T00:23:32Z

Admin: /* Tools for module developers */

= Third party modules =
These modules are not officially supported. Nevertheless many of them may prove useful to many people. Enjoy at your own risk.

== Compiling third party modules ==
Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

<pre>
./configure --add-module=/path/to/module1/source \
--add-module=/path/to/module2/source
</pre>

You can use as many <code>--add-module</code> arguments as needed.

Be aware that some modules may require additional libraries to be installed on your system.

== Writing your own module ==
[http://www.evanmiller.org/ Evan Miller] has written the [http://www.evanmiller.org/nginx-modules-guide.html definitive guide] to Nginx module development. But some parts of it are a little out of date. You've been warned.

A github search turned up the [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]. It seems to be more up to date.

See also the tools at the bottom of this page.

= Known modules =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [[AcceptLanguageModule|Accept Language]]
| Parses the <code>Accept-Language</code> header and gives the most suitable locale from a list of supported locales.
| Guillaume Maury
| [http://github.com/giom/nginx_accept_language_module Download]
|-
| [[HttpAccessKeyModule|Access Key]]
| Denies access unless the request URL contains an access key.
| Mykola Grechukh
| [http://wiki.nginx.org/File:Nginx-accesskey-2.0.3.tar.gz Download]
|-
| [http://github.com/rsms/afcgi AFCGI]
| Asynchronous/multiplexing FastCGI for nginx (incl. ref server implementation)
| [http://github.com/rsms rsms]
| [http://github.com/rsms/afcgi Download]
|-
| [http://github.com/agentzh/array-var-nginx-module Array Var]
| Add support for array variables to nginx config files
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/array-var-nginx-module/tags Download]
|-
| [[HttpAuthDigestModule|Auth Digest]]
| HTTP Digest Authentication.
| [http://samizdat.cc Christian Swinehart]
| [https://github.com/samizdatco/nginx-http-auth-digest Download]
|-
| [http://web.iti.upv.es/~sto/nginx/ Auth PAM]
| HTTP Basic Authentication using PAM.
| Sergio Talens-Oliag
| [http://web.iti.upv.es/~sto/nginx/ngx_http_auth_pam_module-1.2.tar.gz Download]
|-
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Auth Request]
| Allows authorization based on subrequest result.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Download]
|-
| [http://github.com/simpl/ngx_auto_lib Auto Lib]
| Reuse pre-compiled/installed versions of OpenSSL, PCRE and Zlib without re-compiling them each time Nginx is compiled
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/tags Download]
|-
| [http://github.com/anomalizer/ngx_aws_auth AWS auth]
| Generate security headers for GET requests to Amazon S3.
| [http://anomalizer.net/statistically-incorrect Arvind Jayaprakash]
| [http://github.com/anomalizer/ngx_aws_auth/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Cache Purge]
| Module adding ability to purge content from FastCGI, proxy, and uWSGI caches.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Download]
|-
| [[HttpChunkinModule|Chunkin]]
| HTTP 1.1 chunked-encoding request body support for Nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/chunkin-nginx-module/tags Download]
|-
| [[HttpCircleGifModule|Circle GIF]]
| Generates simple circle images with the colors and size specified in the URL.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/nginx_circle_gif/ Download]
|-
| [http://ngx-ctpp.vbart.info/ CT++]
| Embeds [http://ctpp.havoc.ru/en/whatis.html CT++ (or CTPP2)] VM, the execution part of a high-performance template engine system.
| [http://vbart.info/ Valentin V. Bartenev]
| [http://dl.vbart.ru/ngx-ctpp/ngx_ctpp2-0.5.tar.gz Download]
|-
| [http://github.com/simpl/ngx_devel_kit Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/tags Download]
|-
| [[HttpDrizzleModule|Drizzle]]
| Make nginx talk directly to mysql and drizzle by libdrizzle.
| [http://github.com/chaoslawful/ chaoslawful], [http://agentzh.org/ agentzh], Piotr Sikora
| [http://github.com/chaoslawful/drizzle-nginx-module/tags Download]
|-
| [http://github.com/kali/nginx-dynamic-etags Dynamic etags]
| Nginx module for etags on dynamic content
| [http://github.com/kali kali]
| [http://github.com/kali/nginx-dynamic-etags Download]
|-
| [[HttpEchoModule|Echo]]
| Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/echo-nginx-module/tags Download]
|-
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Enhanced Memcached]
| Repackaging of the standard memcached module to add features : custom http headers, hash keys, store entries in memcached with post http request, flush, key namespace
| [https://github.com/bpaquet Bertrand Paquet]
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Download]
|-
| [http://github.com/agentzh/encrypted-session-nginx-module Encrypted Session]
| encrypt and decrypt nginx variable values, can be used for light-weight session-based authentication
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/encrypted-session-nginx-module/tags Download]
|-
| [http://github.com/vkholodkov/nginx-eval-module Eval]
| A module for evaluating memcached or proxy response into variable.
| [http://github.com/vkholodkov/ vkholodkov]
| [http://github.com/vkholodkov/nginx-eval-module Download]
|-
| [http://github.com/agentzh/nginx-eval-module Eval (agentzh's fork)]
| Enhanced ngx_eval that can capture arbitrary subrequest's responses into nginx variables (can even with output filters enabled)
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/nginx-eval-module/tags Download]
|-
| [[Expressz|Expressz]]
| First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).
| [http://www.acronymlabs.com/ Jason Giedymin at AcronymLabs]
|-
| [http://github.com/ry/nginx-ey-balancer/tree/master EY Balancer]
| Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.
| Ry Dahl
| [http://github.com/ry/nginx-ey-balancer/tarball/master Download]
|-
| [http://wiki.nginx.org/NgxFancyIndex Fancy Indexes]
| Like the built-in [[Modules#HTTP_Auto_Index|autoindex]] module, but fancier.
| Adrian Perez de Castro
| [http://gitorious.org/ngx-fancyindex/ngx-fancyindex Download]
|-
| [[HttpFormInputModule|Form Input]]
| This module reads HTTP POST request body and parse the arguments into nginx variables.
| [http://vimedia.org/ Calio], [http://agentzh.org agentzh]
| [http://github.com/calio/form-input-nginx-module/tags Download]
|-
| [[Http3rdPartyGeoIPModule|GeoIP]]
| Country code lookups via the [http://www.maxmind.com/ MaxMind] GeoIP API.
| [http://www.spilgames.com/ SPIL GAMES]
| [[File:Nginx-geoip-0.2.tar.gz|Download]]
|-
| [http://github.com/mdirolf/nginx-gridfs GridFS]
| Nginx module for serving files from MongoDB's GridFS.
| [http://github.com/mdirolf mdirolf]
| [http://github.com/mdirolf/nginx-gridfs Download]
|-
| [[HttpHeadersMoreModule|Headers More]]
| Set and clear input and output headers...more than "add"!
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/headers-more-nginx-module/tags Download]
|-
| [[HttpHealthcheckModule|HTTP Healthcheck]]
| Health check HTTP servers inside an upstream so you don't forward requests to bad hosts
| Jack Lindamood
|
|-
| [https://github.com/Lax/ngx_http_accounting_module HTTP Accounting]
| Realtime netflow and status code monitor solution for nginx, need less memory and cpu than realtime log analyzing. Useful for http traffic accounting based on nginx config logic ( per-location-traffic or per-server-traffic ).
| [http://www.liulantao.com/portal/ Liu Lantao]
| [https://github.com/Lax/ngx_http_accounting_module Download]
|-
| [http://pushmodule.slact.net/ HTTP Push]
| Turn Nginx into an adept long-polling HTTP Push (Comet) server.
| Leo Ponomarev
| [http://pushmodule.slact.net/downloads/nginx_http_push_module-0.69.tar.gz Download]
|-
| [[HttpPushStreamModule|HTTP Push Stream]]
| Turn Nginx into an adept stream HTTP Push (Comet) server.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-push-stream-module/downloads Download]
|-
| [[HttpRedis|HTTP Redis]]
| [http://redis.io/ Redis] support.
| Sergey A. Osokin <osa@FreeBSD.ORG.ru>
| [http://people.FreeBSD.ORG/~osa/ngx_http_redis-0.3.5.tar.gz Download]
|-
| [https://github.com/kung-fu-tzu/ngx_http_js_module#readme JavaScript]
| Embedding [http://www.mozilla.org/js/spidermonkey/ SpiderMonkey]. Full port of Perl module and more.
| [https://github.com/kung-fu-tzu Peter Leonov]
| [https://github.com/kung-fu-tzu/ngx_http_js_module/downloads Download]
|-
| [[HttpIconvModule|Iconv]]
| A character encoding conversion nginx module using libiconv.
| [http://vimedia.org/ Calio], [http://agentzh.org/ agentzh]
| [http://github.com/calio/iconv-nginx-module/tags Download]
|-
| [[HttpLogRequestSpeed|Log Request Speed]]
| Log the time it took to process each request.
| [https://github.com/replay Mauro Stettler]
|
|-
| [https://github.com/replay/ngx_http_lower_upper_case Lower Upper Case]
| Simple module to upper-/lowercase a string in the Nginx config
| [https://github.com/replay Mauro Stettler]
| [https://github.com/replay/ngx_http_lower_upper_case Download]
|-
| [http://wiki.nginx.org/HttpLuaModule Lua]
| Embed the power of Lua into nginx
| [http://github.com/chaoslawful chaoslawful], [http://agentzh.org/ agentzh]
| [http://github.com/chaoslawful/lua-nginx-module/tags Download]
|-
| [https://github.com/alacner/nginx_lua_module Luafile]
| Embed the power of Lua into nginx very easy.
| [http://alacner.com alacner]
| [https://github.com/alacner/nginx_lua_module/tarball/master Download]
|-
| [[HttpMemcModule|Memc]]
| An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/memc-nginx-module/tags Download]
|-
| [http://www.grid.net.ru/nginx/mogilefs.en.html Mogilefs]
| Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/download/nginx_mogilefs_module-1.0.2.tar.gz Download]
|-
| [[MP4StreamingLite|MP4 Streaming Lite]]
| Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.
| Jiang Hong
| [[MP4StreamingLite|Download]]
|-
| [http://naxsi.googlecode.com Naxsi]
| Web Application Firewall for nginx.
| Thibault Koechlin
| [http://naxsi.googlecode.com Download]
|-
| [http://xph.us/software/nginx-notice/ Notice]
| Serve static file to POST requests.
| Keith Rarick
| [http://xph.us/software/nginx-notice/nginx-notice-2.tar.gz Download]
|-
| [http://wiki.nginx.org/HttpOwnerMatchModule OwnerMatch]
| This module provides a simple file owner-based access control.
| [https://heiher.info Heiher]
| [http://heiher.info/sftp/files/Nginx-0.8.54-Add-OwnerMatch-module.patch Download]
|-
| [http://mauro-stettler.blogspot.com/2011/08/pecl-memcache-standard-loadbalancer-for.html PHP-Memache Standard Hash]
| This is a loadbalancer that imitates the PHP-Memcache standard hash's behaviour
| Mauro Stettler
| [https://github.com/replay/ngx_http_php_memcache_standard_balancer Download]
|-
| [https://github.com/replay/ngx_http_php_session PHP Session Parser]
| Extract values that are stored in a serialized PHP session
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_php_session Download]
|-
| [http://labs.frickle.com/nginx_ngx_postgres/ Postgres]
| Upstream module that allows nginx to communicate directly with PostgreSQL database.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_postgres/ Download]
|-
| [http://vitki.net/pubcookie Pubcookie]
| Adds [http://www.pubcookie.org Pubcookie]-based cross-site authentication method to Nginx.
| [http://www.vitki.net/ Vitki]
| [http://vitki.net/pubcookie#Installation Download]
|-
| [http://github.com/agentzh/rds-csv-nginx-module RDS CSV]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit Comma-Separated Values (CSV).
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-csv-nginx-module/tags Download]
|-
| [http://github.com/agentzh/rds-json-nginx-module RDS JSON]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit JSON data.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-json-nginx-module/tags Download]
|-
| [[HttpRedis2Module|Redis2]]
| Upstream module for the full [http://redis.io/ Redis] 2.0 protocol
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/redis2-nginx-module/tags Download]
|-
| [https://github.com/yuri-gushin/Roboo Roboo]
| HTTP Robot mitigator utilizing advanced non-interactive HTTP challenge/response mechanisms
| [http://www.ecl-labs.org/ Yuri Gushin, Alex Behar]
| [https://github.com/yuri-gushin/Roboo/downloads Download]
|-
| [[NginxNgx_rrd_graph|RRD Graph]]
| This module provides an HTTP interface to [http://oss.oetiker.ch/rrdtool/ RRDtool]'s graphing facilities.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/mod_rrd_graph Download]
|-
| [[HttpSecureDownload|Secure Download]]
| Create expiring links.
| [https://github.com/replay Mauro Stettler], Szymon Modzelewski
| [http://github.com/replay/ngx_http_secure_download Download]
|-
| [http://github.com/liseen/set-cconv-nginx-module/ Set CConv]
| Conversion between Simplified Chinese and Traditional Chinese at rewrite phase
| [http://github.com/liseen/ Liseen Wan]
| [http://github.com/liseen/set-cconv-nginx-module/ Download]
|-
| [http://github.com/simpl/ngx_http_set_hash Set Hash]
| Set a variable to a variety of hash functions (upper/lowercase), including MD5, SHA1 and Murmurhash 2
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_hash/tags Download]
|-
| [http://github.com/simpl/ngx_http_set_lang Set Lang]
| Set a variable to indicate the language based on a variety of sources including cookies, GET/POST variables, Accept Language header and more
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_lang/downloads Download]
|-
| [http://wiki.nginx.org/HttpSetMiscModule Set Misc]
| Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)
| [http://agentzh.org agentzh], [http://vimedia.org/ Calio], [http://github.com/shrimp/ shrimp]
| [http://github.com/agentzh/set-misc-nginx-module/tags Download]
|-
| [http://nginx-sflow-module.googlecode.com sFlow]
| Operational performance monitoring with standard [http://sflow.org sFlow] protocol
| Neil McKee
| [http://code.google.com/p/nginx-sflow-module/downloads/list Download]
|-
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ SlowFS Cache]
| Module adding ability to cache static files.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ Download]
|-
| [https://github.com/muhgatus/spnego-http-auth-nginx-module SPNEGO]
| Support for SPNEGO/gssapi in nginx.
| [https://github.com/mike503 mike503]/[https://github.com/muhgatus/ muhgatus]
| [https://github.com/muhgatus/spnego-http-auth-nginx-module Download]
|-
| [http://wiki.nginx.org/HttpSRCacheModule SR Cache]
| Transparent subrequest-based caching layout for arbitrary nginx locations (can be used with ngx_memc + memcached!)
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/srcache-nginx-module/tags Download]
|-
| [http://github.com/mikewest/nginx-static-etags Static etags]
| Nginx doesn't generate etags for static content. I'd like it to. Let's see if I can remember some C from college.
| [http://github.com/mikewest mikewest]
| [http://github.com/mikewest/nginx-static-etags Download]
|-
| [https://github.com/zebrafishlabs/nginx-statsd Statsd]
| Adds the ability for Nginx to interacting with statsd.
| [https://github.com/zebrafishlabs zebrafishlabs]
| [https://github.com/zebrafishlabs/nginx-statsd Download]
|-
| [http://code.google.com/p/nginx-sticky-module/ Sticky upstream]
| A nginx module to add an upstream server persistance using cookies.
| [http://code.google.com/u/jerome@loyet.net/ Jérôme Loyet]
| [http://code.google.com/p/nginx-sticky-module/downloads/list Download]
|-
| [[HttpStripModule|Strip]]
| Whitespace remover.
| [http://evanmiller.org Evan Miller]
| [[File:mod_strip-0.1.tar.gz|Download]]
|-
| [http://wiki.nginx.org/HttpSubsModule Substitutions]
| A filter module which can do both regular expression and fixed string substitutions on response bodies.
| [http://yaoweibin.cn Weibin Yao]
| [http://code.google.com/p/substitutions4nginx/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_supervisord/ Supervisord]
| Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_supervisord/ Download]
|-
| [http://www.grid.net.ru/nginx/upload.en.html Upload]
| Parses <code>multipart/form-data</code> allowing arbitrary handling of uploaded files.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/upload.en.html#download Download]
|-
| [[HttpUploadProgressModule|Upload Progress]]
| Tracks and reports upload progress.
| Brice Figureau
| [http://github.com/masterzen/nginx-upload-progress-module/downloads Download]
|-
| [[HttpUpstreamConsistentHash|Upstream Consistent Hash]]
| Select backend based on Consistent hash ring.
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_consistent_hash Download]
|-
| [[HttpUpstreamFairModule|Upstream Fair Balancer]]
| Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.
| Gregory Nosek
| [http://github.com/gnosek/nginx-upstream-fair Download]
|-
| [[HttpUpstreamRequestHashModule|Upstream Hash]]
| Provides simple upstream load distribution by hashing a configurable variable.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/nginx_upstream_hash/ Download]
|-
| [[HttpUpstreamKeepaliveModule|Upstream Keepalive]]
| Provides keep-alive connections to memcached upstreams.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_upstream_keepalive/ Download]
|-
| [https://github.com/wandenberg/nginx-video-thumbextractor-module Video Thumb Extractor]
| Nginx module to extract thumbs from a video file.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-video-thumbextractor-module/downloads Download]
|-
| [[NgxWSGIModule|WSGI]]
| [http://en.wikipedia.org/wiki/Wsgi WSGI] implementation for Nginx. Allows easy deployment of Python applications.
| Manlio Perillo
| [http://hg.mperillo.ath.cx/nginx/mod_wsgi/ Download]
|-
| [http://github.com/agentzh/xss-nginx-module XSS]
| Native support for cross-site scripting (XSS) in an nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/xss-nginx-module/tags Download]
|-
| [[NgxZip|Zip]]
| Assemble ZIP archives on the fly.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/mod_zip/ Download]
|-
| [[Extended status module|Extended status module]]
| Extended status module for nginx
| 최영석(Choi Youngseok), 李金虎(Li Jinhu)
| [http://github.com/zealot83/ngx_http_extended_status_module Download]
|-
|}

== Tools for module developers ==
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [http://github.com/simpl/ngx_auto_lib Nginx Auto Lib Core]
| Reusable file for module developers to include with their modules to easily and consistently handle including external libraries; used in the Auto Lib module and included in the Nginx Development Kit
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/downloads Download]
|-
| [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/downloads Download]
|}

= Third party patches =
These patches must be applied to the Nginx source code tree. There's no guarantee these patches will apply to a particular version of Nginx.

As with third party modules, these patches are not officially supported. Your mileage may vary.

{|
! Description
! Author
! Link
|-
| Log to syslog.
| Marlon de Boer
| [http://bugs.gentoo.org/attachment.cgi?id=197180 Patch against 0.8.4] (works on 0.7.x and 0.8.x) | [http://dl.dropbox.com/u/5836407/Patches/Nginx_0.8.49-syslog-support.txt Patch for version 0.8.49 with 'sh is not bash' fix] | [https://github.com/yaoweibin/nginx_syslog_patch Syslog Patch for Nginx 0.8.54+]
|-
| Disable nginx's memory pool to help valgrind and other tools (for nginx C developers only)
| [http://github.com/shrimp/ shrimp], [http://agentzh.spaces.live.com/ agentzh]
| [http://github.com/shrimp/no-pool-nginx Git repository for the patch]
|-
| SSL Session tickets distributed via memcached
| [http://hezmatt.org/~mpalmer/blog/2011/07/24/followup-to-ssl-session-caching-with-nginx.html Matthew Palmer]
| [https://github.com/mpalmer/nginx Git repository for changes]
|}

= References =
* [http://github.com/search?type=Repositories&language=c&q=nginx&repo=&langOverride=&x=13&y=17&start_value=1 github search]

3rdPartyModules

2012-05-03T00:23:14Z

Admin: /* Known modules */

= Third party modules =
These modules are not officially supported. Nevertheless many of them may prove useful to many people. Enjoy at your own risk.

== Compiling third party modules ==
Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

<pre>
./configure --add-module=/path/to/module1/source \
--add-module=/path/to/module2/source
</pre>

You can use as many <code>--add-module</code> arguments as needed.

Be aware that some modules may require additional libraries to be installed on your system.

== Writing your own module ==
[http://www.evanmiller.org/ Evan Miller] has written the [http://www.evanmiller.org/nginx-modules-guide.html definitive guide] to Nginx module development. But some parts of it are a little out of date. You've been warned.

A github search turned up the [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]. It seems to be more up to date.

See also the tools at the bottom of this page.

= Known modules =
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [[AcceptLanguageModule|Accept Language]]
| Parses the <code>Accept-Language</code> header and gives the most suitable locale from a list of supported locales.
| Guillaume Maury
| [http://github.com/giom/nginx_accept_language_module Download]
|-
| [[HttpAccessKeyModule|Access Key]]
| Denies access unless the request URL contains an access key.
| Mykola Grechukh
| [http://wiki.nginx.org/File:Nginx-accesskey-2.0.3.tar.gz Download]
|-
| [http://github.com/rsms/afcgi AFCGI]
| Asynchronous/multiplexing FastCGI for nginx (incl. ref server implementation)
| [http://github.com/rsms rsms]
| [http://github.com/rsms/afcgi Download]
|-
| [http://github.com/agentzh/array-var-nginx-module Array Var]
| Add support for array variables to nginx config files
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/array-var-nginx-module/tags Download]
|-
| [[HttpAuthDigestModule|Auth Digest]]
| HTTP Digest Authentication.
| [http://samizdat.cc Christian Swinehart]
| [https://github.com/samizdatco/nginx-http-auth-digest Download]
|-
| [http://web.iti.upv.es/~sto/nginx/ Auth PAM]
| HTTP Basic Authentication using PAM.
| Sergio Talens-Oliag
| [http://web.iti.upv.es/~sto/nginx/ngx_http_auth_pam_module-1.2.tar.gz Download]
|-
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Auth Request]
| Allows authorization based on subrequest result.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Download]
|-
| [http://github.com/simpl/ngx_auto_lib Auto Lib]
| Reuse pre-compiled/installed versions of OpenSSL, PCRE and Zlib without re-compiling them each time Nginx is compiled
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/tags Download]
|-
| [http://github.com/anomalizer/ngx_aws_auth AWS auth]
| Generate security headers for GET requests to Amazon S3.
| [http://anomalizer.net/statistically-incorrect Arvind Jayaprakash]
| [http://github.com/anomalizer/ngx_aws_auth/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Cache Purge]
| Module adding ability to purge content from FastCGI, proxy, and uWSGI caches.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Download]
|-
| [[HttpChunkinModule|Chunkin]]
| HTTP 1.1 chunked-encoding request body support for Nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/chunkin-nginx-module/tags Download]
|-
| [[HttpCircleGifModule|Circle GIF]]
| Generates simple circle images with the colors and size specified in the URL.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/nginx_circle_gif/ Download]
|-
| [http://ngx-ctpp.vbart.info/ CT++]
| Embeds [http://ctpp.havoc.ru/en/whatis.html CT++ (or CTPP2)] VM, the execution part of a high-performance template engine system.
| [http://vbart.info/ Valentin V. Bartenev]
| [http://dl.vbart.ru/ngx-ctpp/ngx_ctpp2-0.5.tar.gz Download]
|-
| [http://github.com/simpl/ngx_devel_kit Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/tags Download]
|-
| [[HttpDrizzleModule|Drizzle]]
| Make nginx talk directly to mysql and drizzle by libdrizzle.
| [http://github.com/chaoslawful/ chaoslawful], [http://agentzh.org/ agentzh], Piotr Sikora
| [http://github.com/chaoslawful/drizzle-nginx-module/tags Download]
|-
| [http://github.com/kali/nginx-dynamic-etags Dynamic etags]
| Nginx module for etags on dynamic content
| [http://github.com/kali kali]
| [http://github.com/kali/nginx-dynamic-etags Download]
|-
| [[HttpEchoModule|Echo]]
| Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/echo-nginx-module/tags Download]
|-
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Enhanced Memcached]
| Repackaging of the standard memcached module to add features : custom http headers, hash keys, store entries in memcached with post http request, flush, key namespace
| [https://github.com/bpaquet Bertrand Paquet]
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Download]
|-
| [http://github.com/agentzh/encrypted-session-nginx-module Encrypted Session]
| encrypt and decrypt nginx variable values, can be used for light-weight session-based authentication
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/encrypted-session-nginx-module/tags Download]
|-
| [http://github.com/vkholodkov/nginx-eval-module Eval]
| A module for evaluating memcached or proxy response into variable.
| [http://github.com/vkholodkov/ vkholodkov]
| [http://github.com/vkholodkov/nginx-eval-module Download]
|-
| [http://github.com/agentzh/nginx-eval-module Eval (agentzh's fork)]
| Enhanced ngx_eval that can capture arbitrary subrequest's responses into nginx variables (can even with output filters enabled)
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/nginx-eval-module/tags Download]
|-
| [[Expressz|Expressz]]
| First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).
| [http://www.acronymlabs.com/ Jason Giedymin at AcronymLabs]
|-
| [http://github.com/ry/nginx-ey-balancer/tree/master EY Balancer]
| Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.
| Ry Dahl
| [http://github.com/ry/nginx-ey-balancer/tarball/master Download]
|-
| [http://wiki.nginx.org/NgxFancyIndex Fancy Indexes]
| Like the built-in [[Modules#HTTP_Auto_Index|autoindex]] module, but fancier.
| Adrian Perez de Castro
| [http://gitorious.org/ngx-fancyindex/ngx-fancyindex Download]
|-
| [[HttpFormInputModule|Form Input]]
| This module reads HTTP POST request body and parse the arguments into nginx variables.
| [http://vimedia.org/ Calio], [http://agentzh.org agentzh]
| [http://github.com/calio/form-input-nginx-module/tags Download]
|-
| [[Http3rdPartyGeoIPModule|GeoIP]]
| Country code lookups via the [http://www.maxmind.com/ MaxMind] GeoIP API.
| [http://www.spilgames.com/ SPIL GAMES]
| [[File:Nginx-geoip-0.2.tar.gz|Download]]
|-
| [http://github.com/mdirolf/nginx-gridfs GridFS]
| Nginx module for serving files from MongoDB's GridFS.
| [http://github.com/mdirolf mdirolf]
| [http://github.com/mdirolf/nginx-gridfs Download]
|-
| [[HttpHeadersMoreModule|Headers More]]
| Set and clear input and output headers...more than "add"!
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/headers-more-nginx-module/tags Download]
|-
| [[HttpHealthcheckModule|HTTP Healthcheck]]
| Health check HTTP servers inside an upstream so you don't forward requests to bad hosts
| Jack Lindamood
|
|-
| [https://github.com/Lax/ngx_http_accounting_module HTTP Accounting]
| Realtime netflow and status code monitor solution for nginx, need less memory and cpu than realtime log analyzing. Useful for http traffic accounting based on nginx config logic ( per-location-traffic or per-server-traffic ).
| [http://www.liulantao.com/portal/ Liu Lantao]
| [https://github.com/Lax/ngx_http_accounting_module Download]
|-
| [http://pushmodule.slact.net/ HTTP Push]
| Turn Nginx into an adept long-polling HTTP Push (Comet) server.
| Leo Ponomarev
| [http://pushmodule.slact.net/downloads/nginx_http_push_module-0.69.tar.gz Download]
|-
| [[HttpPushStreamModule|HTTP Push Stream]]
| Turn Nginx into an adept stream HTTP Push (Comet) server.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-push-stream-module/downloads Download]
|-
| [[HttpRedis|HTTP Redis]]
| [http://redis.io/ Redis] support.
| Sergey A. Osokin <osa@FreeBSD.ORG.ru>
| [http://people.FreeBSD.ORG/~osa/ngx_http_redis-0.3.5.tar.gz Download]
|-
| [https://github.com/kung-fu-tzu/ngx_http_js_module#readme JavaScript]
| Embedding [http://www.mozilla.org/js/spidermonkey/ SpiderMonkey]. Full port of Perl module and more.
| [https://github.com/kung-fu-tzu Peter Leonov]
| [https://github.com/kung-fu-tzu/ngx_http_js_module/downloads Download]
|-
| [[HttpIconvModule|Iconv]]
| A character encoding conversion nginx module using libiconv.
| [http://vimedia.org/ Calio], [http://agentzh.org/ agentzh]
| [http://github.com/calio/iconv-nginx-module/tags Download]
|-
| [[HttpLogRequestSpeed|Log Request Speed]]
| Log the time it took to process each request.
| [https://github.com/replay Mauro Stettler]
|
|-
| [https://github.com/replay/ngx_http_lower_upper_case Lower Upper Case]
| Simple module to upper-/lowercase a string in the Nginx config
| [https://github.com/replay Mauro Stettler]
| [https://github.com/replay/ngx_http_lower_upper_case Download]
|-
| [http://wiki.nginx.org/HttpLuaModule Lua]
| Embed the power of Lua into nginx
| [http://github.com/chaoslawful chaoslawful], [http://agentzh.org/ agentzh]
| [http://github.com/chaoslawful/lua-nginx-module/tags Download]
|-
| [https://github.com/alacner/nginx_lua_module Luafile]
| Embed the power of Lua into nginx very easy.
| [http://alacner.com alacner]
| [https://github.com/alacner/nginx_lua_module/tarball/master Download]
|-
| [[HttpMemcModule|Memc]]
| An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/memc-nginx-module/tags Download]
|-
| [http://www.grid.net.ru/nginx/mogilefs.en.html Mogilefs]
| Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/download/nginx_mogilefs_module-1.0.2.tar.gz Download]
|-
| [[MP4StreamingLite|MP4 Streaming Lite]]
| Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.
| Jiang Hong
| [[MP4StreamingLite|Download]]
|-
| [http://naxsi.googlecode.com Naxsi]
| Web Application Firewall for nginx.
| Thibault Koechlin
| [http://naxsi.googlecode.com Download]
|-
| [http://xph.us/software/nginx-notice/ Notice]
| Serve static file to POST requests.
| Keith Rarick
| [http://xph.us/software/nginx-notice/nginx-notice-2.tar.gz Download]
|-
| [http://wiki.nginx.org/HttpOwnerMatchModule OwnerMatch]
| This module provides a simple file owner-based access control.
| [https://heiher.info Heiher]
| [http://heiher.info/sftp/files/Nginx-0.8.54-Add-OwnerMatch-module.patch Download]
|-
| [http://mauro-stettler.blogspot.com/2011/08/pecl-memcache-standard-loadbalancer-for.html PHP-Memache Standard Hash]
| This is a loadbalancer that imitates the PHP-Memcache standard hash's behaviour
| Mauro Stettler
| [https://github.com/replay/ngx_http_php_memcache_standard_balancer Download]
|-
| [https://github.com/replay/ngx_http_php_session PHP Session Parser]
| Extract values that are stored in a serialized PHP session
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_php_session Download]
|-
| [http://labs.frickle.com/nginx_ngx_postgres/ Postgres]
| Upstream module that allows nginx to communicate directly with PostgreSQL database.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_postgres/ Download]
|-
| [http://vitki.net/pubcookie Pubcookie]
| Adds [http://www.pubcookie.org Pubcookie]-based cross-site authentication method to Nginx.
| [http://www.vitki.net/ Vitki]
| [http://vitki.net/pubcookie#Installation Download]
|-
| [http://github.com/agentzh/rds-csv-nginx-module RDS CSV]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit Comma-Separated Values (CSV).
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-csv-nginx-module/tags Download]
|-
| [http://github.com/agentzh/rds-json-nginx-module RDS JSON]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit JSON data.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-json-nginx-module/tags Download]
|-
| [[HttpRedis2Module|Redis2]]
| Upstream module for the full [http://redis.io/ Redis] 2.0 protocol
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/redis2-nginx-module/tags Download]
|-
| [https://github.com/yuri-gushin/Roboo Roboo]
| HTTP Robot mitigator utilizing advanced non-interactive HTTP challenge/response mechanisms
| [http://www.ecl-labs.org/ Yuri Gushin, Alex Behar]
| [https://github.com/yuri-gushin/Roboo/downloads Download]
|-
| [[NginxNgx_rrd_graph|RRD Graph]]
| This module provides an HTTP interface to [http://oss.oetiker.ch/rrdtool/ RRDtool]'s graphing facilities.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/mod_rrd_graph Download]
|-
| [[HttpSecureDownload|Secure Download]]
| Create expiring links.
| [https://github.com/replay Mauro Stettler], Szymon Modzelewski
| [http://github.com/replay/ngx_http_secure_download Download]
|-
| [http://github.com/liseen/set-cconv-nginx-module/ Set CConv]
| Conversion between Simplified Chinese and Traditional Chinese at rewrite phase
| [http://github.com/liseen/ Liseen Wan]
| [http://github.com/liseen/set-cconv-nginx-module/ Download]
|-
| [http://github.com/simpl/ngx_http_set_hash Set Hash]
| Set a variable to a variety of hash functions (upper/lowercase), including MD5, SHA1 and Murmurhash 2
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_hash/tags Download]
|-
| [http://github.com/simpl/ngx_http_set_lang Set Lang]
| Set a variable to indicate the language based on a variety of sources including cookies, GET/POST variables, Accept Language header and more
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_lang/downloads Download]
|-
| [http://wiki.nginx.org/HttpSetMiscModule Set Misc]
| Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)
| [http://agentzh.org agentzh], [http://vimedia.org/ Calio], [http://github.com/shrimp/ shrimp]
| [http://github.com/agentzh/set-misc-nginx-module/tags Download]
|-
| [http://nginx-sflow-module.googlecode.com sFlow]
| Operational performance monitoring with standard [http://sflow.org sFlow] protocol
| Neil McKee
| [http://code.google.com/p/nginx-sflow-module/downloads/list Download]
|-
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ SlowFS Cache]
| Module adding ability to cache static files.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ Download]
|-
| [https://github.com/muhgatus/spnego-http-auth-nginx-module SPNEGO]
| Support for SPNEGO/gssapi in nginx.
| [https://github.com/mike503 mike503]/[https://github.com/muhgatus/ muhgatus]
| [https://github.com/muhgatus/spnego-http-auth-nginx-module Download]
|-
| [http://wiki.nginx.org/HttpSRCacheModule SR Cache]
| Transparent subrequest-based caching layout for arbitrary nginx locations (can be used with ngx_memc + memcached!)
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/srcache-nginx-module/tags Download]
|-
| [http://github.com/mikewest/nginx-static-etags Static etags]
| Nginx doesn't generate etags for static content. I'd like it to. Let's see if I can remember some C from college.
| [http://github.com/mikewest mikewest]
| [http://github.com/mikewest/nginx-static-etags Download]
|-
| [https://github.com/zebrafishlabs/nginx-statsd Statsd]
| Adds the ability for Nginx to interacting with statsd.
| [https://github.com/zebrafishlabs zebrafishlabs]
| [https://github.com/zebrafishlabs/nginx-statsd Download]
|-
| [http://code.google.com/p/nginx-sticky-module/ Sticky upstream]
| A nginx module to add an upstream server persistance using cookies.
| [http://code.google.com/u/jerome@loyet.net/ Jérôme Loyet]
| [http://code.google.com/p/nginx-sticky-module/downloads/list Download]
|-
| [[HttpStripModule|Strip]]
| Whitespace remover.
| [http://evanmiller.org Evan Miller]
| [[File:mod_strip-0.1.tar.gz|Download]]
|-
| [http://wiki.nginx.org/HttpSubsModule Substitutions]
| A filter module which can do both regular expression and fixed string substitutions on response bodies.
| [http://yaoweibin.cn Weibin Yao]
| [http://code.google.com/p/substitutions4nginx/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_supervisord/ Supervisord]
| Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_supervisord/ Download]
|-
| [http://www.grid.net.ru/nginx/upload.en.html Upload]
| Parses <code>multipart/form-data</code> allowing arbitrary handling of uploaded files.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/upload.en.html#download Download]
|-
| [[HttpUploadProgressModule|Upload Progress]]
| Tracks and reports upload progress.
| Brice Figureau
| [http://github.com/masterzen/nginx-upload-progress-module/downloads Download]
|-
| [[HttpUpstreamConsistentHash|Upstream Consistent Hash]]
| Select backend based on Consistent hash ring.
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_consistent_hash Download]
|-
| [[HttpUpstreamFairModule|Upstream Fair Balancer]]
| Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.
| Gregory Nosek
| [http://github.com/gnosek/nginx-upstream-fair Download]
|-
| [[HttpUpstreamRequestHashModule|Upstream Hash]]
| Provides simple upstream load distribution by hashing a configurable variable.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/nginx_upstream_hash/ Download]
|-
| [[HttpUpstreamKeepaliveModule|Upstream Keepalive]]
| Provides keep-alive connections to memcached upstreams.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_upstream_keepalive/ Download]
|-
| [https://github.com/wandenberg/nginx-video-thumbextractor-module Video Thumb Extractor]
| Nginx module to extract thumbs from a video file.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-video-thumbextractor-module/downloads Download]
|-
| [[NgxWSGIModule|WSGI]]
| [http://en.wikipedia.org/wiki/Wsgi WSGI] implementation for Nginx. Allows easy deployment of Python applications.
| Manlio Perillo
| [http://hg.mperillo.ath.cx/nginx/mod_wsgi/ Download]
|-
| [http://github.com/agentzh/xss-nginx-module XSS]
| Native support for cross-site scripting (XSS) in an nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/xss-nginx-module/tags Download]
|-
| [[NgxZip|Zip]]
| Assemble ZIP archives on the fly.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/mod_zip/ Download]
|-
| [[Extended status module|Extended status module]]
| Extended status module for nginx
| 최영석(Choi Youngseok), 李金虎(Li Jinhu)
| [http://github.com/zealot83/ngx_http_extended_status_module Download]
|-
|}

== Tools for module developers ==
{|
! Name
! Description
! Author
! Link
|-
| [http://github.com/simpl/ngx_auto_lib Nginx Auto Lib Core]
| Reusable file for module developers to include with their modules to easily and consistently handle including external libraries; used in the Auto Lib module and included in the Nginx Development Kit
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/downloads Download]
|-
| [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/downloads Download]
|}

= Third party patches =
These patches must be applied to the Nginx source code tree. There's no guarantee these patches will apply to a particular version of Nginx.

As with third party modules, these patches are not officially supported. Your mileage may vary.

{|
! Description
! Author
! Link
|-
| Log to syslog.
| Marlon de Boer
| [http://bugs.gentoo.org/attachment.cgi?id=197180 Patch against 0.8.4] (works on 0.7.x and 0.8.x) | [http://dl.dropbox.com/u/5836407/Patches/Nginx_0.8.49-syslog-support.txt Patch for version 0.8.49 with 'sh is not bash' fix] | [https://github.com/yaoweibin/nginx_syslog_patch Syslog Patch for Nginx 0.8.54+]
|-
| Disable nginx's memory pool to help valgrind and other tools (for nginx C developers only)
| [http://github.com/shrimp/ shrimp], [http://agentzh.spaces.live.com/ agentzh]
| [http://github.com/shrimp/no-pool-nginx Git repository for the patch]
|-
| SSL Session tickets distributed via memcached
| [http://hezmatt.org/~mpalmer/blog/2011/07/24/followup-to-ssl-session-caching-with-nginx.html Matthew Palmer]
| [https://github.com/mpalmer/nginx Git repository for changes]
|}

= References =
* [http://github.com/search?type=Repositories&language=c&q=nginx&repo=&langOverride=&x=13&y=17&start_value=1 github search]

3rdPartyModules

2012-05-03T00:20:53Z

Admin: /* Known modules */

= Third party modules =
These modules are not officially supported. Nevertheless many of them may prove useful to many people. Enjoy at your own risk.

== Compiling third party modules ==
Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

<pre>
./configure --add-module=/path/to/module1/source \
--add-module=/path/to/module2/source
</pre>

You can use as many <code>--add-module</code> arguments as needed.

Be aware that some modules may require additional libraries to be installed on your system.

== Writing your own module ==
[http://www.evanmiller.org/ Evan Miller] has written the [http://www.evanmiller.org/nginx-modules-guide.html definitive guide] to Nginx module development. But some parts of it are a little out of date. You've been warned.

A github search turned up the [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]. It seems to be more up to date.

See also the tools at the bottom of this page.

== Known modules ==
{| class="modules-index-table"
! Name
! Description
! Author
! Link
|-
| [[AcceptLanguageModule|Accept Language]]
| Parses the <code>Accept-Language</code> header and gives the most suitable locale from a list of supported locales.
| Guillaume Maury
| [http://github.com/giom/nginx_accept_language_module Download]
|-
| [[HttpAccessKeyModule|Access Key]]
| Denies access unless the request URL contains an access key.
| Mykola Grechukh
| [http://wiki.nginx.org/File:Nginx-accesskey-2.0.3.tar.gz Download]
|-
| [http://github.com/rsms/afcgi AFCGI]
| Asynchronous/multiplexing FastCGI for nginx (incl. ref server implementation)
| [http://github.com/rsms rsms]
| [http://github.com/rsms/afcgi Download]
|-
| [http://github.com/agentzh/array-var-nginx-module Array Var]
| Add support for array variables to nginx config files
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/array-var-nginx-module/tags Download]
|-
| [[HttpAuthDigestModule|Auth Digest]]
| HTTP Digest Authentication.
| [http://samizdat.cc Christian Swinehart]
| [https://github.com/samizdatco/nginx-http-auth-digest Download]
|-
| [http://web.iti.upv.es/~sto/nginx/ Auth PAM]
| HTTP Basic Authentication using PAM.
| Sergio Talens-Oliag
| [http://web.iti.upv.es/~sto/nginx/ngx_http_auth_pam_module-1.2.tar.gz Download]
|-
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Auth Request]
| Allows authorization based on subrequest result.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_auth_request_module/ Download]
|-
| [http://github.com/simpl/ngx_auto_lib Auto Lib]
| Reuse pre-compiled/installed versions of OpenSSL, PCRE and Zlib without re-compiling them each time Nginx is compiled
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/tags Download]
|-
| [http://github.com/anomalizer/ngx_aws_auth AWS auth]
| Generate security headers for GET requests to Amazon S3.
| [http://anomalizer.net/statistically-incorrect Arvind Jayaprakash]
| [http://github.com/anomalizer/ngx_aws_auth/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Cache Purge]
| Module adding ability to purge content from FastCGI, proxy, and uWSGI caches.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_cache_purge/ Download]
|-
| [[HttpChunkinModule|Chunkin]]
| HTTP 1.1 chunked-encoding request body support for Nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/chunkin-nginx-module/tags Download]
|-
| [[HttpCircleGifModule|Circle GIF]]
| Generates simple circle images with the colors and size specified in the URL.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/nginx_circle_gif/ Download]
|-
| [http://ngx-ctpp.vbart.info/ CT++]
| Embeds [http://ctpp.havoc.ru/en/whatis.html CT++ (or CTPP2)] VM, the execution part of a high-performance template engine system.
| [http://vbart.info/ Valentin V. Bartenev]
| [http://dl.vbart.ru/ngx-ctpp/ngx_ctpp2-0.5.tar.gz Download]
|-
| [http://github.com/simpl/ngx_devel_kit Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/tags Download]
|-
| [[HttpDrizzleModule|Drizzle]]
| Make nginx talk directly to mysql and drizzle by libdrizzle.
| [http://github.com/chaoslawful/ chaoslawful], [http://agentzh.org/ agentzh], Piotr Sikora
| [http://github.com/chaoslawful/drizzle-nginx-module/tags Download]
|-
| [http://github.com/kali/nginx-dynamic-etags Dynamic etags]
| Nginx module for etags on dynamic content
| [http://github.com/kali kali]
| [http://github.com/kali/nginx-dynamic-etags Download]
|-
| [[HttpEchoModule|Echo]]
| Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/echo-nginx-module/tags Download]
|-
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Enhanced Memcached]
| Repackaging of the standard memcached module to add features : custom http headers, hash keys, store entries in memcached with post http request, flush, key namespace
| [https://github.com/bpaquet Bertrand Paquet]
| [https://github.com/bpaquet/ngx_http_enhanced_memcached_module Download]
|-
| [http://github.com/agentzh/encrypted-session-nginx-module Encrypted Session]
| encrypt and decrypt nginx variable values, can be used for light-weight session-based authentication
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/encrypted-session-nginx-module/tags Download]
|-
| [http://github.com/vkholodkov/nginx-eval-module Eval]
| A module for evaluating memcached or proxy response into variable.
| [http://github.com/vkholodkov/ vkholodkov]
| [http://github.com/vkholodkov/nginx-eval-module Download]
|-
| [http://github.com/agentzh/nginx-eval-module Eval (agentzh's fork)]
| Enhanced ngx_eval that can capture arbitrary subrequest's responses into nginx variables (can even with output filters enabled)
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/nginx-eval-module/tags Download]
|-
| [[Expressz|Expressz]]
| First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).
| [http://www.acronymlabs.com/ Jason Giedymin at AcronymLabs]
|-
| [http://github.com/ry/nginx-ey-balancer/tree/master EY Balancer]
| Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.
| Ry Dahl
| [http://github.com/ry/nginx-ey-balancer/tarball/master Download]
|-
| [http://wiki.nginx.org/NgxFancyIndex Fancy Indexes]
| Like the built-in [[Modules#HTTP_Auto_Index|autoindex]] module, but fancier.
| Adrian Perez de Castro
| [http://gitorious.org/ngx-fancyindex/ngx-fancyindex Download]
|-
| [[HttpFormInputModule|Form Input]]
| This module reads HTTP POST request body and parse the arguments into nginx variables.
| [http://vimedia.org/ Calio], [http://agentzh.org agentzh]
| [http://github.com/calio/form-input-nginx-module/tags Download]
|-
| [[Http3rdPartyGeoIPModule|GeoIP]]
| Country code lookups via the [http://www.maxmind.com/ MaxMind] GeoIP API.
| [http://www.spilgames.com/ SPIL GAMES]
| [[File:Nginx-geoip-0.2.tar.gz|Download]]
|-
| [http://github.com/mdirolf/nginx-gridfs GridFS]
| Nginx module for serving files from MongoDB's GridFS.
| [http://github.com/mdirolf mdirolf]
| [http://github.com/mdirolf/nginx-gridfs Download]
|-
| [[HttpHeadersMoreModule|Headers More]]
| Set and clear input and output headers...more than "add"!
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/headers-more-nginx-module/tags Download]
|-
| [[HttpHealthcheckModule|HTTP Healthcheck]]
| Health check HTTP servers inside an upstream so you don't forward requests to bad hosts
| Jack Lindamood
|
|-
| [https://github.com/Lax/ngx_http_accounting_module HTTP Accounting]
| Realtime netflow and status code monitor solution for nginx, need less memory and cpu than realtime log analyzing. Useful for http traffic accounting based on nginx config logic ( per-location-traffic or per-server-traffic ).
| [http://www.liulantao.com/portal/ Liu Lantao]
| [https://github.com/Lax/ngx_http_accounting_module Download]
|-
| [http://pushmodule.slact.net/ HTTP Push]
| Turn Nginx into an adept long-polling HTTP Push (Comet) server.
| Leo Ponomarev
| [http://pushmodule.slact.net/downloads/nginx_http_push_module-0.69.tar.gz Download]
|-
| [[HttpPushStreamModule|HTTP Push Stream]]
| Turn Nginx into an adept stream HTTP Push (Comet) server.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-push-stream-module/downloads Download]
|-
| [[HttpRedis|HTTP Redis]]
| [http://redis.io/ Redis] support.
| Sergey A. Osokin <osa@FreeBSD.ORG.ru>
| [http://people.FreeBSD.ORG/~osa/ngx_http_redis-0.3.5.tar.gz Download]
|-
| [https://github.com/kung-fu-tzu/ngx_http_js_module#readme JavaScript]
| Embedding [http://www.mozilla.org/js/spidermonkey/ SpiderMonkey]. Full port of Perl module and more.
| [https://github.com/kung-fu-tzu Peter Leonov]
| [https://github.com/kung-fu-tzu/ngx_http_js_module/downloads Download]
|-
| [[HttpIconvModule|Iconv]]
| A character encoding conversion nginx module using libiconv.
| [http://vimedia.org/ Calio], [http://agentzh.org/ agentzh]
| [http://github.com/calio/iconv-nginx-module/tags Download]
|-
| [[HttpLogRequestSpeed|Log Request Speed]]
| Log the time it took to process each request.
| [https://github.com/replay Mauro Stettler]
|
|-
| [https://github.com/replay/ngx_http_lower_upper_case Lower Upper Case]
| Simple module to upper-/lowercase a string in the Nginx config
| [https://github.com/replay Mauro Stettler]
| [https://github.com/replay/ngx_http_lower_upper_case Download]
|-
| [http://wiki.nginx.org/HttpLuaModule Lua]
| Embed the power of Lua into nginx
| [http://github.com/chaoslawful chaoslawful], [http://agentzh.org/ agentzh]
| [http://github.com/chaoslawful/lua-nginx-module/tags Download]
|-
| [https://github.com/alacner/nginx_lua_module Luafile]
| Embed the power of Lua into nginx very easy.
| [http://alacner.com alacner]
| [https://github.com/alacner/nginx_lua_module/tarball/master Download]
|-
| [[HttpMemcModule|Memc]]
| An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/memc-nginx-module/tags Download]
|-
| [http://www.grid.net.ru/nginx/mogilefs.en.html Mogilefs]
| Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/download/nginx_mogilefs_module-1.0.2.tar.gz Download]
|-
| [[MP4StreamingLite|MP4 Streaming Lite]]
| Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.
| Jiang Hong
| [[MP4StreamingLite|Download]]
|-
| [http://naxsi.googlecode.com Naxsi]
| Web Application Firewall for nginx.
| Thibault Koechlin
| [http://naxsi.googlecode.com Download]
|-
| [http://xph.us/software/nginx-notice/ Notice]
| Serve static file to POST requests.
| Keith Rarick
| [http://xph.us/software/nginx-notice/nginx-notice-2.tar.gz Download]
|-
| [http://wiki.nginx.org/HttpOwnerMatchModule OwnerMatch]
| This module provides a simple file owner-based access control.
| [https://heiher.info Heiher]
| [http://heiher.info/sftp/files/Nginx-0.8.54-Add-OwnerMatch-module.patch Download]
|-
| [http://mauro-stettler.blogspot.com/2011/08/pecl-memcache-standard-loadbalancer-for.html PHP-Memache Standard Hash]
| This is a loadbalancer that imitates the PHP-Memcache standard hash's behaviour
| Mauro Stettler
| [https://github.com/replay/ngx_http_php_memcache_standard_balancer Download]
|-
| [https://github.com/replay/ngx_http_php_session PHP Session Parser]
| Extract values that are stored in a serialized PHP session
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_php_session Download]
|-
| [http://labs.frickle.com/nginx_ngx_postgres/ Postgres]
| Upstream module that allows nginx to communicate directly with PostgreSQL database.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_postgres/ Download]
|-
| [http://vitki.net/pubcookie Pubcookie]
| Adds [http://www.pubcookie.org Pubcookie]-based cross-site authentication method to Nginx.
| [http://www.vitki.net/ Vitki]
| [http://vitki.net/pubcookie#Installation Download]
|-
| [http://github.com/agentzh/rds-csv-nginx-module RDS CSV]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit Comma-Separated Values (CSV).
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-csv-nginx-module/tags Download]
|-
| [http://github.com/agentzh/rds-json-nginx-module RDS JSON]
| Help [http://github.com/chaoslawful/drizzle-nginx-module ngx_drizzle], [http://github.com/FRiCKLE/ngx_postgres/ ngx_postgres], and others emit JSON data.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/rds-json-nginx-module/tags Download]
|-
| [[HttpRedis2Module|Redis2]]
| Upstream module for the full [http://redis.io/ Redis] 2.0 protocol
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/redis2-nginx-module/tags Download]
|-
| [https://github.com/yuri-gushin/Roboo Roboo]
| HTTP Robot mitigator utilizing advanced non-interactive HTTP challenge/response mechanisms
| [http://www.ecl-labs.org/ Yuri Gushin, Alex Behar]
| [https://github.com/yuri-gushin/Roboo/downloads Download]
|-
| [[NginxNgx_rrd_graph|RRD Graph]]
| This module provides an HTTP interface to [http://oss.oetiker.ch/rrdtool/ RRDtool]'s graphing facilities.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/mod_rrd_graph Download]
|-
| [[HttpSecureDownload|Secure Download]]
| Create expiring links.
| [https://github.com/replay Mauro Stettler], Szymon Modzelewski
| [http://github.com/replay/ngx_http_secure_download Download]
|-
| [http://github.com/liseen/set-cconv-nginx-module/ Set CConv]
| Conversion between Simplified Chinese and Traditional Chinese at rewrite phase
| [http://github.com/liseen/ Liseen Wan]
| [http://github.com/liseen/set-cconv-nginx-module/ Download]
|-
| [http://github.com/simpl/ngx_http_set_hash Set Hash]
| Set a variable to a variety of hash functions (upper/lowercase), including MD5, SHA1 and Murmurhash 2
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_hash/tags Download]
|-
| [http://github.com/simpl/ngx_http_set_lang Set Lang]
| Set a variable to indicate the language based on a variety of sources including cookies, GET/POST variables, Accept Language header and more
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_http_set_lang/downloads Download]
|-
| [http://wiki.nginx.org/HttpSetMiscModule Set Misc]
| Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)
| [http://agentzh.org agentzh], [http://vimedia.org/ Calio], [http://github.com/shrimp/ shrimp]
| [http://github.com/agentzh/set-misc-nginx-module/tags Download]
|-
| [http://nginx-sflow-module.googlecode.com sFlow]
| Operational performance monitoring with standard [http://sflow.org sFlow] protocol
| Neil McKee
| [http://code.google.com/p/nginx-sflow-module/downloads/list Download]
|-
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ SlowFS Cache]
| Module adding ability to cache static files.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_slowfs_cache/ Download]
|-
| [https://github.com/muhgatus/spnego-http-auth-nginx-module SPNEGO]
| Support for SPNEGO/gssapi in nginx.
| [https://github.com/mike503 mike503]/[https://github.com/muhgatus/ muhgatus]
| [https://github.com/muhgatus/spnego-http-auth-nginx-module Download]
|-
| [http://wiki.nginx.org/HttpSRCacheModule SR Cache]
| Transparent subrequest-based caching layout for arbitrary nginx locations (can be used with ngx_memc + memcached!)
| [http://agentzh.org agentzh]
| [http://github.com/agentzh/srcache-nginx-module/tags Download]
|-
| [http://github.com/mikewest/nginx-static-etags Static etags]
| Nginx doesn't generate etags for static content. I'd like it to. Let's see if I can remember some C from college.
| [http://github.com/mikewest mikewest]
| [http://github.com/mikewest/nginx-static-etags Download]
|-
| [https://github.com/zebrafishlabs/nginx-statsd Statsd]
| Adds the ability for Nginx to interacting with statsd.
| [https://github.com/zebrafishlabs zebrafishlabs]
| [https://github.com/zebrafishlabs/nginx-statsd Download]
|-
| [http://code.google.com/p/nginx-sticky-module/ Sticky upstream]
| A nginx module to add an upstream server persistance using cookies.
| [http://code.google.com/u/jerome@loyet.net/ Jérôme Loyet]
| [http://code.google.com/p/nginx-sticky-module/downloads/list Download]
|-
| [[HttpStripModule|Strip]]
| Whitespace remover.
| [http://evanmiller.org Evan Miller]
| [[File:mod_strip-0.1.tar.gz|Download]]
|-
| [http://wiki.nginx.org/HttpSubsModule Substitutions]
| A filter module which can do both regular expression and fixed string substitutions on response bodies.
| [http://yaoweibin.cn Weibin Yao]
| [http://code.google.com/p/substitutions4nginx/ Download]
|-
| [http://labs.frickle.com/nginx_ngx_supervisord/ Supervisord]
| Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.
| [http://www.frickle.com/ FRiCKLE]
| [http://labs.frickle.com/nginx_ngx_supervisord/ Download]
|-
| [http://www.grid.net.ru/nginx/upload.en.html Upload]
| Parses <code>multipart/form-data</code> allowing arbitrary handling of uploaded files.
| Valery Kholodkov
| [http://www.grid.net.ru/nginx/upload.en.html#download Download]
|-
| [[HttpUploadProgressModule|Upload Progress]]
| Tracks and reports upload progress.
| Brice Figureau
| [http://github.com/masterzen/nginx-upload-progress-module/downloads Download]
|-
| [[HttpUpstreamConsistentHash|Upstream Consistent Hash]]
| Select backend based on Consistent hash ring.
| [https://github.com/replay Mauro Stettler]
| [http://github.com/replay/ngx_http_consistent_hash Download]
|-
| [[HttpUpstreamFairModule|Upstream Fair Balancer]]
| Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.
| Gregory Nosek
| [http://github.com/gnosek/nginx-upstream-fair Download]
|-
| [[HttpUpstreamRequestHashModule|Upstream Hash]]
| Provides simple upstream load distribution by hashing a configurable variable.
| [http://evanmiller.org Evan Miller]
| [http://github.com/evanmiller/nginx_upstream_hash/ Download]
|-
| [[HttpUpstreamKeepaliveModule|Upstream Keepalive]]
| Provides keep-alive connections to memcached upstreams.
| [http://mdounin.ru Maxim Dounin]
| [http://mdounin.ru/hg/ngx_http_upstream_keepalive/ Download]
|-
| [https://github.com/wandenberg/nginx-video-thumbextractor-module Video Thumb Extractor]
| Nginx module to extract thumbs from a video file.
| [https://github.com/wandenberg Wandenberg Peixoto]
| [https://github.com/wandenberg/nginx-video-thumbextractor-module/downloads Download]
|-
| [[NgxWSGIModule|WSGI]]
| [http://en.wikipedia.org/wiki/Wsgi WSGI] implementation for Nginx. Allows easy deployment of Python applications.
| Manlio Perillo
| [http://hg.mperillo.ath.cx/nginx/mod_wsgi/ Download]
|-
| [http://github.com/agentzh/xss-nginx-module XSS]
| Native support for cross-site scripting (XSS) in an nginx.
| [http://agentzh.org/ agentzh]
| [http://github.com/agentzh/xss-nginx-module/tags Download]
|-
| [[NgxZip|Zip]]
| Assemble ZIP archives on the fly.
| [http://www.evanmiller.org/ Evan Miller]
| [http://github.com/evanmiller/mod_zip/ Download]
|-
| [[Extended status module|Extended status module]]
| Extended status module for nginx
| 최영석(Choi Youngseok), 李金虎(Li Jinhu)
| [http://github.com/zealot83/ngx_http_extended_status_module Download]
|-
|}

== Tools for module developers ==
{|
! Name
! Description
! Author
! Link
|-
| [http://github.com/simpl/ngx_auto_lib Nginx Auto Lib Core]
| Reusable file for module developers to include with their modules to easily and consistently handle including external libraries; used in the Auto Lib module and included in the Nginx Development Kit
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_auto_lib/downloads Download]
|-
| [http://github.com/simpl/ngx_devel_kit Nginx Development Kit]
| An extension to the core functionality of Nginx which can be used as a basis for other modules
| [http://simpl.it Marcus Clyne]
| [http://github.com/simpl/ngx_devel_kit/downloads Download]
|}

= Third party patches =
These patches must be applied to the Nginx source code tree. There's no guarantee these patches will apply to a particular version of Nginx.

As with third party modules, these patches are not officially supported. Your mileage may vary.

{|
! Description
! Author
! Link
|-
| Log to syslog.
| Marlon de Boer
| [http://bugs.gentoo.org/attachment.cgi?id=197180 Patch against 0.8.4] (works on 0.7.x and 0.8.x) | [http://dl.dropbox.com/u/5836407/Patches/Nginx_0.8.49-syslog-support.txt Patch for version 0.8.49 with 'sh is not bash' fix] | [https://github.com/yaoweibin/nginx_syslog_patch Syslog Patch for Nginx 0.8.54+]
|-
| Disable nginx's memory pool to help valgrind and other tools (for nginx C developers only)
| [http://github.com/shrimp/ shrimp], [http://agentzh.spaces.live.com/ agentzh]
| [http://github.com/shrimp/no-pool-nginx Git repository for the patch]
|-
| SSL Session tickets distributed via memcached
| [http://hezmatt.org/~mpalmer/blog/2011/07/24/followup-to-ssl-session-caching-with-nginx.html Matthew Palmer]
| [https://github.com/mpalmer/nginx Git repository for changes]
|}

= References =
* [http://github.com/search?type=Repositories&language=c&q=nginx&repo=&langOverride=&x=13&y=17&start_value=1 github search]

Modules

2012-05-03T00:19:47Z

Admin: /* Installing Modules */

= 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 <code>./configure --help</code>

= Nginx core modules =
These modules are required.

{| class="modules-index-table"
! Name !! Description
|-
| [[CoreModule|Main]]
| Configure error logging, processes, permissions, etc.
|-
| [[EventsModule|Events]]
| Configure epoll, kqueue, select, poll, etc.
|-
|}

= Standard HTTP modules =
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to disable
|-
| [[HttpCoreModule|Core]]
| Control ports, locations, error pages, aliases, and other essentials.
|
| --without-http
|-
| [[HttpAccessModule|Access]]
| Allow/deny based on IP address.
|
| --without-http_access_module
|-
| [[HttpAuthBasicModule|Auth Basic]]
| Basic HTTP authentication.
|
| --without-http_auth_basic_module
|-
| [[HttpAutoindexModule|Auto Index]]
| Generates automatic directory listings.
|
| --without-http_autoindex_module
|-
| [[HttpBrowserModule|Browser]]
| Interpret "User-Agent" string.
|
| --without-http_browser_module
|-
| [[HttpCharsetModule|Charset]]
| Recode web pages.
|
| --without-http_charset_module
|-
| [[HttpEmptyGifModule|Empty GIF]]
| Serve a 1x1 image from memory.
|
| --without-http_empty_gif_module
|-
| [[HttpFastcgiModule|FastCGI]]
| FastCGI Support.
|
| --without-http_fastcgi_module
|-
| [[HttpGeoModule|Geo]]
| Set config variables using key/value pairs of IP addresses.
|
| --without-http_geo_module
|-
| [[HttpGzipModule|Gzip]]
| Gzip responses.
|
| --without-http_gzip_module
|-
| [[HttpHeadersModule|Headers]]
| Set arbitrary HTTP response headers.
|
|-
| [[HttpIndexModule|Index]]
| Controls which files are to be used as index.
|
|-
| [[HttpLimitReqModule|Limit Requests]]
| Limit frequency of connections from a client.
| 0.7.20
| --without-http_limit_req_module
|-
| [[HttpLimitZoneModule|Limit Zone]]
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
|
| --without-http_limit_zone_module
|-
| [[HttpLimitConnModule|Limit Conn]]
| Limit concurrent connections based on a variable.
|
| --without-http_limit_conn_module
|-
| [[HttpLogModule|Log]]
| Customize access logs.
|
|-
| [[HttpMapModule|Map]]
| Set config variables using arbitrary key/value pairs.
|
| --without-http_map_module
|-
| [[HttpMemcachedModule|Memcached]]
| Memcached support.
|
| --without-http_memcached_module
|-
| [[HttpProxyModule|Proxy]]
| Proxy to upstream servers.
|
| --without-http_proxy_module
|-
| [[HttpRefererModule|Referer]]
| Filter requests based on <code>Referer</code> header.
|
| --without-http_referer_module
|-
| [[HttpRewriteModule|Rewrite]]
| Request rewriting using regular expressions.
|
| --without-http_rewrite_module
|-
| [[HttpScgiModule|SCGI]]
| SCGI protocol support.
| 0.8.42
| --without-http_scgi_module
|-
| [[HttpSplitClientsModule|Split Clients]]
| Splits clients based on some conditions
| 0.8.37
| --without-http_split_clients_module
|-
| [[HttpSsiModule|SSI]]
| Server-side includes.
|
| --without-http_ssi_module
|-
| [[HttpUpstreamModule|Upstream]]
| For load-balancing.
|
| --without-http_upstream_ip_hash_module (ip_hash directive only)
|-
| [[HttpUseridModule|User ID]]
| Issue identifying cookies.
|
| --without-http_userid_module
|-
| [[HttpUwsgiModule|uWSGI]]
| uWSGI protocol support.
| 0.8.40
| --without-http_uwsgi_module
|-
| [[X-accel|X-Accel]]
| X-Sendfile-like module.
|
|
|}

= Optional HTTP modules =
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to enable
|-
| [[HttpAdditionModule|Addition]]
| Append text to pages.
|
| --with-http_addition_module
|-
| [[HttpDegradationModule|Degradation]]
| Allow to return 204 or 444 code for some locations on low memory condition.
| 0.8.25
| --with-http_degradation_module
|-
| [[HttpPerlModule|Embedded Perl]]
| Use Perl in Nginx config files.
|
| --with-http_perl_module
|-
| [[HttpFlvModule|FLV]]
| Flash Streaming Video
|
| --with-http_flv_module
|-
| [[HttpGeoipModule|GeoIP]]
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
| 0.8.6, 0.7.63
| --with-http_geoip_module
|-
| [[GooglePerftoolsModule|Google Perftools]]
| Google Performance Tools support.
| 0.6.29
| --with-google_perftools_module
|-
| [[HttpGzipStaticModule|Gzip Precompression]]
| Serves precompressed versions of static files.
| 0.6.23
| --with-http_gzip_static_module
|-
| [[HttpImageFilterModule|Image Filter]]
| Transform images with Libgd
| 0.7.54
| --with-http_image_filter_module
|-
| [[HttpMp4Module|MP4]]
| Enables mp4 streaming with seeking ability.
| 1.1.3, 1.0.7
| --with-http_mp4_module
|-
| [[HttpRandomIndexModule|Random Index]]
| Randomize directory indexes.
| 0.7.15
| --with-http_random_index_module
|-
| [[HttpRealipModule|Real IP]]
| For using nginx as backend
|
| --with-http_realip_module
|-
| [[HttpSecureLinkModule|Secure Link]]
| Protect pages with a secret key.
| 0.7.18
| --with-http_secure_link_module
|-
| [[HttpSslModule|SSL]]
| HTTPS/SSL support.
|
| --with-http_ssl_module
|-
| [[HttpStubStatusModule|Stub Status]]
| View server statistics.
|
| --with-http_stub_status_module
|-
| [[HttpSubModule|Substitution]]
| Replace text in pages
|
| --with-http_sub_module
|-
| [[HttpDavModule|WebDAV]]
| WebDAV pass-through support.
|
| --with-http_dav_module
|-
| [[HttpXsltModule|XSLT]]
| Post-process pages with XSLT.
| 0.7.8
| --with-http_xslt_module
|}

= Mail modules =
{| class="modules-index-table"
! Name
! Description
! configure argument
|-
| [[MailCoreModule|Core]]
| Nginx is able to handle and proxy the IMAP, POP3, SMTP protocols.
| --with-mail<br>--without-mail_pop3_module<br>--without-mail_imap_module<br>--without-mail_smtp_module
|-
| [[MailAuthModule|Auth]]
| Use Nginx to authenticate mail services.
|-
| [[MailProxyModule|Proxy]]
| Nginx can proxy IMAP, POP3, and SMTP protocols.
|-
| [[MailSslModule|SSL]]
| This module ensures SSL/TLS support for POP3/IMAP/SMTP.
| --with-mail_ssl_module
|}

= Third party modules and Patches =
Please see the catalog of [[3rdPartyModules|3rd party modules]].

= References =
* [[ModulesByExample|Module index by example]]
* [[ConfigNotation| Configuration Notation Reference]]
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
* [[FeatureRequests| Feature Requests]]
* [[GettingStarted| Getting Started]]
* [[Configuration| Configuration Cookbook]]
* [[DirectiveIndex| Index of all Directives]]

Modules

2012-05-03T00:18:55Z

Admin: /* 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 <code>./configure --help</code>

= Nginx core modules =
These modules are required.

{| class="modules-index-table"
! Name !! Description
|-
| [[CoreModule|Main]]
| Configure error logging, processes, permissions, etc.
|-
| [[EventsModule|Events]]
| Configure epoll, kqueue, select, poll, etc.
|-
|}

= Standard HTTP modules =
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to disable
|-
| [[HttpCoreModule|Core]]
| Control ports, locations, error pages, aliases, and other essentials.
|
| --without-http
|-
| [[HttpAccessModule|Access]]
| Allow/deny based on IP address.
|
| --without-http_access_module
|-
| [[HttpAuthBasicModule|Auth Basic]]
| Basic HTTP authentication.
|
| --without-http_auth_basic_module
|-
| [[HttpAutoindexModule|Auto Index]]
| Generates automatic directory listings.
|
| --without-http_autoindex_module
|-
| [[HttpBrowserModule|Browser]]
| Interpret "User-Agent" string.
|
| --without-http_browser_module
|-
| [[HttpCharsetModule|Charset]]
| Recode web pages.
|
| --without-http_charset_module
|-
| [[HttpEmptyGifModule|Empty GIF]]
| Serve a 1x1 image from memory.
|
| --without-http_empty_gif_module
|-
| [[HttpFastcgiModule|FastCGI]]
| FastCGI Support.
|
| --without-http_fastcgi_module
|-
| [[HttpGeoModule|Geo]]
| Set config variables using key/value pairs of IP addresses.
|
| --without-http_geo_module
|-
| [[HttpGzipModule|Gzip]]
| Gzip responses.
|
| --without-http_gzip_module
|-
| [[HttpHeadersModule|Headers]]
| Set arbitrary HTTP response headers.
|
|-
| [[HttpIndexModule|Index]]
| Controls which files are to be used as index.
|
|-
| [[HttpLimitReqModule|Limit Requests]]
| Limit frequency of connections from a client.
| 0.7.20
| --without-http_limit_req_module
|-
| [[HttpLimitZoneModule|Limit Zone]]
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
|
| --without-http_limit_zone_module
|-
| [[HttpLimitConnModule|Limit Conn]]
| Limit concurrent connections based on a variable.
|
| --without-http_limit_conn_module
|-
| [[HttpLogModule|Log]]
| Customize access logs.
|
|-
| [[HttpMapModule|Map]]
| Set config variables using arbitrary key/value pairs.
|
| --without-http_map_module
|-
| [[HttpMemcachedModule|Memcached]]
| Memcached support.
|
| --without-http_memcached_module
|-
| [[HttpProxyModule|Proxy]]
| Proxy to upstream servers.
|
| --without-http_proxy_module
|-
| [[HttpRefererModule|Referer]]
| Filter requests based on <code>Referer</code> header.
|
| --without-http_referer_module
|-
| [[HttpRewriteModule|Rewrite]]
| Request rewriting using regular expressions.
|
| --without-http_rewrite_module
|-
| [[HttpScgiModule|SCGI]]
| SCGI protocol support.
| 0.8.42
| --without-http_scgi_module
|-
| [[HttpSplitClientsModule|Split Clients]]
| Splits clients based on some conditions
| 0.8.37
| --without-http_split_clients_module
|-
| [[HttpSsiModule|SSI]]
| Server-side includes.
|
| --without-http_ssi_module
|-
| [[HttpUpstreamModule|Upstream]]
| For load-balancing.
|
| --without-http_upstream_ip_hash_module (ip_hash directive only)
|-
| [[HttpUseridModule|User ID]]
| Issue identifying cookies.
|
| --without-http_userid_module
|-
| [[HttpUwsgiModule|uWSGI]]
| uWSGI protocol support.
| 0.8.40
| --without-http_uwsgi_module
|-
| [[X-accel|X-Accel]]
| X-Sendfile-like module.
|
|
|}

= Optional HTTP modules =
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to enable
|-
| [[HttpAdditionModule|Addition]]
| Append text to pages.
|
| --with-http_addition_module
|-
| [[HttpDegradationModule|Degradation]]
| Allow to return 204 or 444 code for some locations on low memory condition.
| 0.8.25
| --with-http_degradation_module
|-
| [[HttpPerlModule|Embedded Perl]]
| Use Perl in Nginx config files.
|
| --with-http_perl_module
|-
| [[HttpFlvModule|FLV]]
| Flash Streaming Video
|
| --with-http_flv_module
|-
| [[HttpGeoipModule|GeoIP]]
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
| 0.8.6, 0.7.63
| --with-http_geoip_module
|-
| [[GooglePerftoolsModule|Google Perftools]]
| Google Performance Tools support.
| 0.6.29
| --with-google_perftools_module
|-
| [[HttpGzipStaticModule|Gzip Precompression]]
| Serves precompressed versions of static files.
| 0.6.23
| --with-http_gzip_static_module
|-
| [[HttpImageFilterModule|Image Filter]]
| Transform images with Libgd
| 0.7.54
| --with-http_image_filter_module
|-
| [[HttpMp4Module|MP4]]
| Enables mp4 streaming with seeking ability.
| 1.1.3, 1.0.7
| --with-http_mp4_module
|-
| [[HttpRandomIndexModule|Random Index]]
| Randomize directory indexes.
| 0.7.15
| --with-http_random_index_module
|-
| [[HttpRealipModule|Real IP]]
| For using nginx as backend
|
| --with-http_realip_module
|-
| [[HttpSecureLinkModule|Secure Link]]
| Protect pages with a secret key.
| 0.7.18
| --with-http_secure_link_module
|-
| [[HttpSslModule|SSL]]
| HTTPS/SSL support.
|
| --with-http_ssl_module
|-
| [[HttpStubStatusModule|Stub Status]]
| View server statistics.
|
| --with-http_stub_status_module
|-
| [[HttpSubModule|Substitution]]
| Replace text in pages
|
| --with-http_sub_module
|-
| [[HttpDavModule|WebDAV]]
| WebDAV pass-through support.
|
| --with-http_dav_module
|-
| [[HttpXsltModule|XSLT]]
| Post-process pages with XSLT.
| 0.7.8
| --with-http_xslt_module
|}

= Mail modules =
{| class="modules-index-table"
! Name
! Description
! configure argument
|-
| [[MailCoreModule|Core]]
| Nginx is able to handle and proxy the IMAP, POP3, SMTP protocols.
| --with-mail<br>--without-mail_pop3_module<br>--without-mail_imap_module<br>--without-mail_smtp_module
|-
| [[MailAuthModule|Auth]]
| Use Nginx to authenticate mail services.
|-
| [[MailProxyModule|Proxy]]
| Nginx can proxy IMAP, POP3, and SMTP protocols.
|-
| [[MailSslModule|SSL]]
| This module ensures SSL/TLS support for POP3/IMAP/SMTP.
| --with-mail_ssl_module
|}

= Third party modules and Patches =
Please see the catalog of [[3rdPartyModules|3rd party modules]].

= References =
* [[ModulesByExample|Module index by example]]
* [[ConfigNotation| Configuration Notation Reference]]
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
* [[FeatureRequests| Feature Requests]]
* [[GettingStarted| Getting Started]]
* [[Configuration| Configuration Cookbook]]
* [[DirectiveIndex| Index of all Directives]]

Modules

2012-05-03T00:18:23Z

Admin: /* 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 core modules =
These modules are required.

{| class="modules-index-table"
! Name !! Description
|-
| [[CoreModule|Main]]
| Configure error logging, processes, permissions, etc.
|-
| [[EventsModule|Events]]
| Configure epoll, kqueue, select, poll, etc.
|-
|}

= Standard HTTP modules =
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to disable
|-
| [[HttpCoreModule|Core]]
| Control ports, locations, error pages, aliases, and other essentials.
|
| --without-http
|-
| [[HttpAccessModule|Access]]
| Allow/deny based on IP address.
|
| --without-http_access_module
|-
| [[HttpAuthBasicModule|Auth Basic]]
| Basic HTTP authentication.
|
| --without-http_auth_basic_module
|-
| [[HttpAutoindexModule|Auto Index]]
| Generates automatic directory listings.
|
| --without-http_autoindex_module
|-
| [[HttpBrowserModule|Browser]]
| Interpret "User-Agent" string.
|
| --without-http_browser_module
|-
| [[HttpCharsetModule|Charset]]
| Recode web pages.
|
| --without-http_charset_module
|-
| [[HttpEmptyGifModule|Empty GIF]]
| Serve a 1x1 image from memory.
|
| --without-http_empty_gif_module
|-
| [[HttpFastcgiModule|FastCGI]]
| FastCGI Support.
|
| --without-http_fastcgi_module
|-
| [[HttpGeoModule|Geo]]
| Set config variables using key/value pairs of IP addresses.
|
| --without-http_geo_module
|-
| [[HttpGzipModule|Gzip]]
| Gzip responses.
|
| --without-http_gzip_module
|-
| [[HttpHeadersModule|Headers]]
| Set arbitrary HTTP response headers.
|
|-
| [[HttpIndexModule|Index]]
| Controls which files are to be used as index.
|
|-
| [[HttpLimitReqModule|Limit Requests]]
| Limit frequency of connections from a client.
| 0.7.20
| --without-http_limit_req_module
|-
| [[HttpLimitZoneModule|Limit Zone]]
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
|
| --without-http_limit_zone_module
|-
| [[HttpLimitConnModule|Limit Conn]]
| Limit concurrent connections based on a variable.
|
| --without-http_limit_conn_module
|-
| [[HttpLogModule|Log]]
| Customize access logs.
|
|-
| [[HttpMapModule|Map]]
| Set config variables using arbitrary key/value pairs.
|
| --without-http_map_module
|-
| [[HttpMemcachedModule|Memcached]]
| Memcached support.
|
| --without-http_memcached_module
|-
| [[HttpProxyModule|Proxy]]
| Proxy to upstream servers.
|
| --without-http_proxy_module
|-
| [[HttpRefererModule|Referer]]
| Filter requests based on <code>Referer</code> header.
|
| --without-http_referer_module
|-
| [[HttpRewriteModule|Rewrite]]
| Request rewriting using regular expressions.
|
| --without-http_rewrite_module
|-
| [[HttpScgiModule|SCGI]]
| SCGI protocol support.
| 0.8.42
| --without-http_scgi_module
|-
| [[HttpSplitClientsModule|Split Clients]]
| Splits clients based on some conditions
| 0.8.37
| --without-http_split_clients_module
|-
| [[HttpSsiModule|SSI]]
| Server-side includes.
|
| --without-http_ssi_module
|-
| [[HttpUpstreamModule|Upstream]]
| For load-balancing.
|
| --without-http_upstream_ip_hash_module (ip_hash directive only)
|-
| [[HttpUseridModule|User ID]]
| Issue identifying cookies.
|
| --without-http_userid_module
|-
| [[HttpUwsgiModule|uWSGI]]
| uWSGI protocol support.
| 0.8.40
| --without-http_uwsgi_module
|-
| [[X-accel|X-Accel]]
| X-Sendfile-like module.
|
|
|}

= Optional HTTP modules =
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to enable
|-
| [[HttpAdditionModule|Addition]]
| Append text to pages.
|
| --with-http_addition_module
|-
| [[HttpDegradationModule|Degradation]]
| Allow to return 204 or 444 code for some locations on low memory condition.
| 0.8.25
| --with-http_degradation_module
|-
| [[HttpPerlModule|Embedded Perl]]
| Use Perl in Nginx config files.
|
| --with-http_perl_module
|-
| [[HttpFlvModule|FLV]]
| Flash Streaming Video
|
| --with-http_flv_module
|-
| [[HttpGeoipModule|GeoIP]]
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
| 0.8.6, 0.7.63
| --with-http_geoip_module
|-
| [[GooglePerftoolsModule|Google Perftools]]
| Google Performance Tools support.
| 0.6.29
| --with-google_perftools_module
|-
| [[HttpGzipStaticModule|Gzip Precompression]]
| Serves precompressed versions of static files.
| 0.6.23
| --with-http_gzip_static_module
|-
| [[HttpImageFilterModule|Image Filter]]
| Transform images with Libgd
| 0.7.54
| --with-http_image_filter_module
|-
| [[HttpMp4Module|MP4]]
| Enables mp4 streaming with seeking ability.
| 1.1.3, 1.0.7
| --with-http_mp4_module
|-
| [[HttpRandomIndexModule|Random Index]]
| Randomize directory indexes.
| 0.7.15
| --with-http_random_index_module
|-
| [[HttpRealipModule|Real IP]]
| For using nginx as backend
|
| --with-http_realip_module
|-
| [[HttpSecureLinkModule|Secure Link]]
| Protect pages with a secret key.
| 0.7.18
| --with-http_secure_link_module
|-
| [[HttpSslModule|SSL]]
| HTTPS/SSL support.
|
| --with-http_ssl_module
|-
| [[HttpStubStatusModule|Stub Status]]
| View server statistics.
|
| --with-http_stub_status_module
|-
| [[HttpSubModule|Substitution]]
| Replace text in pages
|
| --with-http_sub_module
|-
| [[HttpDavModule|WebDAV]]
| WebDAV pass-through support.
|
| --with-http_dav_module
|-
| [[HttpXsltModule|XSLT]]
| Post-process pages with XSLT.
| 0.7.8
| --with-http_xslt_module
|}

= Mail modules =
{| class="modules-index-table"
! Name
! Description
! configure argument
|-
| [[MailCoreModule|Core]]
| Nginx is able to handle and proxy the IMAP, POP3, SMTP protocols.
| --with-mail<br>--without-mail_pop3_module<br>--without-mail_imap_module<br>--without-mail_smtp_module
|-
| [[MailAuthModule|Auth]]
| Use Nginx to authenticate mail services.
|-
| [[MailProxyModule|Proxy]]
| Nginx can proxy IMAP, POP3, and SMTP protocols.
|-
| [[MailSslModule|SSL]]
| This module ensures SSL/TLS support for POP3/IMAP/SMTP.
| --with-mail_ssl_module
|}

= Third party modules and Patches =
Please see the catalog of [[3rdPartyModules|3rd party modules]].

= References =
* [[ModulesByExample|Module index by example]]
* [[ConfigNotation| Configuration Notation Reference]]
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
* [[FeatureRequests| Feature Requests]]
* [[GettingStarted| Getting Started]]
* [[Configuration| Configuration Cookbook]]
* [[DirectiveIndex| Index of all Directives]]

HttpCoreModule

2012-05-02T23:36:31Z

Admin: /* post_action */

= Synopsis =

Controls core features of Nginx's HTTP processing.

= Directives =
== aio ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/aio.txt" />

This directive is usable as of Linux kernel 2.6.22. For Linux it is required to use directio, this automatically disables sendfile support.

<geshi lang="nginx">
location /video {
aio on;
directio 512;
output_buffers 1 128k;
}
</geshi>

In FreeBSD before 5.2.1 and Nginx 0.8.12 you must disable sendfile support.

<geshi lang="nginx">
location /video {
aio on;
sendfile off;
output_buffers 1 128k;
}
</geshi>

As of FreeBSD 5.2.1 and Nginx 0.8.12 you can use it along with sendfile.
<geshi lang="nginx">
location /video {
aio sendfile;
sendfile on;
tcp_nopush on;
}
</geshi>

== alias ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/alias.txt" />

This directive assigns a path to be used as the basis for serving requests for the indicated location. Note that it may look similar to the <code>root</code> directive at first sight, but the document root doesn't change, just the file system path used for the request. The location part of the request is '''dropped''' in the request Nginx issues. Let's see this in action. Consider the following example.
<geshi lang="nginx">
location /i/ {
alias /spool/w3/images/;
}
</geshi>
A request for "/i/top.gif" will instruct Nginx to serve the file "/spool/w3/images/top.gif". As you can see, '''only''' the part of the URI '''after''' the location is appended. The location itself, in this case "/i/", is dropped. With a <code>root</code> directive the '''full''' path is appended, i.e., in the above example it would have been, "/spool/w3/images/i/top.gif" — hence including '''also''' the location "/i/".

Aliases can also be used in a location specified by a regex.

For example:

<geshi lang="nginx">
location ~ ^/download/(.*)$ {
alias /home/website/files/$1;
}
</geshi>

The request "/download/book.pdf" will return the file "/home/website/files/book.pdf". Note again that only part of the request URI '''after''' the location is appended to the path defined by <code>alias</code>.

It is possible to use variables in the replacement path.

== chunked_transfer_encoding ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/chunked_transfer_encoding.txt" />

This directive (0.7.66+) sets whether chunked encoding is enabled in responses (only valid for connections using HTTP 1.1 or later).

== client_body_in_file_only ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_in_file_only.txt" />

The directive forces nginx to always store a client request body into a temporary disk file even if the body is actually of 0 size.

Please note that the file will '''NOT''' be removed at request completion if the directive is enabled.

This directive can be used for debugging and for the <code>$r->request_body_file</code> method in the [[EmbeddedPerlModule|Embedded Perl module]].

== client_body_in_single_buffer ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_in_single_buffer.txt" />

The directive(0.7.58+) specifies whether to keep the whole body in a single client request buffer. The directive is recommended when using the variable [[#$request_body|$request_body]] to reduce the operations of copying.

Note that when the request body cannot be hold in a single buffer (see [[#client_body_buffer_size|client_body_buffer_size]]), the body will still touch the disk.

== client_body_buffer_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_buffer_size.txt" />

The directive specifies the client request body buffer size.

If the request body size is more than the buffer size, then the entire (or partial) request body is written into a temporary file.

The default size is equal to page size times 2. Depending on the platform, the page size is either 8K or 16K.

When the ''Content-Length'' request header specifies a smaller size value than the buffer size, then Nginx will use the smaller one. As a result, Nginx will '''not''' always allocate a buffer of this buffer size for every request.

== client_body_temp_path ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_temp_path.txt" />

The directive assigns the directory for storing the temporary files in it with the body of the request.

In the <code>dir-path</code> a hierarchy of subdirectories up to three levels are possible.

For example

<geshi lang="nginx">
client_body_temp_path /spool/nginx/client_temp 1 2;
</geshi>
The directory structure will be like this:

<pre>
/spool/nginx/client_temp/7/45/00000123457
</pre>

== client_body_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_timeout.txt" />

Directive sets the read timeout for the request body from client.

The timeout is set only if a body is not get in one readstep. If after this time the client send nothing, nginx returns error "Request time out" (408).

== client_header_buffer_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_header_buffer_size.txt" />

Directive sets the headerbuffer size for the request header from client.

For the overwhelming majority of requests it is completely sufficient a buffer size of 1K.

However if a big cookie is in the request-header or the request has come from a wap-client the header can not be placed in 1K, therefore, the request-header or a line of request-header is not located completely in this buffer nginx allocate a bigger buffer, the size of the bigger buffer can be set with the instruction large_client_header_buffers.

== client_header_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_header_timeout.txt" />

Specifies how long to wait for the client to send a request header (e.g.: <code>GET / HTTP/1.1</code>).

This timeout is reached only if a header is not received in one read ''(needs clarification)''. If the client has not sent anything within this timeout period, nginx returns the HTTP status code 408 ("Request timed out")

== client_max_body_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_max_body_size.txt" />

Specifies the maximum accepted body size of a client request, as indicated by the request header <code>Content-Length</code>.

If the stated content length is greater than this size, then the client receives the HTTP error code 413 ("Request Entity Too Large"). It should be noted that web browsers do not usually know how to properly display such an HTTP error.

== connection_pool_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/connection_pool_size.txt" />

The directive is used to allocate memory per connection. The pool is used for small allocations. If a block is bigger than pool size or bigger than page size, then it is allocated outside the pool. If there is not enough memory for small allocation inside pool, then a new block of the same pool size is allocated. This directive has only a very small effect. (source http://markmail.org/message/b2kmrluscevimpba)

== default_type ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/default_type.txt" />

Assigns the default MIME-type to be used for files where the standard MIME map doesn't specify anything.

See also [[#types|types]]

== directio ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/directio.txt" />

The directive enables use of flags O_DIRECT (FreeBSD, Linux), F_NOCACHE (Mac OS X) or directio() function (Solaris) for reading files with size greater than specified. This directive disables use of [[HttpCoreModule#sendfile|sendfile]] for this request. This directive may be useful for big files:
<geshi lang="nginx">
directio 4m;
</geshi>

== directio_alignment ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/directio_alignment.txt" />

== disable_symlinks ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/disable_symlinks.txt" />

== error_page ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/error_page.txt" />

The directive specifies the URI that will be shown for the errors indicated.

Example:
<geshi lang="nginx">
error_page 404 /404.html;
error_page 502 503 504 /50x.html;
error_page 403 http://example.com/forbidden.html;
error_page 404 = @fetch;
</geshi>
Furthermore, it is possible to change the status code of the answer to another, for example:

<geshi lang="nginx">
error_page 404 =200 /empty.gif;
error_page 404 =403 /forbidden.gif;
</geshi>
Additionally you can have your designated error handler determine the returned status code by using = without specifying a status code.

<geshi lang="nginx">
error_page 404 = /404.php;
</geshi>
If there is no need to change URI during redirection it is possible to redirect processing of error pages into a named location:

<geshi lang="nginx">
location / (
error_page 404 @fallback;
)

location @fallback (
proxy_pass http://backend;
)
</geshi>

== if_modified_since ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/if_modified_since.txt" />

Specifies how to compare time of file modification and time in request header "If-Modified-Since":
* off — don't check "If-Modified-Since" request header (0.7.34);
* exact — exact match;
* before — file modification time should be less than time in "If-Modified-Since" request header.

== ignore_invalid_headers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/ignore_invalid_headers.txt" />

== internal ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/internal.txt" />

'''internal''' indicates that the matching location can be used only for so called "internal" requests.

For external requests it will return the error "Not found" (404).

Internal requests are the following:
* requests redirected by the instruction '''error_page'''
* subrequests created by the command '''include virtual''' of the "ngx_http_ssi_module" module
* requests changed by the instruction '''rewrite''' of the "ngx_http_rewrite_module" module

An example to prevent clients fetching error pages directly:
<geshi lang="nginx">
error_page 404 /404.html;
location /404.html {
internal;
}
</geshi>

== keepalive_disable ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/keepalive_disable.txt" />

Disable keepalive for certain user agents (0.9.0+). By default keepalive is disabled for MS Internet Explorer (older than 6.0 service pack 2) after <code>POST</code> requests, and for Safari. This is because both browsers have issues with handling <code>POST</code> requests with keepalives. If you are running a site that does not use <code>POST</code> anywhere, you may optionally choose to enable keepalive in these browsers.

== keepalive_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/keepalive_timeout.txt" />

The first parameter assigns the timeout for keep-alive connections with the client. The server will close connections after this time.

The optional second parameter assigns the <code>time</code> value in the header <code>Keep-Alive: timeout=time</code> of the response. This header can convince some browsers to close the connection, so that the server does not have to. Without this parameter, nginx does not send a <code>Keep-Alive</code> header (though this is not what makes a connection "keep-alive").

The parameters can differ from each other.

Notes on how browsers handle the <code>Keep-Alive</code> header:

* MSIE and Opera ignore the "Keep-Alive: timeout=<N>" header.
* MSIE keeps the connection alive for about 60-65 seconds, then sends a TCP RST.
* Opera keeps the connection alive for a long time.
* Mozilla keeps the connection alive for N plus about 1-10 seconds.
* Konqueror keeps the connection alive for about N seconds.

== keepalive_requests ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/keepalive_requests.txt" />

Number of requests which can be made over a keep-alive connection.

== large_client_header_buffers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/large_client_header_buffers.txt" />

Directive assigns the maximum number and size of buffers for large headers to read from client request.

The request line can not be bigger than the size of one buffer, if the client send a bigger header nginx returns error "Request URI too large" (414).

The longest header line of request also must be not more than the size of one buffer, otherwise the client get the error "Bad request" (400).

Buffers are separated only as needed.

By default the size of one buffer is 8192 bytes. In the old nginx, this is equal to the size of page, depending on platform this either 4K or 8K, if at the end of working request connection converts to state keep-alive, then these buffers are freed.

== limit_except ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/limit_except.txt" />

Limits which HTTP methods are allowed for a given request path/location.

For the limitation can be used the directives of modules ngx_http_access_module and ngx_http_auth_basic_module:

<geshi lang="nginx">
limit_except GET {
allow 192.168.1.0/32;
deny all;
}
</geshi>

== limit_rate ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/limit_rate.txt" />

Directive assigns the speed of transmission of the answer to client. Speed is assigned in the bytes per second. Limitation works only for one connection, i.e., if client opens 2 connections, then total velocity will be 2 times higher then the limit set.

If it is necessary to limit speed for the part of the clients at the ''server'' level, based on some kind of condition - then this directive does not apply. Instead you should specify the limit by assigning the value to the $limit_rate variable, as shown below:

<geshi lang="nginx">
server {
if ($slow) {
set $limit_rate 4k;
}
}
</geshi>

You can also control the rate of individual responses returned by a <code>proxy_pass</code> response ([[HttpProxyModule]]) by setting the <code>X-Accel-Limit-Rate</code> header ([[XSendfile]]). This can be done without a <code>X-Accel-Redirect</code> header.

== limit_rate_after ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/limit_rate_after.txt" />

The directive limits speed only after the first part was sent.

<geshi lang="nginx">
limit_rate_after 1m;
limit_rate 100k;
</geshi>

== lingering_close ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/lingering_close.txt" />

Sets SO_LINGER on sockets.

== lingering_time ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/lingering_time.txt" />

Sets SO_LINGER on sockets.

== lingering_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/lingering_timeout.txt" />

Sets SO_LINGER on sockets.

== listen ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/listen.txt" />

The ''listen'' directive specifies the address and port accepted by the enclosing [[#server|server {...}]] block. It is possible to specify only an address, only a port, or a server name as the address.

<geshi lang="nginx">
listen 127.0.0.1:8000;
listen 127.0.0.1;
listen 8000;
listen *:8000;
listen localhost:8000;
</geshi>
IPv6 address(0.7.36) are set in square brackets:
<geshi lang="nginx">
listen [::]:8000;
listen [fe80::1];
</geshi>

In Linux by default any IPv6 TCP socket '''also accepts''' IPv4 traffic using the IPv4 to IPv6 mapped address format, i.e., ::ffff:<IPv4 adddress in dotted decimal notation>. E.g.,
<code>::ffff:192.168.0.27</code> maps the IPv4 address 192.168.0.27 to an IPv6 address.

When you enable the address [::]:80, binding port 80 using IPv6, in the listen directive, in Linux, by default, the IPv4 port 80 is also enabled. Meaning that nginx listens for '''both''' IPv4 and IPv6 incoming traffic. Therefore if you erroneously specify also a IPv4 address you'll get an ''already bind address'' error when reloading nginx configuration.

In Linux the separation of the IPv6 and IPv4 stacks is controlled through the runtime parameter:
<code>net.ipv6.bindv6only</code> which has the value 0 by default.

If you want to use '''separate''' sockets for IPv4 and IPv6 you should set this parameter to 1 using <code>sysctl</code>.

Note that any nginx instance that was running '''before''' you made the change will '''continue to accept''' IPv4 traffic. Therefore you should edit your nginx configuration to reflect the new setup for IPv6 and IPv4 packet handling and do a '''restart'''.

If on the other hand you launched another server instance (vhost) and you expect it to also handle IPv4 traffic by using only, for example:
<geshi lang="nginx">
listen [::]:80;
</geshi>
the binding of the IPv4 address will fail. The correct way to to this is by using the "ipv6only=on" option in the IPv6 listen directive and also specifying a IPv4 listen directive in the respective server block.

This re-editing of the configuration must be done '''after''' you changed your kernel runtime parameter. This is the most generic situation in that case (separation of IPv6 and IPv4 sockets):
<geshi lang="nginx">
listen [::]:80 ipv6only=on; # listen for IPv6 only traffic on IPv6 sockets
listen 80; # listen also for IPv4 traffic on "regular" IPv4 sockets
</geshi>

In FreeBSD the default is '''separate''' IPv4 and IPv6 sockets. Therefore "listen [::]:80" only binds port 80 for listening to IPv6 traffic. It's always necessary to specify also IPv4 listen directives if you wish to also handle IPv4 traffic.

It's possible to specify '''only''' IPv6 addresses in the listen directive. Using the "default_server ipv6only=on" option. Specific IPv6 addresses can be used with a IPv6 only default directive. Other server directives can also specifiy listen directives with IPv4 addresses. The uniqueness of the IPv6 handling concerns only the '''same''' [[#server|server {...}]] block.
<geshi lang="nginx">
listen [2a02:750:5::123]:80;
listen [::]:80 default_server ipv6only=on;
</geshi>

If only the address is given, the default port nginx binds to is 80.

If the directive has the ''default_server'' parameter, then the enclosing [[#server|server {...}]] block will be the default server for the address:port pair. This is useful for name-based virtual hosting where you wish to specify the default server block for hostnames that do not match any [[#server_name|server_name]] directives. If there are no directives with the ''default_server'' parameter, then the default server will be the first server block in which the <code>address:port</code> pair appears. The ''default_server'' parameter appeared in version 0.8.21 thus deprecating the parameter ''default''.

The <code>listen</code> directive accepts several parameters, specific to the system calls <code>listen(2)</code> and <code>bind(2)</code>. These parameters must follow the <code>default</code> parameter.

backlog=num -- is assigned parameter backlog in call <code>listen(2)</code>. By default backlog equals -1.

rcvbuf=size -- assigned to the parameter <code>SO_RCVBUF</code> for the listening socket.

sndbuf=size -- assigned to the parameter <code>SO_SNDBUF</code> for the listening socket.

accept_filter=filter -- is assigned name accept-filter.

: . It works only to FreeBSD, it is possible to use two filters -- <code>dataready</code> and <code>httpready</code>. On the signal -HUP accept-filter it is possible to change only in the quite last versions FreeBSD: 6.0, 5.4-STABLE and 4.11-STABLE.
deferred -- indicates to use that postponed accept(2) on Linux with

: . the aid of option <code>TCP_DEFER_ACCEPT</code>.
bind -- indicates that it is necessary to make <code>bind(2)</code> separately

: . for this pair of address:port. The fact is that if are described several directives listen with the identical port, but by different addresses and one of the directives listen listens to on all addresses for this port (*:port), then nginx will make bind(2) only to *:port. It is necessary to consider that in this case for determining the address, on which the connections arrive, is done the system call getsockname(). But if are used parameters backlog, rcvbuf, sndbuf, accept_filter or deferred, then it is always done separately for this pair of address:port bind(2).
ssl -- parameter (0.7.14) not related to listen(2) and bind(2) syscalls

: . but instead specifies that connections accepted on this port should work in SSL mode. This allows to specify compact configurations for servers working with both HTTP and HTTPS. For example:
<geshi lang="nginx">
listen 80;
listen 443 default_server ssl;
</geshi>

Example of the use of the parameters:
<geshi lang="nginx">
listen 127.0.0.1 default_server accept_filter=dataready backlog=1024;
</geshi>

Since version 0.8.21 nginx is able to listen on unix sockets:
<geshi lang="nginx">
listen unix:/tmp/nginx1.sock;
</geshi>

== location ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/location.txt" />

This directive allows different configurations depending on the URI. It can be configured using both literal strings and regular expressions. To use regular expressions, you must use a prefix:
# "~" for case sensitive matching
# "~*" for case insensitive matching
# there is no syntax for NOT matching a regular expression. Instead, match the target regular expression and assign an empty block, then use ''location /'' to match anything else.

The order in which ''location'' directives are checked is as follows:

# Directives with the "=" prefix that match the query exactly (literal string). If found, searching stops.
# All remaining directives with conventional strings. If this match used the "^~" prefix, searching stops.
# Regular expressions, in the order they are defined in the configuration file.
# If #3 yielded a match, that result is used. Otherwise, the match from #2 is used.

Details below.

To determine which ''location'' directive matches a particular query, the literal strings are checked first. Literal strings match the beginning portion of the query - the most specific match will be used. Afterwards, regular expressions are checked in the order defined in the configuration file. The first regular expression to match the query will stop the search. If no regular expression matches are found, the result from the literal string search is used.

For case-insensitive operating systems, like Mac OS X or Windows with Cygwin, literal string matching is done in a case insensitive way (0.7.7). However, comparison is limited to single-byte locale's only.

Regular expression may contain captures (0.7.40), which can then be used in other directives.

It is possible to disable regular expression checks after literal string matching by using "^~" prefix. If the most specific match literal location has this prefix: regular expressions aren't checked.

The "=" prefix forces an '''exact''' (literal) match between the request URI and the ''location'' parameter. When matched, the search stops immediately. A useful application is that if the request "/" occurs frequently, it's better to use "location = /", as that will speed up the processing of this request a bit, since the search will stop after the first comparison.

On exact match with literal location without "=" or "^~" prefixes search is also immediately terminated.

It is important to know that nginx does the comparison against decoded URIs. For example, if you wish to match "/images/%20/test", then you must use "/images/ /test" to determine the location.

Example:

<geshi lang="nginx">
location = / {
# matches the query / only.
[ configuration A ]
}
location / {
# matches any query, since all queries begin with /, but regular
# expressions and any longer conventional blocks will be
# matched first.
[ configuration B ]
}
location ^~ /images/ {
# matches any query beginning with /images/ and halts searching,
# so regular expressions will not be checked.
[ configuration C ]
}
location ~* \.(gif|jpg|jpeg)$ {
# matches any request ending in gif, jpg, or jpeg. However, all
# requests to the /images/ directory will be handled by
# Configuration C.
[ configuration D ]
}
</geshi>

Example requests:

* / -> configuration A
* /documents/document.html -> configuration B
* /images/1.gif -> configuration C
* /documents/1.jpg -> configuration D

Note that you could define these 4 configurations in any order and the results would remain the same.

The prefix "@" specifies a named location. Such locations are not used during normal processing of requests, they are intended only to process internally redirected requests (see
[[HttpCoreModule#error_page|error_page]], [[HttpCoreModule#try_files|try_files]]).

== log_not_found ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/log_not_found.txt" />

The directive enables or disables messages in [[CoreModule#error_log|error_log]] about files not found on disk.

== log_subrequest ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/log_subrequest.txt" />

The directive enables or disables messages in [[HttpLogModule#access_log|access_log]] about sub-requests such as [[HttpRewriteModule#Synopsis|rewrite rules]] and/or [[HttpSsiModule#Synopsis|SSI requests]].

== max_ranges ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/max_ranges.txt" />

== merge_slashes ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/merge_slashes.txt" />

Enables merging adjacent slashes when parsing the request line. For example, a request for http://www.example.com/foo//bar/ will produce the following values for $uri:

* on: /foo/bar/
* off: /foo//bar/

Be aware that static location matching is performed as a string compare, so if merge_slashes is turned off, a request for /foo//bar/ will *not* match <code>location /foo/bar/</code>.

== msie_padding ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/msie_padding.txt" />

This directive enables or disables the msie_padding feature for MSIE browsers, and Chrome (as of nginx 0.8.25+). When this is enabled, nginx will pad the size of the response body to a minimum of 512 bytes for responses with a status code above or equal to 400.

The padding prevents the activation of "friendly" HTTP error pages in MSIE and Chrome, so as to not hide/mask the more-informative error pages from the server.

== msie_refresh ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/msie_refresh.txt" />

This directive allows or forbids issuing a <code>refresh</code> instead of doing a <code>redirect</code> for MSIE.

== open_file_cache ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache.txt" />

The directive sets the cache activity on. These information can be stored:

* Open file descriptors, information with their size and modification time;
* Information about the existence of directories;
* Error information when searches for a file - no file, do not have rights to read, etc. See also [[#open_file_cache_errors|open_file_cache_errors]]

Options directive:

* <code>max</code> - specifies the maximum number of entries in the cache. When the cache overflows, the least recently used(LRU) items will be removed;
* <code>inactive</code> - specifies the time when the cached item is removed, if it has not been downloaded during that time, the default is 60 seconds;
* <code>off</code> - prohibits the cache activity.

Example:
<geshi lang="nginx">
open_file_cache max=1000 inactive=20s;
open_file_cache_valid 30s;
open_file_cache_min_uses 2;
open_file_cache_errors on;
</geshi>

== open_file_cache_errors ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache_errors.txt" />

The directive specifies whether or not to cache errors when searching for a file.

== open_file_cache_min_uses ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache_min_uses.txt" />

The directive defines the minimum use number of a file within the time specified in the directive parameter inactive in [[#open_file_cache|open_file_cache]]. ?If use more than the number, the file descriptor will remain open in the cache.

== open_file_cache_valid ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache_valid.txt" />

The directive specifies the time when need to check the validity of the information about the item in [[#open_file_cache|open_file_cache]].

== optimize_server_names ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/optimize_server_names.txt" />

Directive activates or deactivates optimization of host name checks for name-based virtual servers.

In particular, the check influences the name of the host used in redirects. If optimization is on, and all name-based servers listening on one address:port pair have identical configuration, then names are not checked during request execution and redirects use first server name.

If redirect must use host name passed by the client, then the optimization must be turned off.

Note: this directive is deprecated in nginx 0.7.x, use [[#server_name_in_redirect|server_name_in_redirect]] instead.

== port_in_redirect ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/port_in_redirect.txt" />

Directive allows or prevents port indication in redirects handled by nginx.

If <code>port_in_redirect</code> is off, then Nginx will '''not''' add the port in the url when the request is redirected.

== post_action ==
'''syntax:''' ''post_action [ uri|off ] ''

'''default:''' ''post_action off''

'''context:''' ''http, server, location, if-in-location''

Defines a URI to sub-request upon completion of current request.

<geshi lang="nginx">
location /protected_files {
internal;

proxy_pass http://127.0.0.2;
post_action /protected_done;
}

# Send the post_action request to a FastCGI backend for logging.
location /protected_done {
internal;
fastcgi_pass 127.0.0.1:9000;
}
</geshi>

'''Note:''' this directive "has subtleties" according to Maxim Dounin, so '''use at your own risk.'''

== postpone_output ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/postpone_output.txt" />

== read_ahead ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/read_ahead.txt" />

== recursive_error_pages ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/recursive_error_pages.txt" />

<code>recursive_error_pages</code> enables or disables following a chain of <code>error_page</code> directives.

== request_pool_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/request_pool_size.txt" />

The directive is used to allocate memory per request. The pool is used for small allocations. If a block is bigger than pool size or bigger than page size, then it is allocated outside the pool. If there is not enough memory for small allocation inside pool, then a new block of the same pool size is allocated. This directive has only a very small effect. (source http://markmail.org/message/b2kmrluscevimpba)

== reset_timedout_connection ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/reset_timedout_connection.txt" />

This directive enables or disables resetting the connection on
timeout. When resetting the connection, before the socket is closed,
the socket SO_LINGER option is set with a 0 timeout, which
forces the RST packet to be sent to the client upon closing the socket, thus freeing
all memory associated with it. This prevents the socket in the FIN_WAIT1 state, along with the buffers
associated with it from lying around.

Note that sockets with keepalive connections, after the defined timeout, are closed in the usual way.

== resolver ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/resolver.txt" />

Directive defines DNS server address, e.g.

<geshi lang="nginx">
resolver 127.0.0.1;
</geshi>

== resolver_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/resolver_timeout.txt" />

Directive defines timeout for name resolution, e.g.

<geshi lang="nginx">
resolver_timeout 5s;
</geshi>

== root ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/root.txt" />

'''root''' specifies the document root for the requests. For example, with this configuration

<geshi lang="nginx">
location /i/ {
root /spool/w3;
}
</geshi>
A request for "/i/top.gif" will return the file "/spool/w3/i/top.gif". You can use variables in the argument.

'''note:''' Keep in mind that the root will still append the directory to the request so that a request for "/i/top.gif" will not look in "/spool/w3/top.gif" like might happen in an Apache-like alias configuration where the location match itself is dropped. Use the <code>alias</code> directive to achieve the Apache-like functionality.

== satisfy ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/satisfy.txt" />

This determines the adopted access policy when directives from multiple access phase handlers, such as the [[HttpAccessModule|Access]] and [[HttpAuthBasicModule|Auth Basic]] modules, are defined in a context:
* all - All access phase handlers must grant access to the context
* any - Any access phase handler may grant access to the context

<geshi lang="nginx">
location / {
satisfy any;
allow 192.168.1.0/32;
deny all;
auth_basic "closed site";
auth_basic_user_file conf/htpasswd;
}
</geshi>

== satisfy_any ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/satisfy_any.txt" />

'''deprecated:''' 0.6.25 -- Use the [[#satisfy|satisfy]] directive instead

== send_lowat ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/send_lowat.txt" />

== send_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/send_timeout.txt" />

Specifies the response timeout to the client. This timeout does not apply to the ''entire'' transfer but, rather, only between two subsequent client-read operations. Thus, if the client has not read any data for this amount of time, then nginx shuts down the connection.

== sendfile ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/sendfile.txt" />

Directive activate or deactivate the usage of <code>sendfile()</code>.

sendfile() copies data between one file descriptor and another. Because this copying is done within the kernel, sendfile() is more efficient than the combination of read(2) and write(2), which would require transferring data to and from user space.

Read more at: https://www.kernel.org/doc/man-pages/online/pages/man2/sendfile.2.html

How does sendfile helps : http://www.techrepublic.com/article/use-sendfile-to-optimize-data-transfer/1044112

== sendfile_max_chunk ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/sendfile_max_chunk.txt" />

== server ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server.txt" />

Directive assigns configuration for the virtual server.

There is no separation of IP and name-based (the <code>Host</code> header of the request) servers.

Instead, the directive <code>listen</code> is used to describe all addresses and ports on which incoming connections can occur, and in directive <code>server_name</code> indicate all names of the server.

== server_name ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_name.txt" />

This directive performs two actions:

* Compares the <code>Host</code> header of the incoming HTTP request against the [[#server|server { ... }]] blocks in the Nginx configuration files and selects the first one that matches. This is how '''virtual servers''' are defined. Server names are processed in the following order:

# full, static names
# names with a wildcard at the start of the name — *.example.com
# names with a wildcard at the end of the name — www.example.*
# names with regular expressions
: If there is no match, a [[#server|server { ... }]] block in the configuration file will be used based on the following order:
# the server block with a matching <code>listen</code> directive marked as <code>[default|default_server]</code>
# the first server block with a matching <code>listen</code> directive (or implicit <code>listen 80;</code>)

* Sets the server name that will be used in HTTP redirects if [[#server_name_in_redirect|server_name_in_redirect]] is set.

Example:

<geshi lang="nginx">
server {
server_name example.com www.example.com;
}
</geshi>

The first name becomes the basic name of server. By default the name of the machine (hostname) is used.

It is possible to use "*" for replacing the first or the last part of the name:

<geshi lang="nginx">
server {
server_name example.com *.example.com www.example.*;
}
</geshi>

The first two of the above names (example.com and *.example.com) can be combined into one:

<geshi lang="nginx">
server {
server_name .example.com;
}
</geshi>

It is also possible to use regular expressions in server names, prepending the name with a tilde "~" like so:

<geshi lang="nginx">
server {
server_name www.example.com ~^www\d+\.example\.com$;
}
</geshi>

Since nginx 0.7.12, an empty server name is supported to catch the requests without "Host" header, please note that most browsers will always send a Host header, if accessed by IP the Host header will contain the IP. To specify a catch-all block please see the default_server flag of the listen directive.
<geshi lang="nginx">
server {
server_name "";
}
</geshi>

Since nginx 0.8.25 named captures can be used in server_name:
<geshi lang="nginx">
server {
server_name ~^(www\.)?(?<domain>.+)$;
root /sites/$domain;
}
</geshi>

Some older versions of PCRE may have issues with this syntax. If any problems arise try this following syntax:
<geshi lang="nginx">
server {
server_name ~^(www\.)?(?P<domain>.+)$;
root /sites/$domain;
}
</geshi>

Since nginx 0.9.4, [[#.24hostname|$hostname]] can be used as a server_name argument:
<geshi lang="nginx">
server {
server_name $hostname;
}
</geshi>

== server_name_in_redirect ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_name_in_redirect.txt" />

If <code>server_name_in_redirect</code> is on, then Nginx will use the first value
of the [[#server_name|server_name]] directive for redirects. If <code>server_name_in_redirect</code> is off,
then nginx will use the requested <code>Host</code> header.

Note: for Location headers coming from an upstream proxy (via proxy_pass for example) this may not be the only directive you need. In fact, it seems to be ignored a lot of the time. If you are seeing the upstream's server name come through and not be rewritten, you will need to use [[NginxHttpProxyModule#proxy_redirect|proxy_redirect]] to rewrite the upstream's provided hostname to what you want. Something like <code>proxy_redirect http://some.upstream.url/ /</code> - you will want to rewrite it to a / relative path.

== server_names_hash_max_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_names_hash_max_size.txt" />

The maximum size of the server name hash tables. For more detail see the description of tuning the hash tables in [[Optimizations|Nginx Optimizations]].

== server_names_hash_bucket_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_names_hash_bucket_size.txt" />

Directive assigns the size of basket in the hash-tables of the names of servers. This value by default depends on the size of the line of processor cache. For more detail see the description of tuning the hash tables in [[Optimizations|Nginx Optimizations]].

== server_tokens ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_tokens.txt" />

Whether to send the Nginx version number in error pages and <code>Server</code> header.

== tcp_nodelay ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/tcp_nodelay.txt" />

This directive allows or forbids the use of the socket option <code>TCP_NODELAY</code>. Only included in <code>keep-alive</code> connections.

You can read more about the <code>TCP_NODELAY</code> socket option [[ReadMoreAboutTcpNodelay|here]].

== tcp_nopush ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/tcp_nopush.txt" />

This directive permits or forbids the use of the socket options <code>TCP_NOPUSH</code> on FreeBSD or <code>TCP_CORK</code> on Linux. This option is only available when using <code>sendfile</code>.

Setting this option causes nginx to attempt to send it's HTTP response headers in one packet on Linux and FreeBSD 4.x

You can read more about the <code>TCP_NOPUSH</code> and <code>TCP_CORK</code> socket options [[ReadMoreAboutTcpNopush|here]].

== try_files ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/try_files.txt" />

Checks for the existence of files in order, and returns the first file that is found. A trailing slash indicates a directory - <code>$uri /</code>. In the event that no file is found, an internal redirect to the last parameter is invoked. The last parameter is the fallback URI and *must* exist, or else an internal error will be raised. Unlike rewrite, $args are not automatically preserved if the fallback is not a named location. If you need args preserved, you must do so explicitly:

<geshi lang="nginx">
try_files $uri $uri/ /index.php?q=$uri&$args;
</geshi>

Example use in proxying Mongrel:
<geshi lang="nginx">
try_files /system/maintenance.html $uri $uri/index.html $uri.html @mongrel;

location @mongrel {
proxy_pass http://mongrel;
}
</geshi>

Note that you can specify an HTTP '''status''' code as the last argument to <code>try_file</code> since Nginx version 0.7.51. Here's an example:
<geshi lang="nginx">
location / {
try_files $uri $uri/ /error.php?c=404 =404;
}
</geshi>
When all other attempts to serve the content corresponding to the request fail issue a <code>404 Not Found</code>.

Example of use with Drupal / FastCGI:
<geshi lang="nginx">
# for Drupal 6 or 7:
try_files $uri $uri/ /index.php?q=$uri&$args;

# a better version for Drupal 7 since it doesn't need q=$uri:
try_files $uri $uri/ /index.php?$args;

location ~ \.php$ {
fastcgi_pass 127.0.0.1:8888;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; # if not already defined in the fastcgi_params file
# any other specific fastcgi_params
}
</geshi>

In this example, the directive <code>try_files</code>
<geshi lang="nginx">
try_files $uri $uri/ /index.php?q=$uri&$args;
</geshi>

Is basically the same as this:
<geshi lang="nginx">
location / {
error_page 404 = @drupal;
log_not_found off;
}

location @drupal {
rewrite ^ /index.php?q=$uri last; # for drupal 6
}
</geshi>

Or this:
<geshi lang="nginx">
# DO NOT DO THIS! This is a terrible use of if.
if (!-e $request_filename) {
rewrite ^ /index.php?q=$uri last;
}
</geshi>

<code>try_files</code> is basically a replacement for the typical mod_rewrite style file/directory existence check. It is supposed to be more efficient than using <code>if</code> - see [[IfIsEvil]]

Examples of use with Wordpress and Joomla (typical "Front controller pattern" packages)
<geshi lang="nginx">
# wordpress (without WP Super Cache) - example 1
try_files $uri $uri/ /index.php?q=$uri&$args;

# wordpress (without WP Super Cache) - example 2
# It doesn't REALLY need the "q" parameter, but without an explicit $args php
# gets an empty QUERY_STRING, breaking generated responses that don't use a
# permalink, such as search results.
try_files $uri $uri/ /index.php?$args;

# joomla
try_files $uri $uri/ /index.php?q=$uri&$args;

location ~ \.php$ {
fastcgi_pass 127.0.0.1:8888;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; # if not already defined in the fastcgi_params file
# any other specific fastcgi_params
}
</geshi>

WP Super Cache requires a bunch of static file checks. Those are not shown here.

== types ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/types.txt" />

Specifies one or more mappings between MIME types and file extensions. More than one extension can be assigned to a MIME type.

For example:

<geshi lang="nginx">
types {
text/html html;
image/gif gif;
image/jpeg jpg;
}
</geshi>

A sufficiently complete table of mappings is included with nginx, and is located at <code>conf/mime.types</code>.

If you wanted responses to particular location to always indicate a single MIME type, you could define an empty ''types'' block and set the ''default_type'' directive. For example:

<geshi lang="nginx">
location /download/ {
types { }
default_type application/octet-stream;
}
</geshi>

== types_hash_bucket_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/types_hash_bucket_size.txt" />

== types_hash_max_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/types_hash_max_size.txt" />

== underscores_in_headers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/underscores_in_headers.txt" />

Allows or disallows underscores in headers.

== variables_hash_bucket_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/variables_hash_bucket_size.txt" />

Assigns the key bucket size for the variables hash table.

== variables_hash_max_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/variables_hash_max_size.txt" />

The maximum size of the variables hash table. For more detail see the description of tuning the hash tables in [[Optimizations|Nginx Optimizations]].

= Variables =
The core module supports built-in variables, whose names correspond with the names of variables in Apache.

First of all, there are variables which represent header lines in the client request, for example, <code>$http_user_agent</code>, <code>$http_cookie</code>, and so forth. Note that because these correspond to what the client actually sends, they are not guaranteed to exist and their meaning is defined elsewhere (e.g. in relevant standards).

Furthermore, there are other variables:

== $arg_PARAMETER ==
This variable contains the value of the <code>GET</code> request variable ''PARAMETER'' if present in the query string

== $args ==
This variable is the <code>GET</code> parameters in request line, e.g. <code>foo=123&bar=blahblah</code>; This variable could be changed.

== $binary_remote_addr ==
The address of the client in binary form;

== $body_bytes_sent ==
The amount of bytes sent as part of the body of the response. Is accurate even when connections are aborted or interrupted.

== $content_length ==
This variable is equal to line <code>Content-Length</code> in the header of request;

== $content_type ==
This variable is equal to line <code>Content-Type</code> in the header of request;

== $cookie_COOKIE ==
The value of the cookie ''COOKIE'';

== $document_root==
This variable is equal to the value of directive [[#root|root]] for the current request;

== $document_uri ==
The same as [[#$uri|$uri]].

== $host==
This variable is equal to line <code>Host</code> in the header of request or name of the server processing the request if the <code>Host</code> header is not available.

This variable may have a different value from <code>$http_host</code> in such cases: 1) when the <code>Host</code> input header is absent or has an empty value, <code>$host</code> equals to the value of <code>server_name</code> directive; 2)when the value of <code>Host</code> contains port number, <code>$host</code> doesn't include that port number. <code>$host</code>'s value is always lowercase since 0.8.17.

== $hostname ==
Set to the machine's hostname as returned by [http://linux.die.net/man/2/gethostname gethostname]

== $http_HEADER ==
The value of the HTTP request header ''HEADER'' when converted to lowercase and with 'dashes' converted to 'underscores', e.g. <code>$http_user_agent</code>, <code>$http_referer</code>...;

== $sent_http_HEADER ==
The value of the HTTP response header ''HEADER'' when converted to lowercase and with 'dashes' converted to 'underscores', e.g. <code>$sent_http_cache_control</code>, <code>$sent_http_content_type</code>...;

== $is_args ==
Evaluates to "?" if [[#$args|$args]] is set, "" otherwise.

== $limit_rate ==
This variable allows limiting the connection rate.

== $nginx_version ==
The version of Nginx that the server is currently running;

== $query_string ==
The same as [[#$args|$args]] except that this variable is readonly.

== $remote_addr ==
The address of the client.

== $remote_port ==
The port of the client;

== $remote_user ==
This variable is equal to the name of user, authenticated by the [[HttpAuthBasicModule|Auth Basic Module]];

== $request_filename ==
This variable is equal to path to the file for the current request, formed from directives root or alias and URI request;

== $request_body ==
This variable(0.7.58+) contains the body of the request. The significance of this variable appears in locations with directives [[HttpProxyModule#proxy_pass|proxy_pass]] or [[HttpFcgiModule#fastcgi_pass|fastcgi_pass]].

== $request_body_file ==
Client request body temporary filename;

== $request_completion ==
Set to "OK" if request was completed successfully. Empty if request was not completed or if request was not the last part of a series of range requests.

== $request_method ==
This variable is equal to the method of request, usually <code>GET</code> or <code>POST</code>.

This variable always evaluates to the method name of the ''main request'', not the current request, when the current request is a subrequest.

== $request_uri ==
This variable is equal to the *original* request URI as received from the client including the args. It cannot be modified. Look at $uri for the post-rewrite/altered URI.
Does not include host name. Example: "/foo/bar.php?arg=baz"

== $scheme ==
The HTTP scheme (i.e. http, https). Evaluated only on demand, for example:
<geshi lang="nginx">
rewrite ^ $scheme://example.com$uri redirect;
</geshi>

== $server_addr ==
The server address. Generally nginx makes a system call to obtain this value. To improve efficiency and avoid this system call, specify an address with the [[#listen|listen]] directive and to use the <code>bind</code> parameter.

== $server_name ==
The name of the server.

== $server_port ==
This variable is equal to the port of the server, to which the request arrived;

== $server_protocol ==
This variable is the protocol of the request. Common examples are: <code>HTTP/1.0</code> or <code>HTTP/1.1</code>

== $uri ==
This variable is the current request URI, without any arguments (see $args for those). This variable will reflect any modifications done so far by internal redirects or the [[HttpIndexModule#index|index]] module. Note this may be different from $request_uri, as $request_uri is what was originally sent by the browser before any such modifications. Does not include the protocol or host name. Example: <code>/foo/bar.html</code>

= References =
[http://nginx.org/en/docs/http/ngx_http_core_module.html Original Documentation]

HttpCoreModule

2012-05-02T23:35:37Z

Admin: /* post_action */

= Synopsis =

Controls core features of Nginx's HTTP processing.

= Directives =
== aio ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/aio.txt" />

This directive is usable as of Linux kernel 2.6.22. For Linux it is required to use directio, this automatically disables sendfile support.

<geshi lang="nginx">
location /video {
aio on;
directio 512;
output_buffers 1 128k;
}
</geshi>

In FreeBSD before 5.2.1 and Nginx 0.8.12 you must disable sendfile support.

<geshi lang="nginx">
location /video {
aio on;
sendfile off;
output_buffers 1 128k;
}
</geshi>

As of FreeBSD 5.2.1 and Nginx 0.8.12 you can use it along with sendfile.
<geshi lang="nginx">
location /video {
aio sendfile;
sendfile on;
tcp_nopush on;
}
</geshi>

== alias ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/alias.txt" />

This directive assigns a path to be used as the basis for serving requests for the indicated location. Note that it may look similar to the <code>root</code> directive at first sight, but the document root doesn't change, just the file system path used for the request. The location part of the request is '''dropped''' in the request Nginx issues. Let's see this in action. Consider the following example.
<geshi lang="nginx">
location /i/ {
alias /spool/w3/images/;
}
</geshi>
A request for "/i/top.gif" will instruct Nginx to serve the file "/spool/w3/images/top.gif". As you can see, '''only''' the part of the URI '''after''' the location is appended. The location itself, in this case "/i/", is dropped. With a <code>root</code> directive the '''full''' path is appended, i.e., in the above example it would have been, "/spool/w3/images/i/top.gif" — hence including '''also''' the location "/i/".

Aliases can also be used in a location specified by a regex.

For example:

<geshi lang="nginx">
location ~ ^/download/(.*)$ {
alias /home/website/files/$1;
}
</geshi>

The request "/download/book.pdf" will return the file "/home/website/files/book.pdf". Note again that only part of the request URI '''after''' the location is appended to the path defined by <code>alias</code>.

It is possible to use variables in the replacement path.

== chunked_transfer_encoding ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/chunked_transfer_encoding.txt" />

This directive (0.7.66+) sets whether chunked encoding is enabled in responses (only valid for connections using HTTP 1.1 or later).

== client_body_in_file_only ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_in_file_only.txt" />

The directive forces nginx to always store a client request body into a temporary disk file even if the body is actually of 0 size.

Please note that the file will '''NOT''' be removed at request completion if the directive is enabled.

This directive can be used for debugging and for the <code>$r->request_body_file</code> method in the [[EmbeddedPerlModule|Embedded Perl module]].

== client_body_in_single_buffer ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_in_single_buffer.txt" />

The directive(0.7.58+) specifies whether to keep the whole body in a single client request buffer. The directive is recommended when using the variable [[#$request_body|$request_body]] to reduce the operations of copying.

Note that when the request body cannot be hold in a single buffer (see [[#client_body_buffer_size|client_body_buffer_size]]), the body will still touch the disk.

== client_body_buffer_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_buffer_size.txt" />

The directive specifies the client request body buffer size.

If the request body size is more than the buffer size, then the entire (or partial) request body is written into a temporary file.

The default size is equal to page size times 2. Depending on the platform, the page size is either 8K or 16K.

When the ''Content-Length'' request header specifies a smaller size value than the buffer size, then Nginx will use the smaller one. As a result, Nginx will '''not''' always allocate a buffer of this buffer size for every request.

== client_body_temp_path ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_temp_path.txt" />

The directive assigns the directory for storing the temporary files in it with the body of the request.

In the <code>dir-path</code> a hierarchy of subdirectories up to three levels are possible.

For example

<geshi lang="nginx">
client_body_temp_path /spool/nginx/client_temp 1 2;
</geshi>
The directory structure will be like this:

<pre>
/spool/nginx/client_temp/7/45/00000123457
</pre>

== client_body_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_body_timeout.txt" />

Directive sets the read timeout for the request body from client.

The timeout is set only if a body is not get in one readstep. If after this time the client send nothing, nginx returns error "Request time out" (408).

== client_header_buffer_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_header_buffer_size.txt" />

Directive sets the headerbuffer size for the request header from client.

For the overwhelming majority of requests it is completely sufficient a buffer size of 1K.

However if a big cookie is in the request-header or the request has come from a wap-client the header can not be placed in 1K, therefore, the request-header or a line of request-header is not located completely in this buffer nginx allocate a bigger buffer, the size of the bigger buffer can be set with the instruction large_client_header_buffers.

== client_header_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_header_timeout.txt" />

Specifies how long to wait for the client to send a request header (e.g.: <code>GET / HTTP/1.1</code>).

This timeout is reached only if a header is not received in one read ''(needs clarification)''. If the client has not sent anything within this timeout period, nginx returns the HTTP status code 408 ("Request timed out")

== client_max_body_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/client_max_body_size.txt" />

Specifies the maximum accepted body size of a client request, as indicated by the request header <code>Content-Length</code>.

If the stated content length is greater than this size, then the client receives the HTTP error code 413 ("Request Entity Too Large"). It should be noted that web browsers do not usually know how to properly display such an HTTP error.

== connection_pool_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/connection_pool_size.txt" />

The directive is used to allocate memory per connection. The pool is used for small allocations. If a block is bigger than pool size or bigger than page size, then it is allocated outside the pool. If there is not enough memory for small allocation inside pool, then a new block of the same pool size is allocated. This directive has only a very small effect. (source http://markmail.org/message/b2kmrluscevimpba)

== default_type ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/default_type.txt" />

Assigns the default MIME-type to be used for files where the standard MIME map doesn't specify anything.

See also [[#types|types]]

== directio ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/directio.txt" />

The directive enables use of flags O_DIRECT (FreeBSD, Linux), F_NOCACHE (Mac OS X) or directio() function (Solaris) for reading files with size greater than specified. This directive disables use of [[HttpCoreModule#sendfile|sendfile]] for this request. This directive may be useful for big files:
<geshi lang="nginx">
directio 4m;
</geshi>

== directio_alignment ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/directio_alignment.txt" />

== disable_symlinks ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/disable_symlinks.txt" />

== error_page ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/error_page.txt" />

The directive specifies the URI that will be shown for the errors indicated.

Example:
<geshi lang="nginx">
error_page 404 /404.html;
error_page 502 503 504 /50x.html;
error_page 403 http://example.com/forbidden.html;
error_page 404 = @fetch;
</geshi>
Furthermore, it is possible to change the status code of the answer to another, for example:

<geshi lang="nginx">
error_page 404 =200 /empty.gif;
error_page 404 =403 /forbidden.gif;
</geshi>
Additionally you can have your designated error handler determine the returned status code by using = without specifying a status code.

<geshi lang="nginx">
error_page 404 = /404.php;
</geshi>
If there is no need to change URI during redirection it is possible to redirect processing of error pages into a named location:

<geshi lang="nginx">
location / (
error_page 404 @fallback;
)

location @fallback (
proxy_pass http://backend;
)
</geshi>

== if_modified_since ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/if_modified_since.txt" />

Specifies how to compare time of file modification and time in request header "If-Modified-Since":
* off — don't check "If-Modified-Since" request header (0.7.34);
* exact — exact match;
* before — file modification time should be less than time in "If-Modified-Since" request header.

== ignore_invalid_headers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/ignore_invalid_headers.txt" />

== internal ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/internal.txt" />

'''internal''' indicates that the matching location can be used only for so called "internal" requests.

For external requests it will return the error "Not found" (404).

Internal requests are the following:
* requests redirected by the instruction '''error_page'''
* subrequests created by the command '''include virtual''' of the "ngx_http_ssi_module" module
* requests changed by the instruction '''rewrite''' of the "ngx_http_rewrite_module" module

An example to prevent clients fetching error pages directly:
<geshi lang="nginx">
error_page 404 /404.html;
location /404.html {
internal;
}
</geshi>

== keepalive_disable ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/keepalive_disable.txt" />

Disable keepalive for certain user agents (0.9.0+). By default keepalive is disabled for MS Internet Explorer (older than 6.0 service pack 2) after <code>POST</code> requests, and for Safari. This is because both browsers have issues with handling <code>POST</code> requests with keepalives. If you are running a site that does not use <code>POST</code> anywhere, you may optionally choose to enable keepalive in these browsers.

== keepalive_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/keepalive_timeout.txt" />

The first parameter assigns the timeout for keep-alive connections with the client. The server will close connections after this time.

The optional second parameter assigns the <code>time</code> value in the header <code>Keep-Alive: timeout=time</code> of the response. This header can convince some browsers to close the connection, so that the server does not have to. Without this parameter, nginx does not send a <code>Keep-Alive</code> header (though this is not what makes a connection "keep-alive").

The parameters can differ from each other.

Notes on how browsers handle the <code>Keep-Alive</code> header:

* MSIE and Opera ignore the "Keep-Alive: timeout=<N>" header.
* MSIE keeps the connection alive for about 60-65 seconds, then sends a TCP RST.
* Opera keeps the connection alive for a long time.
* Mozilla keeps the connection alive for N plus about 1-10 seconds.
* Konqueror keeps the connection alive for about N seconds.

== keepalive_requests ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/keepalive_requests.txt" />

Number of requests which can be made over a keep-alive connection.

== large_client_header_buffers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/large_client_header_buffers.txt" />

Directive assigns the maximum number and size of buffers for large headers to read from client request.

The request line can not be bigger than the size of one buffer, if the client send a bigger header nginx returns error "Request URI too large" (414).

The longest header line of request also must be not more than the size of one buffer, otherwise the client get the error "Bad request" (400).

Buffers are separated only as needed.

By default the size of one buffer is 8192 bytes. In the old nginx, this is equal to the size of page, depending on platform this either 4K or 8K, if at the end of working request connection converts to state keep-alive, then these buffers are freed.

== limit_except ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/limit_except.txt" />

Limits which HTTP methods are allowed for a given request path/location.

For the limitation can be used the directives of modules ngx_http_access_module and ngx_http_auth_basic_module:

<geshi lang="nginx">
limit_except GET {
allow 192.168.1.0/32;
deny all;
}
</geshi>

== limit_rate ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/limit_rate.txt" />

Directive assigns the speed of transmission of the answer to client. Speed is assigned in the bytes per second. Limitation works only for one connection, i.e., if client opens 2 connections, then total velocity will be 2 times higher then the limit set.

If it is necessary to limit speed for the part of the clients at the ''server'' level, based on some kind of condition - then this directive does not apply. Instead you should specify the limit by assigning the value to the $limit_rate variable, as shown below:

<geshi lang="nginx">
server {
if ($slow) {
set $limit_rate 4k;
}
}
</geshi>

You can also control the rate of individual responses returned by a <code>proxy_pass</code> response ([[HttpProxyModule]]) by setting the <code>X-Accel-Limit-Rate</code> header ([[XSendfile]]). This can be done without a <code>X-Accel-Redirect</code> header.

== limit_rate_after ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/limit_rate_after.txt" />

The directive limits speed only after the first part was sent.

<geshi lang="nginx">
limit_rate_after 1m;
limit_rate 100k;
</geshi>

== lingering_close ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/lingering_close.txt" />

Sets SO_LINGER on sockets.

== lingering_time ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/lingering_time.txt" />

Sets SO_LINGER on sockets.

== lingering_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/lingering_timeout.txt" />

Sets SO_LINGER on sockets.

== listen ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/listen.txt" />

The ''listen'' directive specifies the address and port accepted by the enclosing [[#server|server {...}]] block. It is possible to specify only an address, only a port, or a server name as the address.

<geshi lang="nginx">
listen 127.0.0.1:8000;
listen 127.0.0.1;
listen 8000;
listen *:8000;
listen localhost:8000;
</geshi>
IPv6 address(0.7.36) are set in square brackets:
<geshi lang="nginx">
listen [::]:8000;
listen [fe80::1];
</geshi>

In Linux by default any IPv6 TCP socket '''also accepts''' IPv4 traffic using the IPv4 to IPv6 mapped address format, i.e., ::ffff:<IPv4 adddress in dotted decimal notation>. E.g.,
<code>::ffff:192.168.0.27</code> maps the IPv4 address 192.168.0.27 to an IPv6 address.

When you enable the address [::]:80, binding port 80 using IPv6, in the listen directive, in Linux, by default, the IPv4 port 80 is also enabled. Meaning that nginx listens for '''both''' IPv4 and IPv6 incoming traffic. Therefore if you erroneously specify also a IPv4 address you'll get an ''already bind address'' error when reloading nginx configuration.

In Linux the separation of the IPv6 and IPv4 stacks is controlled through the runtime parameter:
<code>net.ipv6.bindv6only</code> which has the value 0 by default.

If you want to use '''separate''' sockets for IPv4 and IPv6 you should set this parameter to 1 using <code>sysctl</code>.

Note that any nginx instance that was running '''before''' you made the change will '''continue to accept''' IPv4 traffic. Therefore you should edit your nginx configuration to reflect the new setup for IPv6 and IPv4 packet handling and do a '''restart'''.

If on the other hand you launched another server instance (vhost) and you expect it to also handle IPv4 traffic by using only, for example:
<geshi lang="nginx">
listen [::]:80;
</geshi>
the binding of the IPv4 address will fail. The correct way to to this is by using the "ipv6only=on" option in the IPv6 listen directive and also specifying a IPv4 listen directive in the respective server block.

This re-editing of the configuration must be done '''after''' you changed your kernel runtime parameter. This is the most generic situation in that case (separation of IPv6 and IPv4 sockets):
<geshi lang="nginx">
listen [::]:80 ipv6only=on; # listen for IPv6 only traffic on IPv6 sockets
listen 80; # listen also for IPv4 traffic on "regular" IPv4 sockets
</geshi>

In FreeBSD the default is '''separate''' IPv4 and IPv6 sockets. Therefore "listen [::]:80" only binds port 80 for listening to IPv6 traffic. It's always necessary to specify also IPv4 listen directives if you wish to also handle IPv4 traffic.

It's possible to specify '''only''' IPv6 addresses in the listen directive. Using the "default_server ipv6only=on" option. Specific IPv6 addresses can be used with a IPv6 only default directive. Other server directives can also specifiy listen directives with IPv4 addresses. The uniqueness of the IPv6 handling concerns only the '''same''' [[#server|server {...}]] block.
<geshi lang="nginx">
listen [2a02:750:5::123]:80;
listen [::]:80 default_server ipv6only=on;
</geshi>

If only the address is given, the default port nginx binds to is 80.

If the directive has the ''default_server'' parameter, then the enclosing [[#server|server {...}]] block will be the default server for the address:port pair. This is useful for name-based virtual hosting where you wish to specify the default server block for hostnames that do not match any [[#server_name|server_name]] directives. If there are no directives with the ''default_server'' parameter, then the default server will be the first server block in which the <code>address:port</code> pair appears. The ''default_server'' parameter appeared in version 0.8.21 thus deprecating the parameter ''default''.

The <code>listen</code> directive accepts several parameters, specific to the system calls <code>listen(2)</code> and <code>bind(2)</code>. These parameters must follow the <code>default</code> parameter.

backlog=num -- is assigned parameter backlog in call <code>listen(2)</code>. By default backlog equals -1.

rcvbuf=size -- assigned to the parameter <code>SO_RCVBUF</code> for the listening socket.

sndbuf=size -- assigned to the parameter <code>SO_SNDBUF</code> for the listening socket.

accept_filter=filter -- is assigned name accept-filter.

: . It works only to FreeBSD, it is possible to use two filters -- <code>dataready</code> and <code>httpready</code>. On the signal -HUP accept-filter it is possible to change only in the quite last versions FreeBSD: 6.0, 5.4-STABLE and 4.11-STABLE.
deferred -- indicates to use that postponed accept(2) on Linux with

: . the aid of option <code>TCP_DEFER_ACCEPT</code>.
bind -- indicates that it is necessary to make <code>bind(2)</code> separately

: . for this pair of address:port. The fact is that if are described several directives listen with the identical port, but by different addresses and one of the directives listen listens to on all addresses for this port (*:port), then nginx will make bind(2) only to *:port. It is necessary to consider that in this case for determining the address, on which the connections arrive, is done the system call getsockname(). But if are used parameters backlog, rcvbuf, sndbuf, accept_filter or deferred, then it is always done separately for this pair of address:port bind(2).
ssl -- parameter (0.7.14) not related to listen(2) and bind(2) syscalls

: . but instead specifies that connections accepted on this port should work in SSL mode. This allows to specify compact configurations for servers working with both HTTP and HTTPS. For example:
<geshi lang="nginx">
listen 80;
listen 443 default_server ssl;
</geshi>

Example of the use of the parameters:
<geshi lang="nginx">
listen 127.0.0.1 default_server accept_filter=dataready backlog=1024;
</geshi>

Since version 0.8.21 nginx is able to listen on unix sockets:
<geshi lang="nginx">
listen unix:/tmp/nginx1.sock;
</geshi>

== location ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/location.txt" />

This directive allows different configurations depending on the URI. It can be configured using both literal strings and regular expressions. To use regular expressions, you must use a prefix:
# "~" for case sensitive matching
# "~*" for case insensitive matching
# there is no syntax for NOT matching a regular expression. Instead, match the target regular expression and assign an empty block, then use ''location /'' to match anything else.

The order in which ''location'' directives are checked is as follows:

# Directives with the "=" prefix that match the query exactly (literal string). If found, searching stops.
# All remaining directives with conventional strings. If this match used the "^~" prefix, searching stops.
# Regular expressions, in the order they are defined in the configuration file.
# If #3 yielded a match, that result is used. Otherwise, the match from #2 is used.

Details below.

To determine which ''location'' directive matches a particular query, the literal strings are checked first. Literal strings match the beginning portion of the query - the most specific match will be used. Afterwards, regular expressions are checked in the order defined in the configuration file. The first regular expression to match the query will stop the search. If no regular expression matches are found, the result from the literal string search is used.

For case-insensitive operating systems, like Mac OS X or Windows with Cygwin, literal string matching is done in a case insensitive way (0.7.7). However, comparison is limited to single-byte locale's only.

Regular expression may contain captures (0.7.40), which can then be used in other directives.

It is possible to disable regular expression checks after literal string matching by using "^~" prefix. If the most specific match literal location has this prefix: regular expressions aren't checked.

The "=" prefix forces an '''exact''' (literal) match between the request URI and the ''location'' parameter. When matched, the search stops immediately. A useful application is that if the request "/" occurs frequently, it's better to use "location = /", as that will speed up the processing of this request a bit, since the search will stop after the first comparison.

On exact match with literal location without "=" or "^~" prefixes search is also immediately terminated.

It is important to know that nginx does the comparison against decoded URIs. For example, if you wish to match "/images/%20/test", then you must use "/images/ /test" to determine the location.

Example:

<geshi lang="nginx">
location = / {
# matches the query / only.
[ configuration A ]
}
location / {
# matches any query, since all queries begin with /, but regular
# expressions and any longer conventional blocks will be
# matched first.
[ configuration B ]
}
location ^~ /images/ {
# matches any query beginning with /images/ and halts searching,
# so regular expressions will not be checked.
[ configuration C ]
}
location ~* \.(gif|jpg|jpeg)$ {
# matches any request ending in gif, jpg, or jpeg. However, all
# requests to the /images/ directory will be handled by
# Configuration C.
[ configuration D ]
}
</geshi>

Example requests:

* / -> configuration A
* /documents/document.html -> configuration B
* /images/1.gif -> configuration C
* /documents/1.jpg -> configuration D

Note that you could define these 4 configurations in any order and the results would remain the same.

The prefix "@" specifies a named location. Such locations are not used during normal processing of requests, they are intended only to process internally redirected requests (see
[[HttpCoreModule#error_page|error_page]], [[HttpCoreModule#try_files|try_files]]).

== log_not_found ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/log_not_found.txt" />

The directive enables or disables messages in [[CoreModule#error_log|error_log]] about files not found on disk.

== log_subrequest ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/log_subrequest.txt" />

The directive enables or disables messages in [[HttpLogModule#access_log|access_log]] about sub-requests such as [[HttpRewriteModule#Synopsis|rewrite rules]] and/or [[HttpSsiModule#Synopsis|SSI requests]].

== max_ranges ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/max_ranges.txt" />

== merge_slashes ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/merge_slashes.txt" />

Enables merging adjacent slashes when parsing the request line. For example, a request for http://www.example.com/foo//bar/ will produce the following values for $uri:

* on: /foo/bar/
* off: /foo//bar/

Be aware that static location matching is performed as a string compare, so if merge_slashes is turned off, a request for /foo//bar/ will *not* match <code>location /foo/bar/</code>.

== msie_padding ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/msie_padding.txt" />

This directive enables or disables the msie_padding feature for MSIE browsers, and Chrome (as of nginx 0.8.25+). When this is enabled, nginx will pad the size of the response body to a minimum of 512 bytes for responses with a status code above or equal to 400.

The padding prevents the activation of "friendly" HTTP error pages in MSIE and Chrome, so as to not hide/mask the more-informative error pages from the server.

== msie_refresh ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/msie_refresh.txt" />

This directive allows or forbids issuing a <code>refresh</code> instead of doing a <code>redirect</code> for MSIE.

== open_file_cache ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache.txt" />

The directive sets the cache activity on. These information can be stored:

* Open file descriptors, information with their size and modification time;
* Information about the existence of directories;
* Error information when searches for a file - no file, do not have rights to read, etc. See also [[#open_file_cache_errors|open_file_cache_errors]]

Options directive:

* <code>max</code> - specifies the maximum number of entries in the cache. When the cache overflows, the least recently used(LRU) items will be removed;
* <code>inactive</code> - specifies the time when the cached item is removed, if it has not been downloaded during that time, the default is 60 seconds;
* <code>off</code> - prohibits the cache activity.

Example:
<geshi lang="nginx">
open_file_cache max=1000 inactive=20s;
open_file_cache_valid 30s;
open_file_cache_min_uses 2;
open_file_cache_errors on;
</geshi>

== open_file_cache_errors ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache_errors.txt" />

The directive specifies whether or not to cache errors when searching for a file.

== open_file_cache_min_uses ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache_min_uses.txt" />

The directive defines the minimum use number of a file within the time specified in the directive parameter inactive in [[#open_file_cache|open_file_cache]]. ?If use more than the number, the file descriptor will remain open in the cache.

== open_file_cache_valid ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/open_file_cache_valid.txt" />

The directive specifies the time when need to check the validity of the information about the item in [[#open_file_cache|open_file_cache]].

== optimize_server_names ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/optimize_server_names.txt" />

Directive activates or deactivates optimization of host name checks for name-based virtual servers.

In particular, the check influences the name of the host used in redirects. If optimization is on, and all name-based servers listening on one address:port pair have identical configuration, then names are not checked during request execution and redirects use first server name.

If redirect must use host name passed by the client, then the optimization must be turned off.

Note: this directive is deprecated in nginx 0.7.x, use [[#server_name_in_redirect|server_name_in_redirect]] instead.

== port_in_redirect ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/port_in_redirect.txt" />

Directive allows or prevents port indication in redirects handled by nginx.

If <code>port_in_redirect</code> is off, then Nginx will '''not''' add the port in the url when the request is redirected.

== post_action ==
'''syntax:''' ''post_action [ uri|off ] ''

'''default:''' ''post_action off''

'''context:''' ''http, server, location, if-in-location''

Defines a URI to sub-request upon completion of current request.

<geshi lang="nginx">
location /protected_files {
internal;

proxy_pass http://127.0.0.2;
post_action /protected_done;
}

# Send the post_action request to a FastCGI backend for logging.
location /protected_done {
internal;
fastcgi_pass 127.0.0.1:9000;
}
</geshi>

Note: this directive "has subtleties" according to Maxim Dounin, so use at your own risk.

== postpone_output ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/postpone_output.txt" />

== read_ahead ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/read_ahead.txt" />

== recursive_error_pages ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/recursive_error_pages.txt" />

<code>recursive_error_pages</code> enables or disables following a chain of <code>error_page</code> directives.

== request_pool_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/request_pool_size.txt" />

The directive is used to allocate memory per request. The pool is used for small allocations. If a block is bigger than pool size or bigger than page size, then it is allocated outside the pool. If there is not enough memory for small allocation inside pool, then a new block of the same pool size is allocated. This directive has only a very small effect. (source http://markmail.org/message/b2kmrluscevimpba)

== reset_timedout_connection ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/reset_timedout_connection.txt" />

This directive enables or disables resetting the connection on
timeout. When resetting the connection, before the socket is closed,
the socket SO_LINGER option is set with a 0 timeout, which
forces the RST packet to be sent to the client upon closing the socket, thus freeing
all memory associated with it. This prevents the socket in the FIN_WAIT1 state, along with the buffers
associated with it from lying around.

Note that sockets with keepalive connections, after the defined timeout, are closed in the usual way.

== resolver ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/resolver.txt" />

Directive defines DNS server address, e.g.

<geshi lang="nginx">
resolver 127.0.0.1;
</geshi>

== resolver_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/resolver_timeout.txt" />

Directive defines timeout for name resolution, e.g.

<geshi lang="nginx">
resolver_timeout 5s;
</geshi>

== root ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/root.txt" />

'''root''' specifies the document root for the requests. For example, with this configuration

<geshi lang="nginx">
location /i/ {
root /spool/w3;
}
</geshi>
A request for "/i/top.gif" will return the file "/spool/w3/i/top.gif". You can use variables in the argument.

'''note:''' Keep in mind that the root will still append the directory to the request so that a request for "/i/top.gif" will not look in "/spool/w3/top.gif" like might happen in an Apache-like alias configuration where the location match itself is dropped. Use the <code>alias</code> directive to achieve the Apache-like functionality.

== satisfy ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/satisfy.txt" />

This determines the adopted access policy when directives from multiple access phase handlers, such as the [[HttpAccessModule|Access]] and [[HttpAuthBasicModule|Auth Basic]] modules, are defined in a context:
* all - All access phase handlers must grant access to the context
* any - Any access phase handler may grant access to the context

<geshi lang="nginx">
location / {
satisfy any;
allow 192.168.1.0/32;
deny all;
auth_basic "closed site";
auth_basic_user_file conf/htpasswd;
}
</geshi>

== satisfy_any ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/satisfy_any.txt" />

'''deprecated:''' 0.6.25 -- Use the [[#satisfy|satisfy]] directive instead

== send_lowat ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/send_lowat.txt" />

== send_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/send_timeout.txt" />

Specifies the response timeout to the client. This timeout does not apply to the ''entire'' transfer but, rather, only between two subsequent client-read operations. Thus, if the client has not read any data for this amount of time, then nginx shuts down the connection.

== sendfile ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/sendfile.txt" />

Directive activate or deactivate the usage of <code>sendfile()</code>.

sendfile() copies data between one file descriptor and another. Because this copying is done within the kernel, sendfile() is more efficient than the combination of read(2) and write(2), which would require transferring data to and from user space.

Read more at: https://www.kernel.org/doc/man-pages/online/pages/man2/sendfile.2.html

How does sendfile helps : http://www.techrepublic.com/article/use-sendfile-to-optimize-data-transfer/1044112

== sendfile_max_chunk ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/sendfile_max_chunk.txt" />

== server ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server.txt" />

Directive assigns configuration for the virtual server.

There is no separation of IP and name-based (the <code>Host</code> header of the request) servers.

Instead, the directive <code>listen</code> is used to describe all addresses and ports on which incoming connections can occur, and in directive <code>server_name</code> indicate all names of the server.

== server_name ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_name.txt" />

This directive performs two actions:

* Compares the <code>Host</code> header of the incoming HTTP request against the [[#server|server { ... }]] blocks in the Nginx configuration files and selects the first one that matches. This is how '''virtual servers''' are defined. Server names are processed in the following order:

# full, static names
# names with a wildcard at the start of the name — *.example.com
# names with a wildcard at the end of the name — www.example.*
# names with regular expressions
: If there is no match, a [[#server|server { ... }]] block in the configuration file will be used based on the following order:
# the server block with a matching <code>listen</code> directive marked as <code>[default|default_server]</code>
# the first server block with a matching <code>listen</code> directive (or implicit <code>listen 80;</code>)

* Sets the server name that will be used in HTTP redirects if [[#server_name_in_redirect|server_name_in_redirect]] is set.

Example:

<geshi lang="nginx">
server {
server_name example.com www.example.com;
}
</geshi>

The first name becomes the basic name of server. By default the name of the machine (hostname) is used.

It is possible to use "*" for replacing the first or the last part of the name:

<geshi lang="nginx">
server {
server_name example.com *.example.com www.example.*;
}
</geshi>

The first two of the above names (example.com and *.example.com) can be combined into one:

<geshi lang="nginx">
server {
server_name .example.com;
}
</geshi>

It is also possible to use regular expressions in server names, prepending the name with a tilde "~" like so:

<geshi lang="nginx">
server {
server_name www.example.com ~^www\d+\.example\.com$;
}
</geshi>

Since nginx 0.7.12, an empty server name is supported to catch the requests without "Host" header, please note that most browsers will always send a Host header, if accessed by IP the Host header will contain the IP. To specify a catch-all block please see the default_server flag of the listen directive.
<geshi lang="nginx">
server {
server_name "";
}
</geshi>

Since nginx 0.8.25 named captures can be used in server_name:
<geshi lang="nginx">
server {
server_name ~^(www\.)?(?<domain>.+)$;
root /sites/$domain;
}
</geshi>

Some older versions of PCRE may have issues with this syntax. If any problems arise try this following syntax:
<geshi lang="nginx">
server {
server_name ~^(www\.)?(?P<domain>.+)$;
root /sites/$domain;
}
</geshi>

Since nginx 0.9.4, [[#.24hostname|$hostname]] can be used as a server_name argument:
<geshi lang="nginx">
server {
server_name $hostname;
}
</geshi>

== server_name_in_redirect ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_name_in_redirect.txt" />

If <code>server_name_in_redirect</code> is on, then Nginx will use the first value
of the [[#server_name|server_name]] directive for redirects. If <code>server_name_in_redirect</code> is off,
then nginx will use the requested <code>Host</code> header.

Note: for Location headers coming from an upstream proxy (via proxy_pass for example) this may not be the only directive you need. In fact, it seems to be ignored a lot of the time. If you are seeing the upstream's server name come through and not be rewritten, you will need to use [[NginxHttpProxyModule#proxy_redirect|proxy_redirect]] to rewrite the upstream's provided hostname to what you want. Something like <code>proxy_redirect http://some.upstream.url/ /</code> - you will want to rewrite it to a / relative path.

== server_names_hash_max_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_names_hash_max_size.txt" />

The maximum size of the server name hash tables. For more detail see the description of tuning the hash tables in [[Optimizations|Nginx Optimizations]].

== server_names_hash_bucket_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_names_hash_bucket_size.txt" />

Directive assigns the size of basket in the hash-tables of the names of servers. This value by default depends on the size of the line of processor cache. For more detail see the description of tuning the hash tables in [[Optimizations|Nginx Optimizations]].

== server_tokens ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/server_tokens.txt" />

Whether to send the Nginx version number in error pages and <code>Server</code> header.

== tcp_nodelay ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/tcp_nodelay.txt" />

This directive allows or forbids the use of the socket option <code>TCP_NODELAY</code>. Only included in <code>keep-alive</code> connections.

You can read more about the <code>TCP_NODELAY</code> socket option [[ReadMoreAboutTcpNodelay|here]].

== tcp_nopush ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/tcp_nopush.txt" />

This directive permits or forbids the use of the socket options <code>TCP_NOPUSH</code> on FreeBSD or <code>TCP_CORK</code> on Linux. This option is only available when using <code>sendfile</code>.

Setting this option causes nginx to attempt to send it's HTTP response headers in one packet on Linux and FreeBSD 4.x

You can read more about the <code>TCP_NOPUSH</code> and <code>TCP_CORK</code> socket options [[ReadMoreAboutTcpNopush|here]].

== try_files ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/try_files.txt" />

Checks for the existence of files in order, and returns the first file that is found. A trailing slash indicates a directory - <code>$uri /</code>. In the event that no file is found, an internal redirect to the last parameter is invoked. The last parameter is the fallback URI and *must* exist, or else an internal error will be raised. Unlike rewrite, $args are not automatically preserved if the fallback is not a named location. If you need args preserved, you must do so explicitly:

<geshi lang="nginx">
try_files $uri $uri/ /index.php?q=$uri&$args;
</geshi>

Example use in proxying Mongrel:
<geshi lang="nginx">
try_files /system/maintenance.html $uri $uri/index.html $uri.html @mongrel;

location @mongrel {
proxy_pass http://mongrel;
}
</geshi>

Note that you can specify an HTTP '''status''' code as the last argument to <code>try_file</code> since Nginx version 0.7.51. Here's an example:
<geshi lang="nginx">
location / {
try_files $uri $uri/ /error.php?c=404 =404;
}
</geshi>
When all other attempts to serve the content corresponding to the request fail issue a <code>404 Not Found</code>.

Example of use with Drupal / FastCGI:
<geshi lang="nginx">
# for Drupal 6 or 7:
try_files $uri $uri/ /index.php?q=$uri&$args;

# a better version for Drupal 7 since it doesn't need q=$uri:
try_files $uri $uri/ /index.php?$args;

location ~ \.php$ {
fastcgi_pass 127.0.0.1:8888;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; # if not already defined in the fastcgi_params file
# any other specific fastcgi_params
}
</geshi>

In this example, the directive <code>try_files</code>
<geshi lang="nginx">
try_files $uri $uri/ /index.php?q=$uri&$args;
</geshi>

Is basically the same as this:
<geshi lang="nginx">
location / {
error_page 404 = @drupal;
log_not_found off;
}

location @drupal {
rewrite ^ /index.php?q=$uri last; # for drupal 6
}
</geshi>

Or this:
<geshi lang="nginx">
# DO NOT DO THIS! This is a terrible use of if.
if (!-e $request_filename) {
rewrite ^ /index.php?q=$uri last;
}
</geshi>

<code>try_files</code> is basically a replacement for the typical mod_rewrite style file/directory existence check. It is supposed to be more efficient than using <code>if</code> - see [[IfIsEvil]]

Examples of use with Wordpress and Joomla (typical "Front controller pattern" packages)
<geshi lang="nginx">
# wordpress (without WP Super Cache) - example 1
try_files $uri $uri/ /index.php?q=$uri&$args;

# wordpress (without WP Super Cache) - example 2
# It doesn't REALLY need the "q" parameter, but without an explicit $args php
# gets an empty QUERY_STRING, breaking generated responses that don't use a
# permalink, such as search results.
try_files $uri $uri/ /index.php?$args;

# joomla
try_files $uri $uri/ /index.php?q=$uri&$args;

location ~ \.php$ {
fastcgi_pass 127.0.0.1:8888;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; # if not already defined in the fastcgi_params file
# any other specific fastcgi_params
}
</geshi>

WP Super Cache requires a bunch of static file checks. Those are not shown here.

== types ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/types.txt" />

Specifies one or more mappings between MIME types and file extensions. More than one extension can be assigned to a MIME type.

For example:

<geshi lang="nginx">
types {
text/html html;
image/gif gif;
image/jpeg jpg;
}
</geshi>

A sufficiently complete table of mappings is included with nginx, and is located at <code>conf/mime.types</code>.

If you wanted responses to particular location to always indicate a single MIME type, you could define an empty ''types'' block and set the ''default_type'' directive. For example:

<geshi lang="nginx">
location /download/ {
types { }
default_type application/octet-stream;
}
</geshi>

== types_hash_bucket_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/types_hash_bucket_size.txt" />

== types_hash_max_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/types_hash_max_size.txt" />

== underscores_in_headers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/underscores_in_headers.txt" />

Allows or disallows underscores in headers.

== variables_hash_bucket_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/variables_hash_bucket_size.txt" />

Assigns the key bucket size for the variables hash table.

== variables_hash_max_size ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_core_module/variables_hash_max_size.txt" />

The maximum size of the variables hash table. For more detail see the description of tuning the hash tables in [[Optimizations|Nginx Optimizations]].

= Variables =
The core module supports built-in variables, whose names correspond with the names of variables in Apache.

First of all, there are variables which represent header lines in the client request, for example, <code>$http_user_agent</code>, <code>$http_cookie</code>, and so forth. Note that because these correspond to what the client actually sends, they are not guaranteed to exist and their meaning is defined elsewhere (e.g. in relevant standards).

Furthermore, there are other variables:

== $arg_PARAMETER ==
This variable contains the value of the <code>GET</code> request variable ''PARAMETER'' if present in the query string

== $args ==
This variable is the <code>GET</code> parameters in request line, e.g. <code>foo=123&bar=blahblah</code>; This variable could be changed.

== $binary_remote_addr ==
The address of the client in binary form;

== $body_bytes_sent ==
The amount of bytes sent as part of the body of the response. Is accurate even when connections are aborted or interrupted.

== $content_length ==
This variable is equal to line <code>Content-Length</code> in the header of request;

== $content_type ==
This variable is equal to line <code>Content-Type</code> in the header of request;

== $cookie_COOKIE ==
The value of the cookie ''COOKIE'';

== $document_root==
This variable is equal to the value of directive [[#root|root]] for the current request;

== $document_uri ==
The same as [[#$uri|$uri]].

== $host==
This variable is equal to line <code>Host</code> in the header of request or name of the server processing the request if the <code>Host</code> header is not available.

This variable may have a different value from <code>$http_host</code> in such cases: 1) when the <code>Host</code> input header is absent or has an empty value, <code>$host</code> equals to the value of <code>server_name</code> directive; 2)when the value of <code>Host</code> contains port number, <code>$host</code> doesn't include that port number. <code>$host</code>'s value is always lowercase since 0.8.17.

== $hostname ==
Set to the machine's hostname as returned by [http://linux.die.net/man/2/gethostname gethostname]

== $http_HEADER ==
The value of the HTTP request header ''HEADER'' when converted to lowercase and with 'dashes' converted to 'underscores', e.g. <code>$http_user_agent</code>, <code>$http_referer</code>...;

== $sent_http_HEADER ==
The value of the HTTP response header ''HEADER'' when converted to lowercase and with 'dashes' converted to 'underscores', e.g. <code>$sent_http_cache_control</code>, <code>$sent_http_content_type</code>...;

== $is_args ==
Evaluates to "?" if [[#$args|$args]] is set, "" otherwise.

== $limit_rate ==
This variable allows limiting the connection rate.

== $nginx_version ==
The version of Nginx that the server is currently running;

== $query_string ==
The same as [[#$args|$args]] except that this variable is readonly.

== $remote_addr ==
The address of the client.

== $remote_port ==
The port of the client;

== $remote_user ==
This variable is equal to the name of user, authenticated by the [[HttpAuthBasicModule|Auth Basic Module]];

== $request_filename ==
This variable is equal to path to the file for the current request, formed from directives root or alias and URI request;

== $request_body ==
This variable(0.7.58+) contains the body of the request. The significance of this variable appears in locations with directives [[HttpProxyModule#proxy_pass|proxy_pass]] or [[HttpFcgiModule#fastcgi_pass|fastcgi_pass]].

== $request_body_file ==
Client request body temporary filename;

== $request_completion ==
Set to "OK" if request was completed successfully. Empty if request was not completed or if request was not the last part of a series of range requests.

== $request_method ==
This variable is equal to the method of request, usually <code>GET</code> or <code>POST</code>.

This variable always evaluates to the method name of the ''main request'', not the current request, when the current request is a subrequest.

== $request_uri ==
This variable is equal to the *original* request URI as received from the client including the args. It cannot be modified. Look at $uri for the post-rewrite/altered URI.
Does not include host name. Example: "/foo/bar.php?arg=baz"

== $scheme ==
The HTTP scheme (i.e. http, https). Evaluated only on demand, for example:
<geshi lang="nginx">
rewrite ^ $scheme://example.com$uri redirect;
</geshi>

== $server_addr ==
The server address. Generally nginx makes a system call to obtain this value. To improve efficiency and avoid this system call, specify an address with the [[#listen|listen]] directive and to use the <code>bind</code> parameter.

== $server_name ==
The name of the server.

== $server_port ==
This variable is equal to the port of the server, to which the request arrived;

== $server_protocol ==
This variable is the protocol of the request. Common examples are: <code>HTTP/1.0</code> or <code>HTTP/1.1</code>

== $uri ==
This variable is the current request URI, without any arguments (see $args for those). This variable will reflect any modifications done so far by internal redirects or the [[HttpIndexModule#index|index]] module. Note this may be different from $request_uri, as $request_uri is what was originally sent by the browser before any such modifications. Does not include the protocol or host name. Example: <code>/foo/bar.html</code>

= References =
[http://nginx.org/en/docs/http/ngx_http_core_module.html Original Documentation]

HttpXsltModule

2012-05-02T19:49:50Z

Admin: /* Directives */

= Synopsis =

This module is a filter which converts an XML response with the aid of one or more XSLT templates.

This module was introduced in 0.7.8 and needs to be enabled via
<pre>./configure --with-http_xslt_module</pre>

Example:
<geshi lang="nginx">
location / {
xml_entities /site/dtd/entities.dtd;
xslt_stylesheet /site/xslt/one.xslt param=value;
xslt_stylesheet /site/xslt/two.xslt;
}
</geshi>

= Directives =
== xml_entities ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_xslt_module/xml_entities.txt" />

Specifies the DTD file which describes symbolic elements (xml entities). This file is compiled at the stage of configuration. For technical reasons it's not possible to specify entities in the XML being processed, therefore they are ignored, but this specially assigned file is used instead. In this file it is not necessary to describe structure of processed XML, it is sufficient only to declare necessary symbolic elements, for example:

<pre>
<! ENTITY of nbsp “  “>
</pre>

== xslt_param ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_xslt_module/xslt_param.txt" />

== xslt_string_param ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_xslt_module/xslt_string_param.txt" />

== xslt_stylesheet ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_xslt_module/xslt_stylesheet.txt" />

Specifies the XSLT template with its parameters. Template is compiled at the stage of configuration. The parameters are assigned as shown:

<pre>
param=value
</pre>

You can specify parameters either one per line, or separate multiple parameters with colon (“: ”) If the parameter itself contains the character “:”, escape it as “%3A”. Furthermore, libxslt requires that string parameters should be quoted by the single or dual quotation marks if they contain non-alphanumeric characters, for example:

<pre>
param1='http%3A//www.example.com': param2=value2
</pre>

It's possible to use variables as parameters, for example, the entire line of the parameters can be substituted with one variable:

<geshi lang="nginx">
location / {
xslt_stylesheet /site/xslt/one.xslt
$arg_xslt_params
param1='$value1': param2=value2
param3=value3;
}
</geshi>

It is possible to specify several templates, in which case they would be chained together in the order of their declaration.

== xslt_types ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_xslt_module/xslt_types.txt" />

Permit processing responses with specified MIME-types in addition to “text/xml”. If XSLT output mode is HTML, then the response MIME-type changes to “text/HTML”.

= References =
[http://nginx.org/en/docs/http/ngx_http_xslt_module.html Original Documentation]

HttpDavModule

2012-05-02T19:49:07Z

Admin: /* Directives */

= Synopsis =

This module adds the HTTP and WebDAV methods PUT, DELETE, MKCOL, COPY and MOVE.

This module does not provide full WebDAV support (it is missing PROPFIND and OPTIONS methods). If you need full WebDAV support in Nginx, please see [https://github.com/arut/nginx-dav-ext-module ngx-dav-ext-module] on github.

This module is not compiled by default. It is necessary to enable it at compile-time via
<pre>./configure --with-http_dav_module</pre>

Example:
<geshi lang="nginx">
location / {
root /data/www;
client_body_temp_path /data/client_temp;

dav_methods PUT DELETE MKCOL COPY MOVE;

create_full_put_path on;
dav_access group:rw all:r;

limit_except GET {
allow 192.168.1.0/32;
deny all;
}
}
</geshi>

= Directives =
== dav_access ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_dav_module/dav_access.txt" />

This directive assigns access rights for file and directories, for example:
<geshi lang="nginx">
dav_access user:rw group:rw all:r;
</geshi>

If assigning any permissions for <code>groups</code> or <code>all</code>, then it's not necessary to indicate permissions for <code>user</code>:
<geshi lang="nginx">
dav_access group:rw all:r;
</geshi>

== dav_methods ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_dav_module/dav_methods.txt" />

This directive enables specified HTTP and WebDAV methods. Setting it to <code>off</code> disables all methods, ignoring the remaining parameters.

For the PUT method the destination file must reside on the same partition as the directory where the temporary file is stored (given by directive <code>client_body_temp_path</code> in the <code>location</code> section).

When a file is created using the PUT method it is possible to assign the modification date by setting the <code>Date</code> header.

== create_full_put_path ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_dav_module/create_full_put_path.txt" />

By default, the PUT method can only create files within existing directories.
This directive permits creating all necessary intermediate directories.

== min_delete_depth ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_dav_module/min_delete_depth.txt" />

= References =
[http://nginx.org/en/docs/http/ngx_http_dav_module.html Original Documentation]

HttpSubModule

2012-05-02T19:48:33Z

Admin: /* Directives */

= Synopsis =

This module can search and replace text in the nginx response. It is only available if the
<pre>--with-http_sub_module option</pre>
was specified for ./configure.

Example:
<pre>
location / {
sub_filter </head>
'</head><script language="javascript" src="$script"></script>';
sub_filter_once on;
}
</pre>

= Directives =
== sub_filter ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_sub_module/sub_filter.txt" />

''sub_filter'' allows replacing some text in the nginx response with some other text, independently of the source of the data. The matching is case-insensitive. Substitution text may contain variables. Only one substitution rule per location is supported.

== sub_filter_once ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_sub_module/sub_filter_once.txt" />

''sub_filter_once off'' allows to search and replace all matching lines, the default is replacing only the first one.

== sub_filter_types ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_sub_module/sub_filter_types.txt" />

''sub_filter_types'' is used to specify which content types should be checked for ''sub_filter''. The default is only ''text/html''.

= References =
[http://nginx.org/en/docs/http/ngx_http_sub_module.html Original Documentation]

HttpSslModule

2012-05-02T19:47:51Z

Admin: /* Directives */

= Synopsis =
This module enables HTTPS support.

It supports checking client certificates with two limitations:

* it's not possible to assign a Certificate Revocation List for Nginx versions below 0.8.7.
* if you have a chain of certificates — by having intermediate certificates between the server certificate and the CA root certificate — they're not specified separately like you would do for Apache. Instead you'll need to concatenate all the certificates, starting with the server certificate, and going deeper in the chain running through all the intermediate certificates. This can be done with "cat chain.crt >> mysite.com.crt" on the command line. Once this is done there's no further use for all the intermediate certificates in what Nginx is concerned. You'll indicate in the Nginx configuration the file with '''all''' the (concatenated) certificates.

By default the module is not built, it is necessary to state it explicitly: give the ''--with-http_ssl_module'' parameter to ./configure. Building this module requires the OpenSSL library and respective include files; quite often the library and include files live in separate packages in your platform, the later being named like libssl-dev or similar.

The following is an example configuration, to reduce the CPU load it is recommended to run one worker process only and to enable keep-alive connections:

<geshi lang="nginx">
worker_processes 1;
http {
server {
listen 443;
ssl on;
ssl_certificate /usr/local/nginx/conf/cert.pem;
ssl_certificate_key /usr/local/nginx/conf/cert.key;
keepalive_timeout 70;
}
}
</geshi>

When using a chain of certificates, just append the extra certificates to your .crt file (cert.pem in the example). The server certificate needs to be the first on the file, otherwise you'll get a mismatch between private and public keys.

Since Nginx version 0.7.14 the preferred way of enabling SSL is by using the `ssl` parameter of the `listen` directive:
<geshi lang="nginx">
server {
listen 443 default_server ssl;
ssl_certificate /usr/local/nginx/conf/cert.pem;
ssl_certificate_key /usr/local/nginx/conf/cert.key;
...
}
</geshi>

== Generate Certificates ==

To generate private (dummy) certificates you can perform the following list of openssl commands.

First change directory to where you want to create the certificate and private key, for example:
<pre>
$ cd /usr/local/nginx/conf
</pre>
Now create the server private key, you'll be asked for a passphrase:
<pre>
$ openssl genrsa -des3 -out server.key 1024
</pre>
Create the Certificate Signing Request (CSR):
<pre>
$ openssl req -new -key server.key -out server.csr
</pre>
Remove the necessity of entering a passphrase for starting up nginx with SSL using the above private key:
<pre>
$ cp server.key server.key.org
$ openssl rsa -in server.key.org -out server.key
</pre>
Finally sign the certificate using the above private key and CSR:
<pre>
$ openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt
</pre>

Update Nginx configuration by including the newly signed certificate and private key:

<geshi lang="nginx">
server {
server_name YOUR_DOMAINNAME_HERE;
listen 443;
ssl on;
ssl_certificate /usr/local/nginx/conf/server.crt;
ssl_certificate_key /usr/local/nginx/conf/server.key;
}
</geshi>

Restart Nginx.

Now we're ready to access the above host using:

<pre>https://YOUR_DOMAINNAME_HERE</pre>

== Using Wildcard certificates with multiple servers ==

In some instances you may wish to provide a number of secure subdomains amongst unsecured ones, and possibly share resources across both HTTP and HTTPS subdomains. To do this one would require a wildcard subdomain, for example ''*.nginx.org''. An example configuration follows which shows how to configure a standard ''www'' subdomain, a secured subdomain, and share images across both subdomains using a third.

When using a configuration like this it's more efficient memory wise to place the certificate file containing the certificate(s) for all domain names and the corresponding private key file directives in a http context, such that it's inherited by all active servers/virtual hosts:
<geshi lang="nginx">
ssl_certificate common.crt;
ssl_certificate_key common.key;

server {
listen 80;
server_name www.nginx.org;
...
}

server {
listen 443 default_server ssl;
server_name secure.nginx.org;
...
}

server {
listen 80;
listen 443;
server_name images.nginx.org;
...
}
</geshi>

= Directives =
== ssl ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl.txt" />

Enables HTTPS for a server. (Note that since nginx version 0.7.14, the standard way to enable SSL is through the '''[[HttpCoreModule#listen|listen]]''' directive.)

== ssl_certificate ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_certificate.txt" />

This directive specifies the file containing the certificate, in PEM format, for this virtual host. This file can contain also other certificates and the server private key. Since version 0.6.7 the file path is relative to the directory where nginx main configuration file, nginx.conf, resides.

== ssl_certificate_key ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_certificate_key.txt" />

This directive specifies the file containing the private key, in PEM format, for this virtual host. Since version 0.6.7 the file path is relative to the directory where nginx main configuration file, nginx.conf, resides.

== ssl_ciphers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_ciphers.txt" />

This directive describes the list of cipher suites the server supports for establishing a secure connection. Cipher suites are specified in the [http://openssl.org/docs/apps/ciphers.html OpenSSL] cipherlist format, for example:

<geshi lang="nginx">
ssl_ciphers ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
</geshi>

Since nginx version 1.0.5, the default ciphers are:
<geshi lang="nginx">
ssl_ciphers HIGH:!aNULL:!MD5;
</geshi>

The complete cipherlist supported by the currently installed version of OpenSSL in your platform can be obtained by issuing the command:
<pre>
openssl ciphers
</pre>

== ssl_client_certificate ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_client_certificate.txt" />

This directive specifies the file containing the CA (root) certificate, in PEM format, that is used for validating client certificates.

== ssl_crl ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_crl.txt" />

This directive, introduced in Nginx version 0.8.7, specifies the filename of a Certificate Revocation List, in PEM format, which is used to check the revocation status of certificates.

== ssl_dhparam ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_dhparam.txt" />

This directive specifies a file containing Diffie-Hellman key agreement protocol cryptographic parameters, in PEM format, utilized for exchanging session keys between server and client.

== ssl_prefer_server_ciphers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_prefer_server_ciphers.txt" />

The server requires that the cipher suite list for protocols SSLv3 and TLSv1 are to be preferred over the client supported cipher suite list.

== ssl_protocols ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_protocols.txt" />

This directive enables the protocol versions specified.

== ssl_verify_client ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_verify_client.txt" />

This directive enables the verification of the client identity. Parameter 'optional' checks the client identity using its certificate in case it was made available to the server. (Was 'ask' before 0.8.7 and 0.7.63)

== ssl_verify_depth ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_verify_depth.txt" />

This directive sets how deep the server should go in the client provided certificate chain in order to verify the client identity.

== ssl_session_cache ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_session_cache.txt" />

The directive sets the types and sizes of caches to store the SSL sessions.<BR>The cache types are:

* off -- Hard off: nginx says explicitly to a client that sessions can not reused.
* none -- Soft off: nginx says to a client that session can be resued, but nginx actually never reuses them. This is workaround for some mail clients as ssl_session_cache may be used in mail proxy as well as in HTTP server.
* builtin -- the OpenSSL builtin cache, is used inside one worker process only. The cache size is assigned in the number of the sessions. Note: there appears to be a memory fragmentation issue using this method, please take that into consideration when using this. See "References" below.
* shared -- the cache is shared between all worker processes. The size of the cache is assigned in bytes: 1 MB cache can contain roughly 4000 sessions. Each shared cache must be given an arbitrary name. A shared cache with a given name can be used in several virtual hosts.
It's possible to use both types of cache — builtin and shared — simultaneously, for example:

<pre>
ssl_session_cache builtin:1000 shared:SSL:10m;
</pre>
Bear in mind however, that using only shared cache, i.e., without builtin, should be more effective.

For Nginx versions below 0.8.34 this directive shouldn't be set to 'none' or 'off' if ssl_verify_client is set to 'on' or 'optional'.

* Note that for session resumption to work you'll need to have, at least, the server configured as '''default''' for the SSL socket. Like this:
<geshi lang="nginx">
listen [::]:443 ssl default_server;
</geshi>
This is so because session resumption happens before any TLS extensions are enabled, namely Server Name Identification (SNI). The ClientHello message requests a session ID from a given IP address (server). For that to work the default server setting is '''required'''.

A '''preferred''' approach is to move the <code>ssl_session_cache</code> directive to the <code>http</code> context. The (minor) downside is that all configured virtual hosts get the '''same''' SSL cache settings.

== ssl_session_timeout ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssl_module/ssl_session_timeout.txt" />

This directive defines the maximum time during which the client can re-use the previously negotiated cryptographic parameters of the secure session that is stored in the SSL cache.

== ssl_engine ==
'''syntax:''' ''ssl_engine''

This allows specifying the OpenSSL engine to use, like PadLock, for example. It requires a recent version of OpenSSL. To verify if the OpenSSL version installed in your platform supports this, issue the command:
<pre>
openssl engine
</pre>
On a Debian testing with OpenSSL version 0.9.8o from 01 Jun 2010 it returns:
<pre>
$ openssl engine
(padlock) VIA PadLock (no-RNG, no-ACE)
(dynamic) Dynamic engine loading support
</pre>

= Built-in variables =

Module ngx_http_ssl_module supports the following built-in variables:

* $ssl_cipher returns the cipher suite being used for the currently established SSL/TLS connection
* $ssl_client_serial returns the serial number of the client certificate for the currently established SSL/TLS connection — if applicable, i.e., if client authentication is activated in the connection
* $ssl_client_s_dn returns the subject Distinguished Name (DN) of the client certificate for the currently established SSL/TLS connection — if applicable, i.e., if client authentication is activated in the connection
* $ssl_client_i_dn returns the issuer DN of the client certificate for the currently established SSL/TLS connection — if applicable, i.e., if client authentication is activated in the connection
* $ssl_protocol returns the protocol of the currently established SSL/TLS connection — depending on the configuration and client available options it's one of SSLv2, SSLv3 or TLSv1
* $ssl_session_id the Session ID of the established secure connection — requires Nginx version greater or equal to 0.8.20
* $ssl_client_cert
* $ssl_client_raw_cert
* $ssl_client_verify takes the value "SUCCESS" when the client certificate is successfully verified

= Nonstandard error codes =

This module supports several nonstandard error codes which can be used for debugging with the aid of directive error_page:

* 495 - error checking client certificate
* 496 - client did not grant the required certificate
* 497 - normal request was sent to HTTPS
Debugging is done after the request is completely "disassembled" and it's components are accessible via variables such as $request_uri, $uri, $arg and more.

= References =
* [http://nginx.org/en/docs/http/ngx_http_ssl_module.html Original Documentation]
* [http://kbeezie.com/view/free-ssl-with-nginx/ Implementing an actual SSL Certificate]
* [http://marc.info/?t=120127289900027 SSL Memory Fragmentation and new default status for ssl_session_cache]

HttpSecureLinkModule

2012-05-02T19:46:48Z

Admin: /* secure_link_secret */

= Synopsis =

This module checks request URLs for a required security token.
This module is not compiled by default and must be specified using the

<pre>
--with-http_secure_link_module
</pre>

argument to configure when compiling nginx. Note that this module is only supported in nginx version 0.7.18 and higher.

== Example usage: ==
Imagine having a pdf file you want to ensure isn't linked from else where, to do this we need to add a unique token and an expiration date, we use the following PHP code to generate a token and an expire time
To construct the above hash, in PHP you can issue the following:
<geshi lang="php">
$secret = 'segredo'; // To make the hash more difficult to reproduce.
$path = '/p/files/top_secret.pdf'; // This is the file to send to the user.
$expire = 1096891200; // At which point in time the file should expire. time() + x; would be the usual usage.

$md5 = base64_encode(md5($secret . $path . $expire, true)); // Using binary hashing.
$md5 = strtr($md5, '+/', '-_'); // + and / are considered special characters in URLs, see the wikipedia page linked in references.
$md5 = str_replace('=', '', $md5); // When used in query parameters the base64 padding character is considered special.
</geshi>

The expire time can obtained by using the [http://pt2.php.net/manual/en/function.time.php time()] function in PHP — or similar in other programming language — in order to obtain the [https://secure.wikimedia.org/wikipedia/en/wiki/Unix_epoch Unix epoch].

Now that we have a hash that cannot easily be reproduced and an expire time we link the file in the following way:

<pre>
http://example.com/p/files/top_secret.pdf?st=PIrEk4JX5gJPTGmvqJG41g&e=1324527723
</pre>

To have Nginx protect this URL we need to tell it how to reproduce the MD5 hash. We do this in the following way:

<geshi lang="nginx">
location /p/ {
## This must match the URI part related to the MD5 hash and expiration time.
secure_link $arg_st,$arg_e;

## The MD5 hash is built from our secret token, the URI($path in PHP) and our expiration time.
secure_link_md5 segredo$uri$arg_e;

## If the hash is incorrect then $secure_link is a null string.
if ($secure_link = "") {
return 403;
}

## The current local time is greater than the specified expiration time.
if ($secure_link = "0") {
return 403;
}

## If everything is ok $secure_link is 1.
}
</geshi>

=  Directives =
== secure_link ==

{{Directive|name=secure_link|args=md5_hash[,expiration_time]|default=none|context=location|vars=yes}}

This directive specifies the MD5 hash value and the expiration time of this link URI. The md5_hash '''must''' be encoded using [http://en.wikipedia.org/wiki/Base64#URL_applications Base64 for URLs]. expiration_time is the [https://secure.wikimedia.org/wikipedia/en/wiki/Unix_epoch Unix epoch].

If no expiration_time is specified then the link '''never''' expires.

== secure_link_md5 ==

{{Directive|name=secure_link_md5|args=secret_token_concatenated_with_protected_uri|default=none|context=location|vars=yes}}

This directive specifies the string you want to be hashed by MD5. The string can be obtained using variables like in the example above. This hash value is compared with the md5_hash given in the '''secure_link''' directive. If they match then $secure_link is set to '''1''', otherwise it's the null string.

== secure_link_secret ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_secure_link_module/secure_link_secret.txt" />

This directive has been deprecated as of nginx 0.8.50 in favor of [[#secure_link_md5|secure_link_md5]].

= variables =

== $secure_link ==

This variable behaves differently depending on whether [[HttpSecureLinkModule#secure_link_secret|secure_link_secret]] is used or not:
* If using '''secure_link_secret''', when the requested URI matches the computed MD5 hash, $secure_link is set to the protected URI. Otherwise it's a null string.

* If using '''secure_link''' and '''secure_link_md5''', when the requested URI matches the computed MD5 hash, then $secure_link is set to '''1'''. If the current local time exceeds the $expiration_time then $secure_link is set to '''0'''. Otherwise it's set to a null string.

== $secure_link_expires ==

Is set to the $expiration_time when specified.

= References =
* [http://nginx.org/en/docs/http/ngx_http_secure_link_module.html Original Documentation]
* [http://en.wikipedia.org/wiki/Base64#URL_applications Base64 for URLs]

HttpRealipModule

2012-05-02T19:46:22Z

Admin: /* Directives */

= Synopsis =
This module allows to change the client's IP address to value from request header (e. g. <code>X-Real-IP</code> or <code>X-Forwarded-For</code>).

It is useful if nginx works behind some proxy of L7 load balancer, and the request comes from a local IP, but proxy add request header with client's IP.

This module isn't built by default, enable it with the configure option
<pre>--with-http_realip_module</pre>

Example:
<geshi lang="nginx">
set_real_ip_from 192.168.1.0/24;
set_real_ip_from 192.168.2.1;
real_ip_header X-Real-IP;
</geshi>

= Directives =
== set_real_ip_from ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/set_real_ip_from.txt" />

This directive describes the trusted addresses, which transfer accurate address for the replacement. Since 0.8.22 Unix sockets can also be trusted.

== real_ip_header ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_realip_module/real_ip_header.txt" />

This directive sets the name of the header used for transferring the replacement IP address.

In case of X-Forwarded-For, this module uses the last ip in the X-Forwarded-For header for replacement.

= References =
[http://nginx.org/en/docs/http/ngx_http_realip_module.html Original Documentation]

[http://trac.nginx.org/nginx/ticket/2 trac ticket #2]

HttpRandomIndexModule

2012-05-02T19:45:57Z

Admin: /* random_index */

= Synopsis =
Pick a random file from a directory and use it as the index file.

Example:
<geshi lang="nginx">
location / {
random_index on;
}
</geshi>

= Directives =
== random_index ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_random_index_module/random_index.txt" />

When enabled will scan the directory for files on each request, and chose a randomly picked file instead of the usual index.html to use as the index file. Only plain-text files not starting with a dot will be considered.

= References =
[http://nginx.org/en/docs/http/ngx_http_random_index_module.html Original Documentation]

HttpMp4Module

2012-05-02T19:45:37Z

Admin: /*  Directives */

= Synopsis =

This module enables mp4 streaming with seeking ability.
This module is not compiled by default and must be specified using

<pre>
--with-http_mp4_module
</pre>

as an argument to configure when compiling Nginx. Note that this module is only supported in nginx version 1.1.3 and higher in development branch and 1.0.7 in stable branch.

== Example usage: ==
<geshi lang="nginx">
location /video/ {
mp4;
mp4_buffer_size 1m;
mp4_max_buffer_size 5m;
}
</geshi>

=  Directives =

== mp4 ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_mp4_module/mp4.txt" />

Enables the mp4 streaming feature.

<geshi lang="nginx">
location /video {
mp4 on;
}
</geshi>

== mp4_buffer_size==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_mp4_module/mp4_buffer_size.txt" />

Sets the buffer size used for processing mp4 file.

== mp4_max_buffer_size==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_mp4_module/mp4_max_buffer_size.txt" />

Sets the maxium buffer size used for processing mp4 file. If the meta data exceeds this size Nginx will return a 500 status code and log an error resembling the following:
<pre>
"/video/file.mp4" mp4 moov atom is too large:
12583268, you may want to increase mp4_max_buffer_size
</pre>

= References =
Please see the following page for more details: http://nginx.org/en/docs/http/ngx_http_mp4_module.html

HttpImageFilterModule

2012-05-02T19:45:07Z

Admin: /* Directives */

= Synopsis =

'''Version:''' 0.7.54+

This module is a filter for transforming JPEG, GIF and PNG images. It is not enabled by default to enable it, provide this option to ./configure when building nginx:
<pre>
--with-http_image_filter_module
</pre>

libgd is required to build and run the module. We recommend using the latest version of libgd.

= Example Configuration =
<geshi lang="nginx">
location /img/ {
proxy_pass http://backend;
image_filter resize 150 100;
error_page 415 = /empty;
}

location = /empty {
empty_gif;
}
</geshi>

= Directives =

== image_filter ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_image_filter_module/image_filter.txt" />

Specifies the type of transformation to apply to the image, one of the below:

* test: checking that the response is indeed an image format JPEG, GIF or PNG. Otherwise, an error 415.

* size: Gives information about the image in JSON format. For example,
<pre>{ "img" : { "width": 100, "height": 100, "type": "gif" } }</pre>
Or if an error occurs,
<pre>{}</pre>

* resize: proportionally reduces the image to a specified size.

* crop: proportionally reduces the image to a specified size and trims extra edge.

== image_filter_buffer ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_image_filter_module/image_filter_buffer.txt" />

Sets the maximum size for reading the image.

== image_filter_jpeg_quality ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_image_filter_module/image_filter_jpeg_quality.txt" />

Sets the rate of loss of information when processing the images as '''JPEG'''. The maximum recommended value is '''95'''.

== image_filter_sharpen ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_image_filter_module/image_filter_sharpen.txt" />

== image_filter_transparency ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_image_filter_module/image_filter_transparency.txt" />

This directive allows you to disable image transparency in GIF and
palette-based PNG to improve image resampling quality.

True color PNG alpha-channels are always preserved despite this setting.

Note: Grayscale PNG's are untested, but should be handled
as truecolor PNGs.

= References =
[http://nginx.org/en/docs/http/ngx_http_image_filter_module.html Original Documentation]

HttpGzipStaticModule

2012-05-02T19:44:23Z

Admin: /* gzip_static */

= Synopsis =
Before serving a file from disk to a gzip-enabled client, this module will look for a precompressed file in the same location that ends in ".gz". The purpose is to avoid compressing the same file each time it is requested.

ngx_http_gzip_static_module was introduced in nginx 0.6.24. You must enable support at compile time:

<pre>
./configure --with-http_gzip_static_module
</pre>

Example
<geshi lang="nginx">
gzip_static on;

gzip_http_version 1.1;
gzip_proxied expired no-cache no-store private auth;
gzip_disable "MSIE [1-6]\.";
gzip_vary on;
</geshi>

= Directives =
== gzip_static ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_gzip_static_module/gzip_static.txt" />

Enables the module. You should ensure that the timestamps of the compressed and uncompressed files match.

== gzip_http_version ==
See [[NginxHttpGzipModule#gzip_http_version| NginxHttpGzipModule]]

== gzip_proxied ==
See [[NginxHttpGzipModule#gzip_proxied| NginxHttpGzipModule]]

== gzip_disable ==
See [[NginxHttpGzipModule#gzip_disable| NginxHttpGzipModule]]

== gzip_vary ==
See [[NginxHttpGzipModule#gzip_vary| NginxHttpGzipModule]]

= References =
* [http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html Original Documentation]
* [[NginxHttpGzipModule|See also: Gzip Compression Module]]

HttpGeoipModule

2012-05-02T19:43:59Z

Admin: /* Directives */

= Synopsis =
This module creates ngx_http_geoip_module variables based on the IP-address of the client matched against the [http://www.maxmind.com/ MaxMind] GeoIP binary files. This module appeared in nginx version 0.7.63 and 0.8.6.

Precondition

This module needs the geo databases and the library to read from the database.

There are several options:

* Download the database yourself, e.g.:
<pre>
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
</pre>

* Install a package providing the database. For example in Debian the package is called '''geoip-database'''.
<pre>
aptitude install geoip-database
</pre>

* Install a port providing the database. For example in FreeBSD the port is called "GeoIP".
<pre>
cd /usr/ports/net/GeoIP
make install clean
</pre>

The FreeBSD port provides the GeoLite country database located at /usr/local/share/GeoIP/GeoIP.dat

Note that this is only the country database. You'll need to download the '''city''' database from Maxmind site:
<pre>
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
</pre>
To compile Nginx you'll need the library development files. In Debian they're in the package '''libgeoip-dev'''.
<pre>
aptitude install libgeoip-dev
</pre>
For systems where there's not a packaged version of the library you'll have to compile it from source:
<pre>
wget http://geolite.maxmind.com/download/geoip/api/c/GeoIP.tar.gz
</pre>
Follow the install instructions provided there.

Compile Nginx enabling Geo IP support:
<pre>
./configure --with-http_geoip_module
</pre>

You can check if your installed version of Nginx supports Geo IP with <code>nginx -V</code>. Watch for the <code> --with-http_geoip_module</code>. This means that Geo IP support is enabled.

Here'a a configuration example:
<geshi lang="nginx">
http {
geoip_country GeoIP.dat; # the country IP database
geoip_city GeoLiteCity.dat; # the city IP database
(...)
</geshi>

You can mimic Apache's mod_geoip functionality with PHP-FPM by adding the following fastcgi_param values:

(From [http://kbeezie.com/view/apache-mod_geoip-nginx/ Mimic Apache mod_geoip in Nginx])
<geshi lang="nginx">
fastcgi_param GEOIP_COUNTRY_CODE $geoip_country_code;
fastcgi_param GEOIP_COUNTRY_NAME $geoip_country_name;
</geshi>

= Directives =
== geoip_country ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_country.txt" />

This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country geolocation information. This allows you to get the country corresponding to the given IP. It can be used to determine the visitor's country from the IP address of the client. When set the following variables are available:

* $geoip_country_code — two-letter country code, for example, "RU", "US".
* $geoip_country_code3 — three-letter country code, for example, "RUS", "USA".
* $geoip_country_name — the (verbose) name of the country, for example, "Russian Federation", "United States", &c.

Nginx caches all supplied databases in memory. The country database is small, roughly 1.4M, therefore there's very little penalty in caching it. The city database is much bigger. Hence its memory footprint is larger.

== geoip_city ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_geoip_module/geoip_city.txt" />

This directive specifies the full path to the Geo IP database .dat file that associates IP addresses with country, city and region geolocation information. This allows you to get that information corresponding to the given IP. It can be used to determine the visitor's geolocation from the IP address of the client. When set the following variables are available:

* '''$geoip_city_country_code''' — two-letter country code, for example, "RU", "US".
* '''$geoip_city_country_code3''' — three-letter country code, for example, "RUS", "USA".
* '''$geoip_city_country_name''' — the name of the country, for example, "Russian Federation", "United States" — if available.
* '''$geoip_region''' — the name of region (province, region, state, province, federal land, and the like), for example, "Moscow City", "DC" — if available.
* '''$geoip_city''' — the name of the city, for example, "Moscow", "Washington", "Lisbon", &c — if available.
* '''$geoip_postal_code''' — zip code or postal code — if available.
* '''$geoip_city_continent_code''' — if available.
* '''$geoip_latitude''' — latitude — if available.
* '''$geoip_longitude''' — longitude — if available.
* '''$geoip_dma_code''' — DMA Code — if available.
* '''$geoip_area_code''' — Area Code — if available.

= References =
[http://nginx.org/en/docs/http/ngx_http_geoip_module.html Original Documentation]

HttpFlvModule

2012-05-02T19:43:21Z

Admin: /* flv */

= Synopsis =

This module provides the ability to seek within FLV (Flash) files using byte-based offsets.

Module ngx_http_flv_module offers special handling of files it handles:

* adds <code>FLV</code> header to the requested file;
* transfers file, beginning from the displacement, specified in the request argument <code>start=XXX</code>.

This module is not compiled by default and must be specified using the <code>--with-http_flv_module</code> argument to <code>configure</code> when compiling Nginx.

Example:
<geshi lang="nginx">
location ~ \.flv$ {
flv;
}
</geshi>

= Directives =
== flv ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_flv_module/flv.txt" />

Enables special handling of files for this location.

= References =
[http://nginx.org/en/docs/http/ngx_http_flv_module.html Original documentation]

HttpPerlModule

2012-05-02T19:43:03Z

Admin: /* Directives */

= Synopsis =
This module makes it possible to execute Perl directly within Nginx and call Perl via SSI.

== Building Module at Compile-time ==
Unless built at compile-time, the module is not available. The default is to not build this module.
If you want to enable this module, is necessary to specify '''--with-http_perl_module''' when running ''configure''.

Your system must have Perl 5.6.1 or above.

== Known Problems ==
This module is experimental; therefore anything is possible and bugs are likely.

# If a Perl module performs protracted operation, (for example DNS lookups, database queries, etc), then the worker process that is running the Perl script is completely tied up for the duration of script. Therefore embedded Perl scripts should be extremely careful to limit themselves to short, predictable operations.
# It's possible for Nginx to leak memory if you reload the configuration file (via 'kill -HUP <pid>').

Example:
<geshi lang="nginx">
http {
perl_modules perl/lib;
perl_require hello.pm;

perl_set $msie6 '
sub {
my $r = shift;
my $ua = $r->header_in("User-Agent");
return "" if $ua =~ /Opera/;
return "1" if $ua =~ / MSIE [6-9] \.\d+/;
return "";
}
';

server {
location / {
perl hello::handler;
}
}
}
</geshi>

perl/lib/hello.pm:
<geshi lang="perl">
package hello;
use nginx;

sub handler {
my $r = shift;
$r->send_http_header("text/html");
return OK if $r->header_only;

$r->print("hello!\n<br/>");
$r->rflush;

if (-f $r->filename or -d _) {
$r->print($r->uri, " exists!\n");
}

return OK;
}

1;
__END__
</geshi>

= Directives =
== perl ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_perl_module/perl.txt" />

Directive establishes a function for the data location.

== perl_modules ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_perl_module/perl_modules.txt" />

Directive assigns additional path for Perl modules. Since version 0.6.7 this path is relative to directory of nginx configuration file nginx.conf, but not to nginx prefix directory.

== perl_require ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_perl_module/perl_require.txt" />

There can be multiple perl_require directives.

== perl_set ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_perl_module/perl_set.txt" />

Directive establishes the function of variable ???

= Calling Perl from SSI =
Instruction format is as follows:

<pre>

</pre>

= Methods of request object $r =
* $r->args - method returns the arguments of request.
* $r->discard_request_body - method tells nginx to discard the request body.
* $r->filename - method returns the name of file, which corresponds to URI request.
* $r->has_request_body(function) - method returns 0, if there is no request body. But if the request body exists, then the passed function is established and 1 returned. At the end of the body processing, nginx will call the established processor. Example usage:

<geshi lang="perl">
package hello;

use nginx;

sub handler {
my $r = shift;

if ($r->request_method ne "POST") {
return DECLINED;
}

if ($r->has_request_body(\&post)) {
return OK;
}

return 400;
}

sub post {
my $r = shift;
$r->send_http_header;
$r->print("request_body: \"", $r->request_body, "\"<br/>");
$r->print("request_body_file: \"", $r->request_body_file, "\"<br/>\n");
return OK;
}

1;

__END__
</geshi>

* $r->header_in(header) - retrieve an HTTP request header.
* $r->header_only - true if we only need to return a response header.
* $r->header_out(header, value) - set a response header.
* $r->internal_redirect(uri) - method makes internal redirect to the indicated uri. Redirect occurs only after the completion of Perl script.
* $r->print(args, ...) - sends data to client.
* $r->request_body - method returns the request body of client when the body is not recorded into the temporary file.
: So that the body of the demand of client is guaranteed to remain in memory, it is necessary to limit its size with the aid
: of client_max_body_size and to assign sufficient size for the buffer using client_body_buffer_size.
* $r->request_body_file — method returns the name of the file, in which is stored the body of the demand of client. The file must be removed on the completion of work. So that the body of the request would always be written to the file, it is necessary to indicate client_body_in_file_only on.
* $r->request_method — method returns the HTTP method of the request.
* $r->remote_addr - method returns IP address of client.
* $r->rflush - method immediately transmits data to client.
* $r->sendfile(file [, displacement [, length ] ) - transfers to client contents of the file indicated. The optional parameters indicate initial offset and length of transmitted data. Strictly the transmission of data occurs only after the completion of the perl script.
* $r->send_http_header(type) - adds header to response. The optional parameter "type" establishes the value of line "Content-Type" in the title of answer.
* $r->sleep(milliseconds, handler) - method sets the specified handler and stops processing the request at a given time. nginx will continue to process other requests in the meantime. After the specified timeout has expired, nginx will run the installed handler. Please note that you need to pass a reference to the function handler. To transfer data between processors you should use $r->variable(). Example of usage:

<geshi lang="perl">
package hello;

use nginx;

sub handler {
my $r = shift;

$r->discard_request_body;
$r->variable("var", "OK");
$r->sleep(1000, \&next);

return OK;
}

sub next {
my $r = shift;

$r->send_http_header;
$r->print($r->variable("var"));

return OK;
}

1;
__END__
</geshi>

* $r->status(code) - sets the HTTP response code
* $r->unescape(text) - decodes the text, assigned in the form %XX.
* $r->uri - returns request URI.
* $r->variable(name[, value]) - the method returns or sets the value of the specified variable. Variables are local to each query.

= References =
[http://nginx.org/en/docs/http/ngx_http_perl_module.html Original Documentation]

HttpAdditionModule

2012-05-02T19:42:26Z

Admin: /* Directives */

= Synopsis =
This module adds contents of other locations before and after the current location's content.

It is implemented as an output filter, the contents of the main request and subrequests to other locations are not buffered completely and are still sent to the client in a streaming fashion. Because the length of the final response body is unknown while sending the HTTP headers, the HTTP chunked encoding is always used here.

== Installation ==

By default the module is not built, it is necessary to enable its build with
<pre>
./configure --with-http_addition_module
</pre>
at compilation time.

Example:
<geshi lang="nginx">
location / {
add_before_body /before_action;
add_after_body /after_action;
}
</geshi>

== Limitations ==

Note that as of 0.8.17 no contents will be added if the current location is served as a subrequest itself. Consider the following example:

<geshi lang="nginx">
location /foo {
add_before_body /bar;
}

location /bar {
add_before_body /baz;
}
</geshi>

Then accessing ''/foo'' won't get ''/baz'' inserted before the contents of the subrequest ''/bar''.

Also note that at this time, only strings can be used in before/after body locations, not variables. So
<geshi lang="nginx">
location / {
set $before_action /before_action;
add_before_body $before_action;
}
</geshi>

will not work as expected (although the configuration file will still load properly).

= Directives =
== add_before_body ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_addition_module/add_before_body.txt" />

Directive adds content of uri before the response body, issued as a result of the work of the assigned subrequest.

== add_after_body ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_addition_module/add_after_body.txt" />

Directive adds content of uri after the response body, issued as a result of the work of the assigned subrequest.

== addition_types ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_addition_module/addition_types.txt" />

Directive (since 0.7.9) allows you to add text only to locations of the specified MIME-types (defaults to ''"text/html"'').

(Before 0.8.17, this directive was mispelled as "addtion_types" in the source. This bug has been fixed in 0.8.17.)

= References =
[http://nginx.org/en/docs/http/ngx_http_addition_module.html Original Documentation]

HttpUseridModule

2012-05-02T19:41:46Z

Admin: /* Directives */

= Synopsis =

The module ngx_http_userid_module hands out cookies which are used for the purposes of
identifying clients upon subsequent requests. For logging it is possible to use variables
<code>$uid_got</code> and <code>$uid_set</code>.

Remark: keep in mind variables <code>$uid_got</code> and <code>$uid_set</code> are not accessible in SSI,
because the SSI filter module's processing occurs earlier in the chain than the userid filter.

This module is compatible with [http://www.lexa.ru/programs/mod-uid-eng.html mod_uid] for Apache.

Example
<geshi lang="nginx">
userid on;
userid_name uid;
userid_domain example.com;
userid_path /;
userid_expires 365d;
userid_p3p 'policyref="/w3c/p3p.xml", CP="CUR ADM OUR NOR STA NID"';
</geshi>

= Directives =
== userid ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid.txt" />

Enables or disables issuing cookies and logging requested cookies:

* on - enables version 2 cookies and logs them;
* v1 - enables version 1 cookies and logs them;
* log - do not send cookies, but write down incoming cookies to log;
* off - do not send cookies, and don't write them to logs;

== userid_domain ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid_domain.txt" />

Assigns the domain for cookie. The parameter "none" doesn't issue domain for cookie.

== userid_expires ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid_expires.txt" />

Sets the expiration time for the cookie.

The parameter set & send-out browser expiration time for cookie. Value "max" assigns the time on 31 December, 2037, 23:55:55 gmt. This is the maximum time that older browsers understand.

== userid_name ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid_name.txt" />

Assigns name to cookie.

== userid_p3p ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid_p3p.txt" />

Directive assigns value for the header P3P, which will sent together with cookie.

== userid_path ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid_path.txt" />

Sets the cookie path.

== userid_service ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_userid_module/userid_service.txt" />

Directive assigns the IP address of the server which gave out cookie.
If not set, version 1 cookies set to zero, and for version 2 cookies the IP address of server.

= References =
[http://nginx.org/en/docs/http/ngx_http_userid_module.html Original Documentation]

HttpUpstreamModule

2012-05-02T19:40:42Z

Admin: /* Directives */

= Synopsis =

This module provides simple load-balancing (round-robin and client IP) across backend servers.

Example:
<geshi lang="nginx">
upstream backend {
server backend1.example.com weight=5;
server backend2.example.com:8080;
server unix:/tmp/backend3;
}

server {
location / {
proxy_pass http://backend;
}
}
</geshi>

= Directives =
== ip_hash ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_upstream_module/ip_hash.txt" />

This directive causes requests to be distributed between upstreams based on the IP-address of the client. <BR>
The key for the hash is the class-C network address of the client. This method guarantees that the client request will always be transferred to the same server. But if this server is considered inoperative, then the request of this client will be transferred to another server. This gives a high probability clients will always connect to the same server.

It is not possible to combine ip_hash and weight methods for connection distribution. If one of the servers must be removed for some time, you must mark that server as *down*.

For example:

<geshi lang="nginx">
upstream backend {
ip_hash;
server backend1.example.com;
server backend2.example.com;
server backend3.example.com down;
server backend4.example.com;
}
</geshi>

== keepalive ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_upstream_module/keepalive.txt" />

== server ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_upstream_module/server.txt" />

Directive assigns the name and the parameters of server. For the name it is possible to use a domain name, an address, port or unix socket. If domain name resolves to several addresses, then all are used.

* weight = NUMBER - set weight of the server, if not set weight is equal to one.
* max_fails = NUMBER - number of unsuccessful attempts at communicating with the server within the time period (assigned by parameter fail_timeout) after which it is considered inoperative. If not set, the number of attempts is one. A value of 0 turns off this check. What is considered a failure is defined by [[NginxHttpProxyModule#proxy_next_upstream|proxy_next_upstream]] or [[HttpFcgiModule#fastcgi_next_upstream|fastcgi_next_upstream]] (except http_404 errors which do not count towards max_fails).
* fail_timeout = TIME - the time during which must occur *max_fails* number of unsuccessful attempts at communication with the server that would cause the server to be considered inoperative, and also the time for which the server will be considered inoperative (before another attempt is made). If not set the time is 10 seconds. fail_timeout has nothing to do with upstream response time, use [[NginxHttpProxyModule#proxy_connect_timeout|proxy_connect_timeout]] and [[NginxHttpProxyModule#proxy_read_timeout|proxy_read_timeout]] for controlling this.
* down - marks server as permanently offline, to be used with the directive ip_hash.
* backup - (0.6.7 or later) only uses this server if the non-backup servers are all down or busy (cannot be used with the directive ip_hash)

Example configuration:

<geshi lang="nginx">
upstream backend {
server backend1.example.com weight=5;
server 127.0.0.1:8080 max_fails=3 fail_timeout=30s;
server unix:/tmp/backend3;
}
</geshi>

'''Attention: If you use only one upstream server nginx set a internal variable to 1, this means that the max_fails & fail_timeout parameter are not handled.'''

Effect: If nginx can not connect to upstream the request it's gone.

Solution: Use the same server several times

== upstream ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_upstream_module/upstream.txt" />

This directive describes a set of servers, which can be used in directives proxy_pass and fastcgi_pass as a single entity.
They can listen to server on different ports and furthermore, it is possible to simultaneously use a server that listens on both TCP and Unix sockets.

Servers can be assigned different weights. If not specified weight is equal to one.

Example configuration:

<geshi lang="nginx">
upstream backend {
server backend1.example.com weight=5;
server 127.0.0.1:8080 max_fails=3 fail_timeout=30s;
server unix:/tmp/backend3;
}
</geshi>

Requests are distributed according to the servers in round-robin manner with respect of the server weight.<BR>
For example of every seven requests given above they will be distributed like this: 5 requests on backend1.example.com and one request to the second and the third of server. If with an attempt at the work with the server error occurred, then the request will be transmitted to the following server and then until all workers of server not are tested. If successful answer is not succeeded in obtaining from all servers, then to client will be returned the result of work with the last server.

= Variables =
Since version 0.5.18, it is possible to log via log_module variables.

Configuration example:
<geshi lang="nginx">
log_format timing '$remote_addr - $remote_user [$time_local] $request '
'upstream_response_time $upstream_response_time '
'msec $msec request_time $request_time';

log_format up_head '$remote_addr - $remote_user [$time_local] $request '
'upstream_http_content_type $upstream_http_content_type';
</geshi>

== $upstream_addr ==
Address (ip:port or unix:socket-path) of the upstream server that handled the request. If multiple upstream addresses were accessed while processing the request, then the addresses are separated by a comma and space, for example: "192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock". If there was an internal redirect from one server group to another using the "X-Accel-Redirect" or error_page, these groups of servers are separated by a colon with a space on each side, for example: "192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock : 192.168.10.1:80, 192.168.10.2:80". Note the spaces: it's a good idea to enclose this in "" in a log format to make parsing easier.

== $upstream_cache_status ==
Appeared in 0.8.3. Possible values:
* MISS
* EXPIRED - expired, request was passed to backend
* UPDATING - expired, stale response was used due to proxy/fastcgi_cache_use_stale updating
* STALE - expired, stale response was used due to proxy/fastcgi_cache_use_stale
* HIT

== $upstream_status ==
Upstream server status of the answer. As in $upstream_addr, if more than one upstream server is accessed, the values are separated by commas and colons with spaces.

== $upstream_response_time ==
Response time of upstream server(s) in seconds, with an accuracy of milliseconds. As in $upstream_addr, if more than one upstream server is accessed, the values are separated by commas and colons with spaces.

== $upstream_http_$HEADER ==
Arbitrary HTTP protocol headers, for example:
<geshi lang="nginx">
$upstream_http_host
</geshi>

Bear in mind that if more than one upstream server is accessed, only the header from the last one appears here.

= References =

[http://nginx.org/en/docs/http/ngx_http_upstream_module.html Original Documentation]

Modules

2012-05-02T19:39:57Z

Admin: /* Standard HTTP 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 core modules =
These modules are required.

{| class="modules-index-table"
! Name !! Description
|-
| [[CoreModule|Main]]
| Configure error logging, processes, permissions, etc.
|-
| [[EventsModule|Events]]
| Configure epoll, kqueue, select, poll, etc.
|-
|}

= Standard HTTP modules =
These modules are automatically compiled in unless explicitly disabled with <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to disable
|-
| [[HttpCoreModule|Core]]
| Control ports, locations, error pages, aliases, and other essentials.
|
| --without-http
|-
| [[HttpAccessModule|Access]]
| Allow/deny based on IP address.
|
| --without-http_access_module
|-
| [[HttpAuthBasicModule|Auth Basic]]
| Basic HTTP authentication.
|
| --without-http_auth_basic_module
|-
| [[HttpAutoindexModule|Auto Index]]
| Generates automatic directory listings.
|
| --without-http_autoindex_module
|-
| [[HttpBrowserModule|Browser]]
| Interpret "User-Agent" string.
|
| --without-http_browser_module
|-
| [[HttpCharsetModule|Charset]]
| Recode web pages.
|
| --without-http_charset_module
|-
| [[HttpEmptyGifModule|Empty GIF]]
| Serve a 1x1 image from memory.
|
| --without-http_empty_gif_module
|-
| [[HttpFastcgiModule|FastCGI]]
| FastCGI Support.
|
| --without-http_fastcgi_module
|-
| [[HttpGeoModule|Geo]]
| Set config variables using key/value pairs of IP addresses.
|
| --without-http_geo_module
|-
| [[HttpGzipModule|Gzip]]
| Gzip responses.
|
| --without-http_gzip_module
|-
| [[HttpHeadersModule|Headers]]
| Set arbitrary HTTP response headers.
|
|-
| [[HttpIndexModule|Index]]
| Controls which files are to be used as index.
|
|-
| [[HttpLimitReqModule|Limit Requests]]
| Limit frequency of connections from a client.
| 0.7.20
| --without-http_limit_req_module
|-
| [[HttpLimitZoneModule|Limit Zone]]
| Limit simultaneous connections from a client. Deprecated in 1.1.8, use Limit Conn Instead.
|
| --without-http_limit_zone_module
|-
| [[HttpLimitConnModule|Limit Conn]]
| Limit concurrent connections based on a variable.
|
| --without-http_limit_conn_module
|-
| [[HttpLogModule|Log]]
| Customize access logs.
|
|-
| [[HttpMapModule|Map]]
| Set config variables using arbitrary key/value pairs.
|
| --without-http_map_module
|-
| [[HttpMemcachedModule|Memcached]]
| Memcached support.
|
| --without-http_memcached_module
|-
| [[HttpProxyModule|Proxy]]
| Proxy to upstream servers.
|
| --without-http_proxy_module
|-
| [[HttpRefererModule|Referer]]
| Filter requests based on <code>Referer</code> header.
|
| --without-http_referer_module
|-
| [[HttpRewriteModule|Rewrite]]
| Request rewriting using regular expressions.
|
| --without-http_rewrite_module
|-
| [[HttpScgiModule|SCGI]]
| SCGI protocol support.
| 0.8.42
| --without-http_scgi_module
|-
| [[HttpSplitClientsModule|Split Clients]]
| Splits clients based on some conditions
| 0.8.37
| --without-http_split_clients_module
|-
| [[HttpSsiModule|SSI]]
| Server-side includes.
|
| --without-http_ssi_module
|-
| [[HttpUpstreamModule|Upstream]]
| For load-balancing.
|
| --without-http_upstream_ip_hash_module (ip_hash directive only)
|-
| [[HttpUseridModule|User ID]]
| Issue identifying cookies.
|
| --without-http_userid_module
|-
| [[HttpUwsgiModule|uWSGI]]
| uWSGI protocol support.
| 0.8.40
| --without-http_uwsgi_module
|-
| [[X-accel|X-Accel]]
| X-Sendfile-like module.
|
|
|}

= Optional HTTP modules =
The following modules must be enabled at compile-time with the specified option to <code>configure</code>.

{| class="modules-index-table"
! Name
! Description
! Version
! configure argument to enable
|-
| [[HttpAdditionModule|Addition]]
| Append text to pages.
|
| --with-http_addition_module
|-
| [[HttpDegradationModule|Degradation]]
| Allow to return 204 or 444 code for some locations on low memory condition.
| 0.8.25
| --with-http_degradation_module
|-
| [[HttpPerlModule|Embedded Perl]]
| Use Perl in Nginx config files.
|
| --with-http_perl_module
|-
| [[HttpFlvModule|FLV]]
| Flash Streaming Video
|
| --with-http_flv_module
|-
| [[HttpGeoipModule|GeoIP]]
| Creates variables with information from the [http://www.maxmind.com/ MaxMind] GeoIP binary files.
| 0.8.6, 0.7.63
| --with-http_geoip_module
|-
| [[GooglePerftoolsModule|Google Perftools]]
| Google Performance Tools support.
| 0.6.29
| --with-google_perftools_module
|-
| [[HttpGzipStaticModule|Gzip Precompression]]
| Serves precompressed versions of static files.
| 0.6.23
| --with-http_gzip_static_module
|-
| [[HttpImageFilterModule|Image Filter]]
| Transform images with Libgd
| 0.7.54
| --with-http_image_filter_module
|-
| [[HttpMp4Module|MP4]]
| Enables mp4 streaming with seeking ability.
| 1.1.3, 1.0.7
| --with-http_mp4_module
|-
| [[HttpRandomIndexModule|Random Index]]
| Randomize directory indexes.
| 0.7.15
| --with-http_random_index_module
|-
| [[HttpRealipModule|Real IP]]
| For using nginx as backend
|
| --with-http_realip_module
|-
| [[HttpSecureLinkModule|Secure Link]]
| Protect pages with a secret key.
| 0.7.18
| --with-http_secure_link_module
|-
| [[HttpSslModule|SSL]]
| HTTPS/SSL support.
|
| --with-http_ssl_module
|-
| [[HttpStubStatusModule|Stub Status]]
| View server statistics.
|
| --with-http_stub_status_module
|-
| [[HttpSubModule|Substitution]]
| Replace text in pages
|
| --with-http_sub_module
|-
| [[HttpDavModule|WebDAV]]
| WebDAV pass-through support.
|
| --with-http_dav_module
|-
| [[HttpXsltModule|XSLT]]
| Post-process pages with XSLT.
| 0.7.8
| --with-http_xslt_module
|}

= Mail modules =
{| class="modules-index-table"
! Name
! Description
! configure argument
|-
| [[MailCoreModule|Core]]
| Nginx is able to handle and proxy the IMAP, POP3, SMTP protocols.
| --with-mail<br>--without-mail_pop3_module<br>--without-mail_imap_module<br>--without-mail_smtp_module
|-
| [[MailAuthModule|Auth]]
| Use Nginx to authenticate mail services.
|-
| [[MailProxyModule|Proxy]]
| Nginx can proxy IMAP, POP3, and SMTP protocols.
|-
| [[MailSslModule|SSL]]
| This module ensures SSL/TLS support for POP3/IMAP/SMTP.
| --with-mail_ssl_module
|}

= Third party modules and Patches =
Please see the catalog of [[3rdPartyModules|3rd party modules]].

= References =
* [[ModulesByExample|Module index by example]]
* [[ConfigNotation| Configuration Notation Reference]]
* [[ModuleComparisonMatrix| Module comparison matrix with other servers]]
* [[FeatureRequests| Feature Requests]]
* [[GettingStarted| Getting Started]]
* [[Configuration| Configuration Cookbook]]
* [[DirectiveIndex| Index of all Directives]]

HttpSsiModule

2012-05-02T19:39:13Z

Admin: /* Directives */

= Synopsis =
This module provides a filter which processes Server-Side Includes (SSI) in the input.
The list of the supported commands for SSI is currently incomplete.

Example
<geshi lang="nginx">
location / {
ssi on;
}
</geshi>

= Directives =
== ssi ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssi_module/ssi.txt" />

Enables SSI processing.

Note that when SSI is enabled the Last-Modified and Content-Length headers are not sent.

== ssi_silent_errors ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssi_module/ssi_silent_errors.txt" />

Doesn't output "[an error occurred while processing the directive] ", if an error occurs while processing the SSI.

== ssi_types ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_ssi_module/ssi_types.txt" />

Enables SSI processing for MIME-types in addition to "text/html" types.

== ssi_value_length ==
'''syntax:''' ''ssi_value_length length''

'''default:''' ''ssi_value_length 256''

'''context:''' ''http, server, location''

Defines the allowed length of values for parameters used in SSI.

= SSI Commands =

Instruction format is the following:
<pre>

</pre>

Note that the hash ('#') must immediately follow the two dashes ('--').

The supported SSI commands are listed below.

== block ==
This command creates a block, which can be used as a silencer in command <code>include</code>. Inside the block there can be other SSI commands.

* <code>name</code> — the name of the block. For example:
<pre>

the silencer

</pre>

== config ==
Assigns some configuration parameter for SSI.

* <code>errmsg</code> — the line which is used as the error during SSI processing. By default, this string is used: "[an error occurred while processing the directive] "
* <code>timefmt</code> — the time formatting string, as used in strftime(3). By default, this string is used:
<pre>
"%A, %d-%b-%Y %H:%M:%S %Z"
</pre>
To include time in seconds use the format "%s" as well.

== echo ==

Print a variable.

* <code>var</code> — the name of the variable
* <code>encoding</code> — the escape of the variable, there are <code>none</code>, <code>url</code>, <code>entity</code>. Defaults to <code>entity</code>
* <code>default</code> - if the variable is empty, display this string. Defaults to "none". Example:
<pre>

</pre>
is the same as
<pre>
no
</pre>

== if / elif / else / endif ==

Conditionally include text or other directives. Usage:

<pre>

...

...

...

</pre>
Only one level of nesting is possible.
* ''expr'' — the expression to evaluate. It can be a variable:
<pre>

</pre>
A string comparison:
<pre>


</pre>
Or a regex match:
<pre>


</pre>

If there are variables in the text, they will have their values substituted.

== include ==

Include a document from another source.

* <code>file</code> — include a file, e.g.
<pre>

</pre>
* <code>virtual</code> — include a request, e.g.
<pre>

</pre>

The target of "file" or "virtual" must be a location in the server configuration.

The distinction between "file" and "virtual" is mostly historical. "file" is the same as "virtual" with implied "wait" option. At one point the directives mirrored the Apache equivalents but now they are basically the same operation. Both can handle a URI and both can serve a static file.

Multiple requests will be issued in parallel. If you need them issued sequentially, use the "wait" option.
* <code>stub</code> — The name of the block to use as a default if the request is empty or returns an error.
<pre>
 

</pre>
* <code>wait</code> — when set to yes, the rest of the SSI will not be evaluated until the current request is finished. Example:
<pre>

</pre>

== set ==

Assign a variable.

* <code>var</code> — the variable.
* <code>value</code> — its value. If it contains variable names, these will be evaluated.

= Variables =
== $date_local ==
The current time in the local timezone. The config option "timefmt" controls the format.

== $date_gmt ==
The current time in GMT. The config option "timefmt" controls the format.

= References =
[http://nginx.org/en/docs/http/ngx_http_ssi_module.html Original Documentation]

HttpSplitClientsModule

2012-05-02T19:38:36Z

Admin: /* split_clients */

= Synopsis =

ngx_http_split_clients_module is used to split clients based on some conditions(e.g ip addresses, headers, cookies, etc).

Example configuration:
<geshi lang="nginx">
http {
split_clients "${remote_addr}AAA" $variant {
0.5% .one;
2.0% .two;
- "";
}

server {
location / {
index index${variant}.html;
</geshi>

$cookie_..., etc, may be used as a source for splitting. The source string is hashed using MurmurHash2 (as of 1.0.1; previously CRC32) and the percent of the hash is used as source value.

= Directives =

== split_clients ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_split_clients_module/split_clients.txt" />

= References =

* [http://nginx.org/en/docs/http/ngx_http_split_clients_module.html Original Documentation]
* [http://www.ruby-forum.com/topic/209653 Naming convention discussion]

HttpRewriteModule

2012-05-02T19:38:00Z

Admin: /* Directives */

= Synopsis =
This module makes it possible to change URI using regular expressions (PCRE), and to redirect and select configuration depending on variables.

If the directives of this module are given at the server level, then they are carried out before the location of the request is determined. If in that selected location there are further rewrite directives, then they also are carried out. If the URI changed as a result of the execution of directives inside location, then location is again determined for the new URI.

This cycle can be repeated up to 10 times, after which Nginx returns a 500 error.

= Directives =
== break ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_rewrite_module/break.txt" />

Completes the current set of rules. Continue processing within the current location block but do not process any more rewrite directives.

Example:

<geshi lang="nginx">
if ($slow) {
limit_rate 10k;
break;
}
</geshi>

== if ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_rewrite_module/if.txt" />

'''note:''' Before using if please see [[IfIsEvil|the if is evil page]] and consider using [[NginxHttpCoreModule#try_files|try_files]] instead.

Checks the truth of a condition. If the condition evaluates to true, then the code indicated in the curly braces is carried out and the request is processed in accordance with the configuration within the following block. The configuration inside the <code>if</code>directive is inherited from the previous level.

The condition can be:

* the name of a variable; false values are: empty string (<code>""</code>, or any string starting with "0";
* a comparison of a variable using the <code>=</code> and <code>!=</code> operators;
* pattern matching with [http://perldoc.perl.org/perlretut.html regular expressions]:
** <code>~</code> performs a case-sensitive match
** <code>~*</code> performs a case-insensitive match (<code>firefox</code> matches <code>FireFox</code>)
** <code>!~</code> and <code>!~*</code> mean the opposite, "doesn't match"
* checking for the existence of a file using the <code>-f</code> or <code>!-f</code> operators;
* checking for the existence of a directory using <code>-d</code> or <code>!-d</code>;
* checking for the existence of a file, directory or symbolic link using <code>-e</code> or <code>!-e</code>;
* checking whether a file is executable using <code>-x</code> or <code>!-x</code>.

Parts of the regular expressions can be in parentheses, whose value can then later be accessed in the <code>$1</code> to <code>$9</code> variables. See [http://perldoc.perl.org/perlretut.html#Extracting-matches Extracting matches].

Examples of use:

<geshi lang="nginx">
if ($http_user_agent ~ MSIE) {
rewrite ^(.*)$ /msie/$1 break;
}

if ($http_cookie ~* "id=([^;] +)(?:;|$)" ) {
set $id $1;
}

if ($request_method = POST ) {
return 405;
}

if ($slow) {
limit_rate 10k;
}

if ($invalid_referer) {
return 403;
}

if ($args ~ post=140){
rewrite ^ http://example.com/ permanent;
}
</geshi>
The value of the built-in variable <code>$invalid_referer</code> is given by the directive [[HttpRefererModule#valid_referers|valid_referers]].

== return ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_rewrite_module/return.txt" />

This directive concludes execution of the rules and returns the status code indicated to client. It is possible to use the following values: 200, 204, 400, 402-406, 408, 410, 411, 413, 416 and 500-504. Furthermore, nonstandard code 444 closes the connection without sending any headers.

== rewrite ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_rewrite_module/rewrite.txt" />

This directive changes '''URI''' in accordance with the regular expression and the replacement string. Directives are carried out in order of appearance in the configuration file.

Flags make it possible to end the execution of rewrite directives.

If the replacement string begins with <code>http://</code> then the client will be redirected, and any further rewrite directives are terminated.

Flags can be any of the following:

* last - completes processing of current rewrite directives and restarts the process (including rewriting) with a search for a match on the URI from all available locations.
* break - completes processing of current rewrite directives and non-rewrite processing continues within the current location block only.
* redirect - returns temporary redirect with code 302; it is used if the substituting line begins with <code>http://</code>
* permanent - returns permanent redirect with code 301
- Note that outside location blocks, '''last''' and '''break''' are effectively the same.

Example:

<geshi lang="nginx">
rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 last;
rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra last;
return 403;
</geshi>

But if we place these directives in location <code>/download/</code>, then it is necessary to replace flag "last" by "break", otherwise Nginx will hit the 10 cycle limit and return error 500:

<geshi lang="nginx">
location /download/ {
rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 break;
rewrite ^(/download/.*)/audio/(.*)\..*$ $1/mp3/$2.ra break;
return 403;
}
</geshi>
If in the line of replacement arguments are indicated, then the rest of the request arguments are appended to them. To avoid having them appended, place a question mark as the last character:

<geshi lang="nginx">
rewrite ^/users/(.*)$ /show?user=$1? last;
</geshi>

Note: for curly braces( { and } ), as they are used both in regexes and for block control, to avoid conflicts, regexes with curly braces are to be enclosed with double quotes (or single quotes). For example, to rewrite URLs like:
<pre>/photos/123456</pre>
to:
<pre>/path/to/photos/12/1234/123456.png</pre>
use the following (note the quotes enclosing the regex):
<geshi lang="nginx">
rewrite "/photos/([0-9] {2})([0-9] {2})([0-9] {2})" /path/to/photos/$1/$1$2/$1$2$3.png;
</geshi>

If you specify a <code>?</code> at the end of a rewrite then Nginx will drop the original $args (arguments). When using [[HttpCoreModule#.24request_uri|$request_uri]] or [[HttpCoreModule#.24uri|$uri]]&[[HttpCoreModule#.24args|$args]] you should specify the <code>?</code> at the end of the rewrite to avoid Nginx doubling the query string.

Example using $request_uri in a rewrite from www.example.com to example.com
<geshi lang="nginx">server {
server_name www.example.com;
rewrite ^ http://example.com$request_uri? permanent;
}</geshi>

Also rewrite operates only on path, not parameters. To rewrite a URL with parameters to another URL, use this instead:
<geshi lang="nginx">
if ($args ~ post=100){
rewrite ^ http://example.com/new-address.html? permanent;
}
</geshi>
Note that the $args variable is '''not''' decoded, unlike URIs during [[NginxHttpCoreModule#location|location matching]].

Also note that named subexpressions <code>(?<name>)</code> should be used when accessing variables from a [[HttpMapModule#map|map]] using regular expressions (patterns begininng with <code>~</code>) because the map runs on demand and will override <code>$1</code> (even when named subexpressions are used in the map).

== rewrite_log ==
{{Directive|name=rewrite_log|args=on {{!}} off|default=off|vars=no|context=http, server, if-in-server, location, if-in-location}}

When enabled, outputs information about rewrites to the error log at ''notice'' level.

== set ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_rewrite_module/set.txt" />

Directive establishes value for the variable indicated. As the value it is possible to use a text, variables and their combination.

You can use '''set''' to define a new variable. Note that you can't set the value of a ''$http_xxx'' header variable.

== uninitialized_variable_warn ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_rewrite_module/uninitialized_variable_warn.txt" />

Enables or disables logging of warnings about noninitialized variables.

= Internal implementation =

Internally, the rewrite directives are compiled at the time the configuration file is loaded into internal codes, usable during the request by the interpreter.

This interpreter is a simple stack virtual machine. For example, the directive:

<geshi lang="nginx">
location /download/ {
if ($forbidden) {
return 403;
}
if ($slow) {
limit_rate 10k;
}
rewrite ^/(download/.*)/media/(.*)\..*$ /$1/mp3/$2.mp3 break;
}
</geshi>
will be compiled into this sequence:

<pre>
variable $forbidden
checking to zero
recovery 403
completion of entire code
variable $slow
checking to zero
checkings of regular expression
copying "/"
copying $1
copying "/mp3/"
copying $2
copying ".mp3"
completion of regular expression
completion of entire sequence
</pre>

Note that there is no code for directive limit_rate, since it does not refer to module ngx_http_rewrite_module. The "if" block exists in the same part of the configuration as the "location" directive.

If $slow is true, then what's inside the "if" block is evaluated, and in this configuration limit_rate it is equal to 10k.

Directive:

<geshi lang="nginx">
rewrite ^/(download/.*)/media/(.*)\..*$ /$1/mp3/$2.mp3 break;
</geshi>
It is possible to reduce the sequence, if in the regular expression we include the first slash inside the parentheses:

<geshi lang="nginx">
rewrite ^(/download/.*)/media/(.*)\..*$ $1/mp3/$2.mp3 break;
</geshi>
then the sequence will appear like this:

<pre>
checking regular expression
copying $1
copying "/mp3/"
copying $2
copying ".mp3"
completion of regular expression
completion of entire code
</pre>

= References =
[http://nginx.org/en/docs/http/ngx_http_rewrite_module.html Original Documentation]

[http://www.pcre.org/pcre.txt PCRE Man Page in Plain Text]

HttpRefererModule

2012-05-02T19:37:11Z

Admin: /* valid_referers */

= Synopsis =
This module makes it possible to block access to the site with the incorrect values of line "Referer" in the request header.

Keep in mind that it is easy to spoof this header; therefore, the purpose of using of this module consists not in 100% blocking of these requests, but in the blocking of the mass flow of requests, made from typical browsers. Also, consider that the typical browser does not always provide a "Referer" header, even for correct requests.

Example
<geshi lang="nginx">
location /photos/ {
valid_referers none blocked www.mydomain.com mydomain.com;

if ($invalid_referer) {
return 403;
}
}
</geshi>

= Directives =
== valid_referers ==
<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_referer_module/valid_referers.txt" />

This directive assigns a value of 0 or 1 to the variable <code>$invalid_referer</code> based on the contents of the <code>referer</code> header.

You can use this to help reduce deep-linking from outside sites. If <code>Referer</code> header is not accounted for in the list of <code>valid_referers</code>, then <code>$invalid_referer</code> will be set to 1 (see example above).

The parameters can be as follows:
* <code>none</code> means the absence of "Referer" header.
* <code>blocked</code> means masked <code>Referer</code> header by firewall, for example, "Referer: XXXXXXX".
* server_names is a list of one or more servers. From version 0.5.33 onwards, * wildcards can be used in the server names.

= References =
[http://nginx.org/en/docs/http/ngx_http_referer_module.html Original Documentation]