FAQ

Page Discussion Edit History

Nginx3rdPartyModules

Contents

Edit section: 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.

Edit section: Compiling third party modules Compiling third party modules

Modules are typically added by compiling them along with the Nginx source.

From the Nginx source directory, type:

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

You can use as many --add-module arguments as needed.

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

Edit section: Writing your own module Writing your own module

Evan Miller has written the definitive guide to Nginx module development. But some parts of it are a little out of date. You've been warned.


Edit section: Catalog of Modules Catalog of Modules

Edit section: Accept Language Module Accept Language Module

Parses the Accept-Language header and gives the most suitable locale from a list of supported locales.

Author: Guillaume Maury
Documentation
Download

Edit section: Access Key Module Access Key Module

Denies access unless the request URL contains an access key.


Author: Mykola Grechukh
Documentation
Download

Edit section: Auth PAM Module Auth PAM Module

HTTP Basic Authentication using PAM.

Author: Sergio Talens-Oliag
Documentation
Download

Edit section: Cache Purge Module Cache Purge Module

Module adding ability to purge content from FastCGI and proxy caches.

Author: FRiCKLE
Documentation
Download

Edit section: Chunkin Module Chunkin Module

HTTP 1.1 chunked-encoding request body support for Nginx.

Author: agentzh
Documentation
Download

Edit section: Circle GIF Module Circle GIF Module

Generates simple circle images with the colors and size specified in the URL.

Author: Evan Miller
Documentation
File:Nginx circle gif-0.1.3.tar.gz

Edit section: Drizzle Module Drizzle Module

Make nginx talk directly to mysql, drizzle, and sqlite3 by libdrizzle.

Author: chaoslawful, agentzh
Documentation
Download

Edit section: Echo Module Echo Module

Brings "echo", "sleep", "time", "exec", and more shell-style goodies to Nginx config file.

Author: agentzh
Documentation
Download

Edit section: Events Module Events Module

Privides options for start/stop events.
on_start /opt/f.sh;
on_stop kill `cat /tmp/f.pid`;
on_stop rm -f /tmp/f.sock;

Author: Anton Dutov
Documentation: en, ru
Source(Mercurial)
Download

Edit section: Expressz Module Expressz Module

First of the Expressz lineup modules, Off-loading image and file/stream compression to (a) GPU(s).

Author: Jason Giedymin at AcronymLabs
Documentation


Edit section: EY Balancer Module EY Balancer Module

Adds a request queue to Nginx that allows the limiting of concurrent requests passed to the upstream.

Author: Ry Dahl
Documentation
Download


Edit section: Fancy Indexes Module Fancy Indexes Module

Like the built-in autoindex module, but fancier.

Author: Adrian Perez de Castro
Documentation
Download

Edit section: GeoIP Module GeoIP Module

Country code lookups via the MaxMind GeoIP API.

Author: SPIL GAMES
Documentation
File:Nginx-geoip-0.2.tar.gz

Edit section: Headers More Module Headers More Module

Set and clear input and output headers...more than "add"!

Author: agentzh
Documentation
Download

Edit section: HTTP Healthcheck module HTTP Healthcheck module

Health check HTTP servers inside an upstream so you don't forward requests to bad hosts

Author: Jack Lindamood
Documentation

Edit section: HTTP Push Module HTTP Push Module

Turn Nginx into an adept long-polling HTTP Push (Comet) server.

Author: Leo Ponomarev
Documentation
Download

Edit section: HTTP Redis Module HTTP Redis Module

Redis support.

Author: Sergey A. Osokin
Download

Edit section: HTTP JavaScript Module HTTP JavaScript Module

Embedding SpiderMonkey. Nearly full port on Perl module.

Author: Peter Leonov (Russian)
Documentation
Download

Edit section: Log Request Speed Log Request Speed

Log the time it took to process each request.

Author: Mauro Stettler
Documentation

Edit section: Memc Module Memc Module

An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.

Author: agentzh
Documentation
Download

Edit section: Mogilefs Module Mogilefs Module

Implements a MogileFS client, provides a replace to the Perlbal reverse proxy of the original MogileFS.

Author: Valery Kholodkov
Documentation
Download

Edit section: MP4 Streaming Lite Module MP4 Streaming Lite Module

Will seek to a certain time within H.264/MP4 files when provided with a "start" parameter in the URL.

Author: Jiang Hong
Documentation
Download

Edit section: NCache NCache

Web cache system based on Nginx web server. Faster and more efficient than Squid.

Authors: shineyear,simon,genxi
Documentation
Download (32-bit)
Download (64-bit)

Edit section: Nginx Notice Module Nginx Notice Module

Serve static file to POST requests.

Author: Keith Rarick
Documentation
Download

Edit section: PHP Session Parser PHP Session Parser

Extract values that are stored in a serialized PHP session

Author: Mauro Stettler Documentation
Download

Edit section: RDS JSON Module RDS JSON Module

Help ngx_drizzle and other DBD modules emit JSON data.

Author: agentzh
Documentation
Download

Edit section: RRD Graph Module RRD Graph Module

This module provides an HTTP interface to RRDtool's graphing facilities.

Author: Evan Miller
Documentation
File:Mod rrd graph-0.2.0.tar.gz

Edit section: SCGI Module SCGI Module

SCGI implementation for Nginx.

Author: Manlio Perillo
Documentation
Download


Edit section: Secure Download Secure Download

Create expiring links.

Authors:
Mauro Stettler
Szymon Modzelewski
Documentation
File:Ngx http secure download.tar.gz


Edit section: SlowFS Cache Module SlowFS Cache Module

Module adding ability to cache static files.

Author: FRiCKLE
Documentation
Download


Edit section: Strip Module Strip Module

Whitespace remover.

Author: Evan Miller
Documentation
File:Mod strip-0.1.tar.gz


Edit section: Substitutions Module Substitutions Module

A filter module which can do both regular expression and fixed string substitutions on response bodies.

Author: Weibin Yao
Documentation
Download


Edit section: Supervisord Module Supervisord Module

Module providing nginx with API to communicate with supervisord and manage (start/stop) backends on-demand.

Author: FRiCKLE
Documentation
Download


Edit section: Upload Module Upload Module

Parses multipart/form-data allowing arbitrary handling of uploaded files.

Author: Valery Kholodkov
Documentation
Download

Edit section: Upload Progress Module Upload Progress Module

Tracks and reports upload progress.

Author: Brice Figureau
Documentation
Download

Edit section: Upstream Fair Balancer Upstream Fair Balancer

Sends an incoming request to the least-busy backend server, rather than distributing requests round-robin.

Author: Gregory Nosek
Documentation
Download

Edit section: Upstream Consistent Hash Upstream Consistent Hash

Select backend based on Consistent hash ring.

Authors:
Mauro Stettler
Documentation
Download


Edit section: Upstream Hash Module Upstream Hash Module

Provides simple upstream load distribution by hashing a configurable variable.

Author: Evan Miller
Documentation
File:Nginx upstream hash-0.3.tar.gz

Edit section: WSGI Module WSGI Module

WSGI implementation for Nginx. Allows easy deployment of Python applications.

Author: Manlio Perillo
Documentation
Download

Edit section: XSS Module XSS Module

Native support for cross-site scripting (XSS) in an nginx.

Author: agentzh
Documentation
Download

Edit section: Zip Module Zip Module

Assemble ZIP archives on the fly.

Author: Evan Miller
Documentation
File:Mod zip-1.1.5.tar.gz



Edit section: Patches 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.


Set Real IP header to any variable.

Author: Joaquin Cuenca Abela
File:Realip.patch

Redirect to static file based on its freshness.

Author: DeepFryed
File:Redirect modified.patch File:Redirect modified readme.txt

Revision for 0.7.61

Author: Victor Espigares
File:Redirect modified-0.7.61.patch

Log to syslog.

Author: Marlon de Boer
File:Syslog.patch (0.6.35)
File:Syslog 0.6.35 sh is not bash.patch
Patch against 0.8.4 (works on 0.7.x and 0.8.x)

Patch adding ability to purge content from nginx's FastCGI and proxy caches.

Author: FRiCKLE
Documentation
Download