Installing NGINX Open Source

Installing a Prebuilt CentOS/RHEL Package from an OS Repository

1. Install the EPEL repository:

   $ sudo yum install epel-release
   

2. Update the repository:

   $ sudo yum update
   

3. Install NGINX Open Source:

   $ sudo yum install nginx
   

4. Verify the installation:

   $ sudo nginx -v
   nginx version: nginx/1.6.3
   

Installing a Prebuilt CentOS/RHEL Package from the Official NGINX Repository

1. Set up the yum repository for RHEL or CentOS by creating the file nginx.repo in /etc/yum.repos.d, for example using vi:

   $ sudo vi /etc/yum.repos.d/nginx.repo
   

2. Add the following lines to nginx.repo:

   [nginx]
   name=nginx repo
   baseurl=https://nginx.org/packages/mainline/<OS>/<OSRELEASE>/$basearch/
   gpgcheck=0
   enabled=1
   

   where:

   • The /mainline element in the pathname points to the latest mainline version of NGINX Open Source; delete it to get the latest stable version

   • <OS> is either rhel or centos

   • <OSRELEASE> is the release number (6, 6._x_, 7, 7._x_ and so on)

     For example, to get the latest mainline package for CentOS 7, insert:

     [nginx]
     name=nginx repo
     baseurl=https://nginx.org/packages/mainline/centos/7/$basearch/
     gpgcheck=0
     enabled=1
     

3. Save the changes and quit vi (press ESC and type wq at the : prompt).

4. Update the repository:

   $ sudo yum update
   

5. Install the NGINX Open Source package:

   $ sudo yum install nginx
   

1. Start NGINX Open Source:

   $ sudo nginx
   

2. Verify that NGINX Open Source is up and running:

   $ curl -I 127.0.0.1
   HTTP/1.1 200 OK
   Server: nginx/1.13.8
   

Installing a Prebuilt Debian Package from an OS Repository

1. Update the Debian repository information:

   $ sudo apt-get update
   

2. Install the NGINX Open Source package:

   $ sudo apt-get install nginx
   

3. Verify the installation:

   $ sudo nginx -v
   nginx version: nginx/1.6.2
   

Installing a Prebuilt Debian Package from the Official NGINX Repository

1. Download the key used to sign NGINX packages and the repository, and add it to the apt program’s key ring:

   $ sudo wget https://nginx.org/keys/nginx_signing.key
   $ sudo apt-key add nginx_signing.key
   

2. Edit the /etc/apt/sources.list file, for example with vi:

   $ sudo vi /etc/apt/sources.list
   

3. Add these lines to sources.list to name the repositories from which the NGINX Open Source can be obtained:

   deb https://nginx.org/packages/mainline/debian/ <CODENAME> nginx
   deb-src https://nginx.org/packages/mainline/debian/ <CODENAME> nginx
   

   where:

   • The /mainline element in the pathname points to the latest mainline version of NGINX Open Source; delete it to get the latest stable version

   • <CODENAME> is the codename of a Debian release

     For example, to get the latest mainline package for Debian 8.2 (“jessie”), insert:

     deb https://nginx.org/packages/mainline/debian/ jessie nginx
     deb-src https://nginx.org/packages/mainline/debian/ jessie nginx
     

4. Save the changes and quit vi (press ESC and type wq at the : prompt).

5. Install the NGINX package:

   $ sudo apt-get remove nginx-common
   $ sudo apt-get update
   $ sudo apt-get install nginx
   

6. Start NGINX Open Source:

   $ sudo nginx
   

7. Verify that NGINX Open Source is up and running:

   $ curl -I 127.0.0.1
   HTTP/1.1 200 OK
   Server: nginx/1.13.8
   

Installing a Prebuilt Ubuntu Package from an Ubuntu Repository

1. Update the Ubuntu repository information:

   $ sudo apt-get update
   

2. Install the package:

   $ sudo apt-get install nginx
   

3. Verify the installation:

   $ sudo nginx -v
   nginx version: nginx/1.4.6 (Ubuntu)
   

Installing a Prebuilt Ubuntu Package from the Official NGINX Repository

1. Download the key used to sign NGINX packages and the repository, and add it to the apt program’s key ring:

   $ sudo wget https://nginx.org/keys/nginx_signing.key
   $ sudo apt-key add nginx_signing.key
   

2. Edit the /etc/apt/sources.list file, for example with vi:

   $ sudo vi /etc/apt/sources.list
   

3. Add these lines sources.list to name the repositories from which the NGINX Open Source source can be obtained:

   deb https://nginx.org/packages/mainline/ubuntu/ <CODENAME> nginx
   deb-src https://nginx.org/packages/mainline/ubuntu/ <CODENAME> nginx
   

   where:

   • The /mainline element in the pathname points to the latest mainline version of NGINX Open Source; delete it to get the latest stable version
   • <CODENAME> is the codename of an Ubuntu release

   For example, to get the latest mainline package for Ubuntu 14.04 (“trusty”), add:

   deb https://nginx.org/packages/mainline/ubuntu/ trusty nginx
   deb-src https://nginx.org/packages/mainline/ubuntu/ trusty nginx
   

4. Save the changes and quit vi (press ESC and type wq at the : prompt).

5. Install NGINX Open Source:

   $ sudo apt-get remove nginx-common
   $ sudo apt-get update
   $ sudo apt-get install nginx
   

6. Start NGINX Open Source:

   $ sudo nginx
   

7. Verify that NGINX Open Source is up and running:

   $ curl -I 127.0.0.1
   HTTP/1.1 200 OK
   Server: nginx/1.13.8
   

Configuring NGINX Paths

The 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.

Configuring NGINX GCC Options

With the configure script you can also specify compiler‑related options.

Specifying NGINX Connection Processing Methods

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.

Selecting the NGINX Modules to Build

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.

Modules Built by Default

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=../pcre-8.42
--with-zlib=../zlib-1.2.11
--without-http_empty_gif_module

Including Modules Not Built by Default

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=../pcre-8.42
--with-zlib=../zlib-1.2.11
--with-http_ssl_module
--with-stream
--with-mail

Including Third-Party Modules

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.

$  ./configure ... --add-module=/usr/build/nginx-rtmp-module

$  ./configure ... --add-dynamic-module=<PATH>

load_module modules/ngx_mail_module.so;