GitHub - nginx/nginx: The official NGINX Open Source repository. · GitHub
Skip to content You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Branches Tags Open more actions menu Latest commit History 8,807 Commits 8,807 Commits Folders and files Name Name Last commit message Last commit date .github .github auto auto conf conf contrib contrib docs docs misc misc src src .gitignore .gitignore CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md CONTRIBUTING.md CONTRIBUTING.md LICENSE LICENSE README.md README.md SECURITY.md SECURITY.md SUPPORT.md SUPPORT.md Repository files navigation NGINX (pronounced "engine x" or "en-jin-eks") is the world's most popular Web Server, high performance Load Balancer, Reverse Proxy, API Gateway and Content Cache.
NGINX is free and open source software, distributed under the terms of a simplified 2-clause BSD-like license . Enterprise distributions, commercial support and training are available from F5, Inc . Important The goal of this README is to provide a basic, structured introduction to NGINX for novice users. Please refer to the full NGINX documentation for detailed information on installing , building , configuring , debugging , and more.
These documentation pages also contain a more detailed Beginners Guide , How-Tos, Development guide , and a complete module and directive reference . Table of contents How it works Modules Configurations Runtime Downloading and installing Stable and Mainline binaries Linux binary installation process FreeBSD installation process Windows executables Dynamic modules Getting started with NGINX Installing SSL certificates and enabling TLS encryption Load Balancing Rate limiting Content caching Building from source Installing dependencies Cloning the NGINX GitHub repository Configuring the build Compiling Location of binary and installation Running and testing the installed binary Asking questions and reporting issues Contributing code Additional help and resources Changelog License How it works NGINX is installed software with binary packages available for all major operating systems and Linux distributions.
See Tested OS and Platforms for a full list of compatible systems. Important While nearly all popular Linux-based operating systems are distributed with a community version of nginx, we highly advise installation and usage of official packages or sources from this repository. Doing so ensures that you're using the most recent release or source code, including the latest feature-set, fixes and security patches. Modules NGINX is comprised of individual modules, each extending core functionality by providing additional, configurable features.
See "Modules reference" at the bottom of nginx documentation for a complete list of official modules. NGINX modules can be built and distributed as static or dynamic modules. Static modules are defined at build-time, compiled, and distributed in the resulting binaries. See Dynamic Modules for more information on how they work, as well as, how to obtain, install, and configure them. Tip You can issue the following command to see which static modules your NGINX binaries were built with: nginx -V See Configuring the build for information on how to include specific Static modules into your nginx build.
Configurations NGINX is highly flexible and configurable. Provisioning the software is achieved via text-based config file(s) accepting parameters called " Directives ". See Configuration File's Structure for a comprehensive description of how NGINX configuration files work. Note The set of directives available to your distribution of NGINX is dependent on which modules have been made available to it. Runtime Rather than running in a single, monolithic process, NGINX is architected to scale beyond Operating System process limitations by operating as a collection of processes.
They include: A "master" process that maintains worker processes, as well as, reads and evaluates configuration files. One or more "worker" processes that process data (eg. HTTP requests). The number of worker processes is defined in the configuration file and may be fixed for a given configuration or automatically adjusted to the number of available CPU cores. In most cases, the latter option optimally balances load across available system resources, as NGINX is designed to efficiently distribute work across all worker processes.
Tip Processes synchronize data through shared memory. For this reason, many NGINX directives require the allocation of shared memory zones. As an example, when configuring rate limiting , connecting clients may need to be tracked in a common memory zone so all worker processes can know how many times a particular client has accessed the server in a span of time. Downloading and installing Follow these steps to download and install precompiled NGINX binaries.
You may also choose to build NGINX locally from source code . Stable and Mainline binaries NGINX binaries are built and distributed in two versions: stable and mainline. Stable binaries are built from stable branches and only contain critical fixes backported from the mainline version. Mainline binaries are built from the master branch and contain the latest features and bugfixes. You'll need to decide which is appropriate for your purposes .
Linux binary installation process The NGINX binary installation process takes advantage of package managers native to specific Linux distributions. For this reason, first-time installations involve adding the official NGINX package repository to your system's package manager. Follow these steps to download, verify, and install NGINX binaries using the package manager appropriate for your Linux distribution. Upgrades Future upgrades to the latest version can be managed using the same package manager without the need to manually download and verify binaries.
FreeBSD installation process For more information on installing NGINX on FreeBSD system, visit https://nginx.org/en/docs/install.html Windows executables Windows executables for mainline and stable releases can be found on the main NGINX download page . Note that the current implementation of NGINX for Windows is at the Proof-of-Concept stage and should only be used for development and testing purposes. For additional information, please see nginx for Windows .
Dynamic modules NGINX version 1.9.11 added support for Dynamic Modules . Unlike Static modules, dynamically built modules can be downloaded, installed, and configured after the core NGINX binaries have been built. Official dynamic module binaries are available from the same package repository as the core NGINX binaries described in previous steps. Tip NGINX JavaScript (njs) , is a popular NGINX dynamic module that enables the extension of core NGINX functionality using familiar JavaScript syntax.
Important If desired, dynamic modules can also be built statically into NGINX at compile time. Getting started with NGINX For a gentle introduction to NGINX basics, please see our Beginner’s Guide . Installing SSL certificates and enabling TLS encryption See Configuring HTTPS servers for a quick guide on how to enable secure traffic to your NGINX installation. Load Balancing For a quick start guide on configuring NGINX as a Load Balancer, please see Using nginx as HTTP load balancer .
Rate limiting See our Rate Limiting with NGINX blog post for an overview of core concepts for provisioning NGINX as an API Gateway. Content caching See A Guide to Caching with NGINX and NGINX Plus blog post for an overview of how to use NGINX as a content cache (e.g. edge server of a content delivery network). Building from source The following steps can be used to build NGINX from source code available in this repository.
Installing dependencies Most Linux distributions will require several dependencies to be installed in order to build NGINX. The following instructions are
The rest of this page is on the live site.