Installing NGINX Open Source
This article explains how to install NGINX Open Source.
NGINX Open Source is available in two versions:
- Mainline – Includes the latest features and bug fixes and is always up to date. It is reliable, but it may include some experimental modules, and it may also have some number of new bugs.
- Stable – Doesn’t include all of the latest features, but has critical bug fixes that are always backported to the mainline version. We recommend the stable version for production servers.
Both the NGINX Open Source mainline and stable versions can be installed in two ways:
- As a prebuilt binary package. This is a quick and easy way to install NGINX Open Source. The package includes almost all official NGINX modules and is available for most popular operating systems. See Installing a Prebuilt Package.
- As binaries you compile from source. This way is more flexible: you can add particular modules, including third‑party modules, or apply the latest security patches. See Compiling and Installing from Source for details.
Installing NGINX Open Source from a package is much easier and faster than building from source, but building from source enables you to compile in non-standard modules. Prebuilt packages are available for most popular Linux distributions, including CentOS, Debian, Red Hat Enterprise Linux (RHEL), SUSE Linux Enterprise Server (SLES), and Ubuntu. See Linux packages at nginx.org for the list of currently supported operating systems.
See Source packages at nginx.org for the list of modules included in each prebuilt package.
NGINX, Inc. provides packages for the following CentOS, Oracle Linux, RHEL, AlmaLinux and Rocky Linux versions:
| Version | Supported Platforms |
|---|---|
| 8x | x86_64, aarch64/arm64 |
| 9x | x86_64, aarch64/arm64 |
The package can be installed from:
- A default RHEL / CentOS / Oracle Linux / AlmaLinux / Rocky Linux repository. This is the quickest way, but generally the provided package is outdated.
- The official repo at nginx.org. You have to set up the
yumrepository the first time, but after that the provided package is always up to date.
Install the EPEL repository:
sudo yum install epel-releaseUpdate the repository:
sudo yum updateInstall NGINX Open Source:
sudo yum install nginxVerify the installation:
sudo nginx -v
Install the prerequisites:
sudo yum install yum-utilsSet up the
yumrepository for RHEL/CentOS/Oracle Linux/AlmaLinux/Rocky Linux by creating the file nginx.repo in /etc/yum.repos.d, for example usingvi:sudo vi /etc/yum.repos.d/nginx.repoAdd the following lines to nginx.repo:
[nginx-stable] name=nginx stable repo baseurl=http://nginx.org/packages/centos/$releasever/$basearch/ gpgcheck=1 enabled=1 gpgkey=https://nginx.org/keys/nginx_signing.key module_hotfixes=true [nginx-mainline] name=nginx mainline repo baseurl=http://nginx.org/packages/mainline/centos/$releasever/$basearch/ gpgcheck=1 enabled=0 gpgkey=https://nginx.org/keys/nginx_signing.key module_hotfixes=truewhere the
stableormainlineelement points to the latest stable or mainline version of NGINX Open Source. By default, the repository for stable nginx packages is used. If you would like to use mainline nginx packages, run the following command:sudo yum-config-manager --enable nginx-mainlineSave the changes and quit
vi(press ESC and typewqat the:prompt).Update the repository:
sudo yum updateInstall the NGINX Open Source package:
sudo yum install nginxWhen prompted to accept the GPG key, verify that the fingerprint matches:
8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46,573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62,9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3, and if so, accept it.Start NGINX Open Source:
sudo nginxVerify that NGINX Open Source is up and running:
curl -I 127.0.0.1 HTTP/1.1 200 OK Server: nginx/1.27.4
NGINX provides packages for the following Debian operating systems:
| Version | Codename | Supported Platforms |
|---|---|---|
| 11.x | bullseye | x86_64, aarch64/arm64 |
| 12.x | bookworm | x86_64, aarch64/arm64 |
The package can be installed from:
- A default Debian repository. This is the quickest way, but generally the provided package is outdated.
- The official repo at nginx.org. You have to set up the
apt-getrepository the first time, but after that the provided package is always up to date.
Update the Debian repository information:
sudo apt-get updateInstall the NGINX Open Source package:
sudo apt-get install nginxVerify the installation:
sudo nginx -v
Install the prerequisites:
sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyringImport an official nginx signing key so
aptcould verify the packages authenticity. Fetch the key:curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/nullVerify that the downloaded file contains the proper key:
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpgThe output should contain the full fingerprints:
8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46,573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62,9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3as follows:pub rsa4096 2024-05-29 [SC] 8540A6F18833A80E9C1653A42FD21310B49F6B46 uid nginx signing key <signing-key-2@nginx.com> pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24] 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 uid nginx signing key <signing-key@nginx.com> pub rsa4096 2024-05-29 [SC] 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3 uid nginx signing key <signing-key-3@nginx.com>If the fingerprint is different, remove the file.
To set up the
aptrepository for stable nginx packages, run the following command:echo"deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ http://nginx.org/packages/debian `lsb_release -cs` nginx"\ | sudo tee /etc/apt/sources.list.d/nginx.listIf you would like to use
mainlinenginx packages, run the following command instead:echo"deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ http://nginx.org/packages/mainline/debian `lsb_release -cs` nginx"\ | sudo tee /etc/apt/sources.list.d/nginx.listSet up repository pinning to prefer our packages over distribution-provided ones:
echo -e "Package: *\nPin: origin nginx.org\nPin: release o=nginx\nPin-Priority: 900\n"\ | sudo tee /etc/apt/preferences.d/99nginxInstall the NGINX package:
sudo apt update sudo apt install nginxStart NGINX Open Source:
sudo nginxVerify that NGINX Open Source is up and running:
curl -I 127.0.0.1 HTTP/1.1 200 OK Server: nginx/1.27.4
NGINX provides packages for the following Ubuntu operating systems:
| Version | Codename | Supported Platforms |
|---|---|---|
| 20.04 | focal | x86_64, aarch64/arm64, s390x |
| 22.04 | jammy | x86_64, aarch64/arm64, s390x |
| 24.04 | noble | x86_64, aarch64/arm64 |
| 24.10 | oracular | x86_64, aarch64/arm64 |
The package can be installed from:
- A default Ubuntu repository. This is the quickest way, but generally the provided package is outdated.
- The official repo at nginx.org. You have to set up the
apt-getrepository the first time, but after that the provided package is always up to date.
Update the Ubuntu repository information:
sudo apt-get updateInstall the package:
sudo apt-get install nginxVerify the installation:
sudo nginx -v
Install the prerequisites:
sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyringImport an official nginx signing key so apt could verify the packages authenticity. Fetch the key:
curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/nullVerify that the downloaded file contains the proper key:
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpgThe output should contain the full fingerprints:
8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46,573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62,9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3as follows:pub rsa4096 2024-05-29 [SC] 8540A6F18833A80E9C1653A42FD21310B49F6B46 uid nginx signing key <signing-key-2@nginx.com> pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24] 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 uid nginx signing key <signing-key@nginx.com> pub rsa4096 2024-05-29 [SC] 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3 uid nginx signing key <signing-key-3@nginx.com>If the fingerprint is different, remove the file.
To set up the
aptrepository for stable nginx packages, run the following command:echo"deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ http://nginx.org/packages/ubuntu `lsb_release -cs` nginx"\ | sudo tee /etc/apt/sources.list.d/nginx.listIf you would like to use
mainlinenginx packages, run the following command instead:echo"deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \ http://nginx.org/packages/mainline/ubuntu `lsb_release -cs` nginx"\ | sudo tee /etc/apt/sources.list.d/nginx.listSet up repository pinning to prefer our packages over distribution-provided ones:
echo -e "Package: *\nPin: origin nginx.org\nPin: release o=nginx\nPin-Priority: 900\n"\ | sudo tee /etc/apt/preferences.d/99nginxInstall NGINX Open Source:
sudo apt update sudo apt install nginxStart NGINX Open Source:
sudo nginxVerify that NGINX Open Source is up and running:
curl -I 127.0.0.1 HTTP/1.1 200 OK Server: nginx/1.27.4
NGINX provides packages for SUSE Linux Enterprise Server:
| Version | Supported Platforms |
|---|---|
| SLES 15 SP2+ | x86_64 |
Install the prerequisites:
sudo zypper install curl ca-certificates gpg2To set up the
zypperrepository for stable nginx packages, run the following command:sudo zypper addrepo --gpgcheck --type yum --refresh --check \ 'http://nginx.org/packages/sles/$releasever_major' nginx-stableIf you would like to use mainline nginx packages, run the following command instead:
sudo zypper addrepo --gpgcheck --type yum --refresh --check \ 'http://nginx.org/packages/mainline/sles/$releasever_major' nginx-mainlineImport an official nginx signing key so
zypper/rpmcould verify the packages authenticity. Fetch the key:curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.keyVerify that the downloaded file contains the proper key:
gpg --with-fingerprint /tmp/nginx_signing.keyThe output should contain the full fingerprints:
8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46,573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62,9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3as follows:pub rsa4096 2024-05-29 [SC] 8540A6F18833A80E9C1653A42FD21310B49F6B46 uid nginx signing key <signing-key-2@nginx.com> pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24] 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 uid nginx signing key <signing-key@nginx.com> pub rsa4096 2024-05-29 [SC] 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3 uid nginx signing key <signing-key-3@nginx.com>If the fingerprint is different, remove the file.
Import the key to the rpm database:
sudo rpmkeys --import /tmp/nginx_signing.keyTo install nginx, run the command:
sudo zypper install nginx
NGINX provides packages for the following Alpine Linux operating systems:
| Version | Supported Platforms |
|---|---|
| 3.18 | x86_64, aarch64/arm64 |
| 3.19 | x86_64, aarch64/arm64 |
| 3.20 | x86_64, aarch64/arm64 |
| 3.21 | x86_64, aarch64/arm64 |
The package can be installed from the official repo at nginx.org. You have to set up the apt-get repository the first time, but after that the provided package is always up to date.
Install the prerequisites:
sudo apk add openssl curl ca-certificatesTo set up the apk repository for stable nginx packages, run the command:
printf"%s%s%s\n"\ "http://nginx.org/packages/alpine/v"\ `egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release`\ "/main"\ | sudo tee -a /etc/apk/repositoriesFor mainline nginx packages, run the following command instead:
printf"%s%s%s\n"\ "http://nginx.org/packages/mainline/alpine/v"\ `egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release`\ "/main"\ | sudo tee -a /etc/apk/repositoriesImport an official nginx signing key so apk could verify the packages authenticity. Fetch the key:
curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pubVerify that the downloaded file contains the proper key:
openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -nooutThe output should contain the following modulus:
Public-Key: (2048 bit) Modulus: 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58: 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70: 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1: f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab: 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f: 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64: 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d: 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3: 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c: 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34: 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f: 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17: 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99: 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67: c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e: ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4: 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f: ab:6d Exponent: 65537 (0x10001)Move the key to
apktrusted keys storage:sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/To install nginx, run the command:
sudo apk add nginxThe
@nginxtag should also be specified when installing packages with dynamic modules:sudo apk add nginx-module-image-filter@nginx nginx-module-njs@nginx
NGINX provides packages for
- Amazon Linux 2 (LTS) x86_64, aarch64/arm64
- Amazon Linux 2023 x86_64, aarch64/arm64
Install the prerequisites:
sudo yum install yum-utilsTo set up the
yumrepository for Amazon Linux 2, create the file named/etc/yum.repos.d/nginx.repowith the following contents:[nginx-stable] name=nginx stable repo baseurl=http://nginx.org/packages/amzn2/$releasever/$basearch/ gpgcheck=1 enabled=1 gpgkey=https://nginx.org/keys/nginx_signing.key module_hotfixes=true [nginx-mainline] name=nginx mainline repo baseurl=http://nginx.org/packages/mainline/amzn2/$releasever/$basearch/ gpgcheck=1 enabled=0 gpgkey=https://nginx.org/keys/nginx_signing.key module_hotfixes=trueTo set up the
yumrepository for Amazon Linux 2023, create the file named/etc/yum.repos.d/nginx.repowith the following contents:[nginx-stable] name=nginx stable repo baseurl=http://nginx.org/packages/amzn/2023/$basearch/ gpgcheck=1 enabled=1 gpgkey=https://nginx.org/keys/nginx_signing.key module_hotfixes=true [nginx-mainline] name=nginx mainline repo baseurl=http://nginx.org/packages/mainline/amzn/2023/$basearch/ gpgcheck=1 enabled=0 gpgkey=https://nginx.org/keys/nginx_signing.key module_hotfixes=trueBy default, the repository for
stablenginx packages is used. If you would like to usemainlinenginx packages, run the following command:sudo yum-config-manager --enable nginx-mainlineInstall nginx:
sudo yum install nginxWhen prompted to accept the GPG key, verify that the fingerprint matches:
8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46,573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62,9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3, and if so, accept it.
Compiling NGINX Open Source from source affords more flexibility than prebuilt packages: you can add particular modules (from NGINX or third parties), and apply latest security patches.
Prior to compiling NGINX Open Source from source, you need to install libraries for its dependencies:
PCRE – Supports regular expressions. Required by the NGINX Core and Rewrite modules.
wget github.com/PCRE2Project/pcre2/releases/download/pcre2-10.43/pcre2-10.43.tar.gz tar -zxf pcre2-10.43.tar.gz cd pcre2-10.43 ./configure make sudo make installzlib – Supports header compression. Required by the NGINX Gzip module.
wget http://zlib.net/zlib-1.3.1.tar.gz tar -zxf zlib-1.3.1.tar.gz cd zlib-1.3.1 ./configure make sudo make installOpenSSL – Supports the HTTPS protocol. Required by the NGINX SSL module and others.
wget http://www.openssl.org/source/openssl-3.0.13.tar.gz tar -zxf openssl-3.0.13.tar.gz cd openssl-3.0.13 ./Configure darwin64-x86_64-cc --prefix=/usr make sudo make install
Download the source files for both the stable and mainline versions from nginx.org.
To download and unpack the source for the latest mainline version, run:
wget https://nginx.org/download/nginx-1.27.4.tar.gz tar zxf nginx-1.27.4.tar.gz cd nginx-1.27.4To download and unpack source files for the latest stable version, run:
wget https://nginx.org/download/nginx-1.26.3.tar.gz tar zxf nginx-1.26.3.tar.gz cd nginx-1.26.3Configure options are specified with the ./configure script that sets up various NGINX parameters, including paths to source and configuration files, compiler options, connection processing methods, and the list of modules. The script finishes by creating the Makefile required to compile the code and install NGINX Open Source.
An example of options to the configure script (should be typed as a single line):
./configure --sbin-path=/usr/local/nginx/nginx --conf-path=/usr/local/nginx/nginx.conf --pid-path=/usr/local/nginx/nginx.pid --with-pcre=../pcre2-10.43 --with-zlib=../zlib-1.3.1 --with-http_ssl_module --with-stream --with-mail=dynamic --add-module=/usr/build/nginx-rtmp-module --add-dynamic-module=/usr/build/3party_moduleThe configure script allows you to set paths to NGINX binary and configuration files, and to dependent libraries such as PCRE or SSL, in order to link them statically to the NGINX binary.
| Parameter | Description |
|---|---|
--prefix=<PATH> | Directory for NGINX files, and the base location for all relative paths set by the other configure script options (excluding paths to libraries) and for the path to the nginx.conf configuration file. Default: /usr/local/nginx. |
--sbin-path=<PATH> | Name of the NGINX executable file, which is used only during installation. Default: ** |
--conf-path=<PATH> | Name of the NGINX configuration file. You can, however, always override this value at startup by specifying a different file with the -c <FILENAME> option on the nginx command line. Default: ** |
--pid-path=<PATH> | Name of the nginx.pid file, which stores the process ID of the nginx master process. After installation, the path to the filename can be changed with the pid directive in the NGINX configuration file. Default: ** |
--error-log-path=<PATH> | Name of the primary log file for errors, warnings, and diagnostic data. After installation, the filename can be changed with the error_log directive in the NGINX configuration file. Default: ** |
--http-log-path=<PATH> | Name of the primary log file for requests to the HTTP server. After installation, the filename can always be changed with the access_log directive in the NGINX configuration file. Default: ** |
--user=<NAME> | Name of the unprivileged user whose credentials are used by the NGINX worker processes. After installation, the name can be changed with the user directive in the NGINX configuration file. Default: nobody |
--group=<NAME> | Name of the group whose credentials are used by the NGINX worker processes. After installation, the name can be changed with the user directive in the NGINX configuration file. Default: the value set by the --user option. |
--with-pcre=<PATH> | Path to the source for the PCRE library, which is required for regular expressions support in the location directive and the Rewrite module. |
--with-pcre-jit | Builds the PCRE library with “just-in-time compilation” support (the pcre_jit directive). |
--with-zlib=<PATH> | Path to the source for the zlib library, which is required by the Gzip module. |
With the configure script you can also specify compiler‑related options.
| Parameter | Description |
|---|---|
--with-cc-opt="<PARAMETERS>" | Additional parameters that are added to the CFLAGS variable. When using the system PCRE library under FreeBSD, the mandatory value is --with-cc-opt="-I /usr/local/include". If the number of files supported by select() needs to be increased, it can also specified here as in this example: --with-cc-opt="-D FD_SETSIZE=2048". |
--with-ld-opt="<PARAMETERS>" | Additional parameters that are used during linking. When using the system PCRE library under FreeBSD, the mandatory value is --with-ld-opt="-L /usr/local/lib". |
With the configure script you can redefine the method for event‑based polling. For more information, see Connection processing methods in the NGINX reference documentation.
| Module Name | Description |
|---|---|
--with-select_module, --without-select_module | Enables or disables building a module that enable NGINX to work with the select() method. The modules is built automatically if the platform does not appear to support more appropriate methods such as kqueue, epoll, or /dev/poll. |
--with-poll_module, --without-poll_module | Enables or disables building a module that enables NGINX to work with the poll() method. The module is built automatically if the platform does not appear to support more appropriate methods such as kqueue, epoll, or /dev/poll. |
NGINX consists of a set of function‑specific modules, which are specified with configure script along with other build options.
Some modules are built by default – they do not have to be specified with the configure script. Default modules can however be explicitly excluded from the NGINX binary with the --without-<MODULE-NAME> option on the configure script.
Modules not included by default, as well as third‑party modules, must be explicitly specified in the configure script together with other build options. Such modules can be linked to NGINX binary either statically (they are then loaded each time NGINX starts) or dynamically (they are loaded only if associated directives are included in the NGINX configuration file.
If you do not need a module that is built by default, you can disable it by naming it with the --without-<MODULE-NAME> option on the configure script, as in this example which disables the Empty GIF module (should be typed as a single line):
./configure --sbin-path=/usr/local/nginx/nginx --conf-path=/usr/local/nginx/nginx.conf --pid-path=/usr/local/nginx/nginx.pid --with-http_ssl_module --with-stream --with-pcre=../pcre2-10.43 --with-zlib=../zlib-1.3.1 --without-http_empty_gif_module| Module Name | Description |
|---|---|
| http_access_module | Accepts or denies requests from specified client addresses. |
| http_auth_basic_module | Limits access to resources by validating the user name and password using the HTTP Basic Authentication protocol. |
| http_autoindex_module | Processes requests ending with the forward-slash character (/) and produces a directory listing. |
| http_browser_module | Creates variables whose values depend on the value of the User-Agent request header. |
| http_charset_module | Adds the specified character set to the Content-Type response header. Can convert data from one character set to another. |
| http_empty_gif_module | Emits a single-pixel transparent GIF. |
| http_fastcgi_module | Passes requests to a FastCGI server. |
| http_geo_module | Creates variables with values that depend on the client IP address. |
| http_gzip_module | Compresses responses using gzip, reducing the amount of transmitted data by half or more. |
| http_limit_conn_module | Limits the number of connections per a defined key, in particular, the number of connections from a single IP address. |
| http_limit_req_module | Limits the request processing rate per a defined key, in particular, the processing rate of requests coming from a single IP address. |
| http_map_module | Creates variables whose values depend on the values of other variables. |
| http_memcached_module | Passes requests to a memcached server. |
| http_proxy_module | Passes HTTP requests to another server. |
| http_referer_module | Blocks requests with invalid values in the Referer header. |
| http_rewrite_module | Changes the request URI using regular expressions and return redirects; conditionally selects configurations. Requires the PCRE library. |
| http_scgi_module | Passes requests to an SCGI server. |
| http_ssi_module | Processes SSI (Server Side Includes) commands in responses passing through it. |
| http_split_clients_module | Creates variables suitable for A/B testing, also known as split testing. |
| http_upstream_hash_module | Enables the generic Hash load-balancing method. |
| http_upstream_ip_hash_module | Enables the IP Hash load-balancing method. |
| http_upstream_keepalive_module | Enables keepalive connections. |
| http_upstream_least_conn_module | Enables the Least Connections load-balancing method. |
| http_upstream_zone_module | Enables shared memory zones. |
| http_userid_module | Sets cookies suitable for client identification. |
| http_uwsgi_module | Passes requests to a uwsgi server. |
Many NGINX modules are not built by default, and must be listed on the configure command line to be built.
The mail, stream, geoip, image_filter, perl and xslt modules can be compiled as dynamic. See Dynamic Modules for details.
An example of the configure command that includes nondefault modules (should be typed as a single line):
./configure --sbin-path=/usr/local/nginx/nginx --conf-path=/usr/local/nginx/nginx.conf --pid-path=/usr/local/nginx/nginx.pid --with-pcre=../pcre2-10.43 --with-zlib=../zlib-1.3.1 --with-http_ssl_module --with-stream --with-mail| Module Name | Description |
|---|
--with-cpp_test_module- Tests the C++ compatibility of header files.
--with-debug- Enables the debugging log.
--with-file-aioEnables asynchronous I/O.
Allows using Google Performance tools library.
--with-http_addition_module- Adds text before and after a response.
--with-http_auth_request_module- Implements client authorization based on the result of a subrequest.
--with-http_dav_module- Enables file management automation using the WebDAV protocol.
--with-http_degradation_module- Allows returning an error when a memory size exceeds the defined value.
--with-http_flv_module- Provides pseudo-streaming server-side support for Flash Video (FLV) files.
--with-http_geoip_module- Enables creating variables whose values depend on the client IP address. The module uses MaxMind GeoIP databases. To compile as a separate dynamic module instead, change the option to
--with-http_geoip_module=dynamic.
--with-http_gunzip_module- Decompresses responses with
Content-Encoding: gzipfor clients that do not support the zip encoding method.
--with-http_gzip_static_module- Allows sending precompressed files with the .gz filename extension instead of regular files.
--with-http_image_filter_module- Transforms images in JPEG, GIF, and PNG formats. The module requires the LibGD library. To compile as a separate dynamic module instead, change the option to
--with-http_image_filter_module=dynamic.
--with-http_mp4_module- Provides pseudo-streaming server-side support for MP4 files.
--with-http_perl_module- Used to implement location and variable handlers in Perl and insert Perl calls into SSI. Requires the PERL library. To compile as a separate dynamic module instead, change the option to
--with-http_perl_module=dynamic.
--with-http_random_index_module- Processes requests ending with the slash character (‘/’) and picks a random file in a directory to serve as an index file.
--with-http_realip_module- Changes the client address to the one sent in the specified header field.
--with-http_secure_link_module- Used to check authenticity of requested links, protect resources from unauthorized access, and limit link lifetime.
--with-http_slice_module- Allows splitting a request into subrequests, each subrequest returns a certain range of response. Provides more effective caching of large files.
--with-http_ssl_module- Enables HTTPS support. Requires an SSL library such as OpenSSL.
--with-http_stub_status_module- Provides access to basic status information. Note that NGINX Plus customers do not require this module as they are already provided with extended status metrics and interactive dashboard.
--with-http_sub_module- Modifies a response by replacing one specified string by another.
--with-http_xslt_module- Transforms XML responses using one or more XSLT stylesheets. The module requires the Libxml2 and XSLT libraries. To compile as a separate dynamic module instead, change the option to
--with-http_xslt_module=dynamic.
--with-http_v2_module- Enable support for HTTP/2. See The HTTP/2 Module in NGINX on the NGINX blog for details.
--with-mail- Enables mail proxy functionality. To compile as a separate dynamic module instead, change the option to
--with-mail=dynamic.
--with-mail_ssl_module- Provides support for a mail proxy server to work with the SSL/TLS protocol. Requires an SSL library such as OpenSSL.
--with-stream- Enables the TCP and UDP proxy functionality. To compile as a separate dynamic module instead, change the option to
--with-stream=dynamic.
--with-stream_ssl_module- Provides support for a stream proxy server to work with the SSL/TLS protocol. Requires an SSL library such as OpenSSL.
--with-threads- Enables NGINX to use thread pools. For details, see Thread Pools in NGINX Boost Performance 9x! on the NGINX blog.
You can extend NGINX functionality by compiling NGINX Open Source with your own module or a third‑party module. Some third‑party modules are listed in the NGINX Wiki. Use third‑party modules at your own risk as their stability is not guaranteed.
Most modules built into NGINX Open Source are statically linked: they are built into NGINX Open Source at compile time and are linked to the NGINX binary statically. These modules can be disabled only by recompiling NGINX.
To compile NGINX Open Source with a statically linked third‑party module, include the --add-module=<PATH> option on the configure command, where <PATH> is the path to the source code (this example is for the RTMP module):
./configure ... --add-module=/usr/build/nginx-rtmp-moduleNGINX modules can also be compiled as a shared object (*.so file) and then dynamically loaded into NGINX Open Source at runtime. This provides more flexibility, as the module can be loaded or unloaded at any time by adding or removing the associated load_module directive in the NGINX configuration file and reloading the configuration. Note that the module itself must support dynamic linking.
To compile NGINX Open Source with a dynamically loaded third‑party module, include the --add-dynamic-module=<PATH> option on the configure command, where <PATH> is the path to the source code:
./configure ... --add-dynamic-module=<PATH>The resulting *.so files are written to the prefix/modules/ directory, where the prefix is a directory for server files such as /usr/local/nginx/.
To load a dynamic module, add the load_module directive to the NGINX configuration after installation:
load_modulemodules/ngx_mail_module.so;For more information, see Compiling Third‑Party Dynamic Modules for NGINX and NGINX Plus on the NGINX blog and Extending NGINX in the Wiki.
Compile and install the build:
make sudo make installAfter the installation is finished, start NGINX Open Source:
sudo nginx
