NGINX

https://nginx.org/
Admin
NGINX is an HTTP web server, reverse proxy, content cache, load balancer, TCP/UDP proxy server, and...
Tokens:642,090
Snippets:7,108
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install prerequisites on Ubuntu

Source: https://nginx.org/en/linux_packages.html

Installs the required packages for managing repositories and keys on Ubuntu.

```shell
sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring

```

--------------------------------

### Configure nginx build parameters with ./configure

Source: https://nginx.org/en/docs/configure.html

Example invocation of the configure script with custom paths, SSL support, and third-party library locations. All parameters must be entered on a single line. Following configuration, compile and install nginx using make.

```sh
./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-pcre=../pcre2-10.39
    --with-zlib=../zlib-1.3

```

--------------------------------

### Initialize project and install browserify

Source: https://nginx.org/en/docs/njs/node_modules.html

Sets up an empty project directory with a initial package.json and installs browserify for bundling Node.js dependencies.

```shell
$ mkdir my_project && cd my_project
$ npx license choose_your_license_here > LICENSE
$ npx gitignore node

$ cat > package.json <<EOF
{
  "name":        "foobar",
  "version":     "0.0.1",
  "description": "",
  "main":        "index.js",
  "keywords":    [],
  "author":      "somename <some.email@example.com> (https://example.com)",
  "license":     "some_license_here",
  "private":     true,
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}
EOF
$ npm init -y
$ npm install browserify

```

--------------------------------

### Install prerequisites for Debian

Source: https://nginx.org/en/linux_packages.html

Installs required tools and keyring utilities needed to authenticate and manage APT repositories.

```shell
sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring
```

--------------------------------

### Install NGINX on Ubuntu

Source: https://nginx.org/en/linux_packages.html

Updates APT package lists and installs NGINX.

```shell
sudo apt update
sudo apt install nginx

```

--------------------------------

### Install protobufjs and generate static module with pbjs

Source: https://nginx.org/en/docs/njs/node_modules.html

Installs protobufjs and compiles helloworld.proto into static JavaScript code. Static mode is used because njs does not support dynamic function generation.

```shell
$ npm install protobufjs
$ npx pbjs -t static-module helloworld.proto > static.js

```

--------------------------------

### Install NGINX on SLES

Source: https://nginx.org/en/linux_packages.html

Installs the NGINX package using zypper.

```shell
sudo zypper install nginx

```

--------------------------------

### Configure multi-level fastcgi_temp_path hierarchy and path example

Source: https://nginx.org/en/docs/http/ngx_http_fastcgi_module.html

Defines a directory with a multi-level subdirectory hierarchy underneath the specified directory along with an example resulting file path.

```nginx
fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2;

```

```text
/spool/nginx/fastcgi_temp/7/45/00000123457

```

--------------------------------

### Install NGINX package using yum

Source: https://nginx.org/en/linux_packages.html

Installs NGINX from the configured repository. Verify that the imported GPG key fingerprint matches 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62 when prompted.

```shell
sudo yum install nginx
```

--------------------------------

### Install required npm packages

Source: https://nginx.org/en/docs/njs/node_modules.html

Install Babel, Webpack, and the target libraries (buffer and dns-packet) needed for transpiling and packaging code for njs.

```shell
$ npm install @babel/core @babel/cli @babel/preset-env babel-loader
$ npm install webpack webpack-cli
$ npm install buffer
$ npm install dns-packet

```

--------------------------------

### console.time(label)

Source: https://nginx.org/ru/docs/njs/reference.html

Starts a timer identified by the specified label to measure elapsed operation time.

```APIDOC
### Method Signature
`console.time(label)`

### Description
Starts a timer that can track how long an operation takes. The `label` parameter allows naming different timers. If `console.timeEnd()` with the same name is called, the time that elapsed since the timer was started will be output in milliseconds.

### Parameters
- **label** (string) - Unique identifier for the timer.
```

--------------------------------

### Format function definitions and spacing

Source: https://nginx.org/ru/docs/dev/development_guide.html

Function names start on a new line in definitions, opening and closing braces go on separate lines, function bodies are indented, and two empty lines separate functions.

```c
static ngx_int_t
gx_http_find_virtual_server(ngx_http_request_t *r, u_char *host, size_t len)
{
    ...
}


static ngx_int_t
gx_http_add_addresses(ngx_conf_t *cf, ngx_http_core_srv_conf_t *cscf,
    ngx_http_conf_port_t *port, ngx_http_listen_opt_t *lsopt)
{
    ...
}

```

--------------------------------

### Example HLS playlist and fragment request URIs

Source: https://nginx.org/en/docs/http/ngx_http_hls_module.html

Illustrates valid HLS playlist (.m3u8) and fragment (.ts) request URIs with time offset, start, end, and fragment length query arguments.

```http
http://hls.example.com/test.mp4.m3u8?offset=1.000&start=1.000&end=2.200
http://hls.example.com/test.mp4.m3u8?len=8.000
http://hls.example.com/test.mp4.ts?start=1.000&end=2.200
```

--------------------------------

### Configure NGINX with QuickJS engine support

Source: https://nginx.org/en/docs/njs/install.html

Passes the include and library paths for QuickJS to ./configure via --with-cc-opt and --with-ld-opt parameters.

```shell
./configure --add-module=_path-to-njs_/nginx \
    --with-cc-opt="-I _path-to-quickjs_" \
    --with-ld-opt="-L _path-to-quickjs_"

```

--------------------------------

### Define entry point in load.js

Source: https://nginx.org/en/docs/njs/node_modules.html

Exposes `dns-packet` and `buffer` to the global namespace for bundling.

```javascript
global.dns = require('dns-packet')
global.Buffer = require('buffer/').Buffer

```

--------------------------------

### Implement an NGINX Core Module in ngx_foo_module

Source: https://nginx.org/en/docs/dev/development_guide.html

Demonstrates an example core module implementation containing configuration allocation, default value initialization, directive definition, and post-handler logic.

```c
/*
 * Copyright (C) Author.
 */


#include <ngx_config.h>
#include <ngx_core.h>


typedef struct {
    ngx_flag_t  enable;
} ngx_foo_conf_t;


static void *ngx_foo_create_conf(ngx_cycle_t *cycle);
static char *ngx_foo_init_conf(ngx_cycle_t *cycle, void *conf);

static char *ngx_foo_enable(ngx_conf_t *cf, void *post, void *data);
static ngx_conf_post_t  ngx_foo_enable_post = { ngx_foo_enable };


static ngx_command_t  ngx_foo_commands[] = {

    { ngx_string("foo_enabled"),
      NGX_MAIN_CONF|NGX_DIRECT_CONF|NGX_CONF_FLAG,
      ngx_conf_set_flag_slot,
      0,
      offsetof(ngx_foo_conf_t, enable),
      &ngx_foo_enable_post },

      ngx_null_command
};


static ngx_core_module_t  ngx_foo_module_ctx = {
    ngx_string("foo"),
    ngx_foo_create_conf,
    ngx_foo_init_conf
};


gx_module_t  ngx_foo_module = {
    NGX_MODULE_V1,
    &ngx_foo_module_ctx,                   /* module context */
    ngx_foo_commands,                      /* module directives */
    NGX_CORE_MODULE,                       /* module type */
    NULL,                                  /* init master */
    NULL,                                  /* init module */
    NULL,                                  /* init process */
    NULL,                                  /* init thread */
    NULL,                                  /* exit thread */
    NULL,                                  /* exit process */
    NULL,                                  /* exit master */
    NGX_MODULE_V1_PADDING
};


static void *
gx_foo_create_conf(ngx_cycle_t *cycle)
{
    ngx_foo_conf_t  *fcf;

    fcf = ngx_pcalloc(cycle->pool, sizeof(ngx_foo_conf_t));
    if (fcf == NULL) {
        return NULL;
    }

    fcf->enable = NGX_CONF_UNSET;

    return fcf;
}


static char *
gx_foo_init_conf(ngx_cycle_t *cycle, void *conf)
{
    ngx_foo_conf_t *fcf = conf;

    ngx_conf_init_value(fcf->enable, 0);

    return NGX_CONF_OK;
}


static char *
gx_foo_enable(ngx_conf_t *cf, void *post, void *data)
{
    ngx_flag_t  *fp = data;

    if (*fp == 0) {
        return NGX_CONF_OK;
    }

    ngx_log_error(NGX_LOG_NOTICE, cf->log, 0, "Foo Module is enabled");

    return NGX_CONF_OK;
}
```

--------------------------------

### Set up mainline NGINX APT repository on Ubuntu

Source: https://nginx.org/en/linux_packages.html

Adds the APT source configuration for official mainline NGINX packages.

```shell
echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
https://nginx.org/packages/mainline/ubuntu `lsb_release -cs` nginx" \
    | sudo tee /etc/apt/sources.list.d/nginx.list

```

--------------------------------

### buf.slice([start[, end]])

Source: https://nginx.org/en/docs/njs/reference.html

Returns a new buffer slice referencing the same memory, cropped by the start and end indices.

```APIDOC
### Method Signature
`buf.slice([start[, end]])`

### Description
Returns a new `buf` that references the same memory as the original, but offset and cropped by the `start` and `end` values. Not compatible with `Uint8Array.prototype.slice()`. To copy the slice, use `Uint8Array.prototype.slice()`.

### Parameters
- **start** (number, optional) - Index where the slice starts.
- **end** (number, optional) - Index where the slice ends.
```

--------------------------------

### Install prerequisites on SLES

Source: https://nginx.org/en/linux_packages.html

Installs the required tools for managing repositories and GPG keys on SUSE Linux Enterprise Server.

```shell
sudo zypper install curl ca-certificates gpg2

```

--------------------------------

### Create initial library bundle using Browserify

Source: https://nginx.org/en/docs/njs/node_modules.html

Bundles `load.js` and dependencies into a single `bundle.js` file before transpilation.

```shell
$ npx browserify load.js -o bundle.js -d

```

--------------------------------

### Installing TypeScript globally with npm

Source: https://nginx.org/en/docs/njs/typescript.html

Install the TypeScript compiler globally using npm prior to compiling TypeScript files.

```shell
# npm install -g typescript

```

--------------------------------

### Unpack and start nginx on Windows

Source: https://nginx.org/en/docs/windows.html

Unpacks the downloaded nginx distribution in the drive C: root directory and launches the nginx background process.

```cmd
cd c:\
unzip nginx-1.31.6.zip
cd nginx-1.31.6
start nginx

```

--------------------------------

### buf.subarray([start[, end]])

Source: https://nginx.org/en/docs/njs/reference.html

Returns a new buffer referencing the same memory as the original, offset and cropped by start and end indices.

```APIDOC
### Method Signature
`buf.subarray([start[, end]])`

### Description
Returns a new `buf` that references the same memory as the original, but offset and cropped by `start` and `end`. If `end` is greater than `buf.length`, the result is the same as if `end` equaled `buf.length`.

### Parameters
- **start** (number, optional) - Index where the subarray starts.
- **end** (number, optional) - Index where the subarray ends.
```

--------------------------------

### Set up APT repository pinning for NGINX packages

Source: https://nginx.org/en/linux_packages.html

Creates /etc/apt/preferences.d/99nginx to prioritize official nginx.org packages over distribution-provided versions.

```shell
echo -e "Package: *\nPin: origin nginx.org\nPin: release o=nginx\nPin-Priority: 900\n" \
    | sudo tee /etc/apt/preferences.d/99nginx
```

--------------------------------

### Update APT cache and install NGINX on Debian

Source: https://nginx.org/en/linux_packages.html

Refreshes package lists from the newly configured repository and installs the NGINX package.

```shell
sudo apt update
sudo apt install nginx
```

--------------------------------

### Create build directories and unpack third-party libraries

Source: https://nginx.org/en/docs/howto_build_on_win32.html

Creates the `objs/lib` directory structure and extracts the source tarballs for PCRE, zlib, and OpenSSL.

```shell
mkdir objs
mkdir objs/lib
cd objs/lib
tar -xzf ../../pcre2-10.39.tar.gz
tar -xzf ../../zlib-1.3.1.tar.gz
tar -xzf ../../openssl-3.0.14.tar.gz

```

--------------------------------

### Install yum-utils prerequisites on RHEL and derivatives

Source: https://nginx.org/en/linux_packages.html

Install required package management utilities on RHEL, CentOS, Oracle Linux, Rocky Linux, or AlmaLinux prior to repository configuration.

```shell
sudo yum install yum-utils
```

--------------------------------

### Set up stable NGINX APT repository on Ubuntu

Source: https://nginx.org/en/linux_packages.html

Adds the APT source configuration for official stable NGINX packages.

```shell
echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
https://nginx.org/packages/ubuntu `lsb_release -cs` nginx" \
    | sudo tee /etc/apt/sources.list.d/nginx.list

```

--------------------------------

### Enable basic asynchronous file I/O

Source: https://nginx.org/en/docs/http/ngx_http_core_module.html

Enables AIO on FreeBSD and Linux with custom output buffer allocation.

```nginx
location /video/ {
    aio            on;
    output_buffers 1 64k;
}

```

--------------------------------

### Configure request rate limiting example

Source: https://nginx.org/en/docs/http/ngx_http_limit_req_module.html

Demonstrates setting up a shared memory zone with limit_req_zone and applying a rate limit with a burst size in a location block.

```nginx
http {
    limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

    ...

    server {

        ...

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

```

--------------------------------

### GET /license

Source: https://nginx.org/ru/docs/http/ngx_http_api_module.html

Retrieves current license information.

```APIDOC
## GET /license

### Description
Return license info.

### Method
GET

### Endpoint
/license

### Response
#### Success Response (200)
- Returns License

#### Error Responses
- **404** - Unknown version (`UnknownVersion`), returns Error
```

--------------------------------

### GET /connections

Source: https://nginx.org/en/docs/http/ngx_http_api_module.html

Retrieves statistics on client connections.

```APIDOC
## GET /connections

### Description
Returns statistics of client connections.

### Method
GET

### Endpoint
/connections

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Limits which fields of the connections statistics will be output.

### Response
#### Success Response (200)
- Returns Connections object.

#### Error Responses
- **404** - Unknown version (`UnknownVersion`), returns Error
```

--------------------------------

### mkdirSync(path[, options])

Source: https://nginx.org/en/docs/njs/reference.html

Synchronously creates a directory at the specified path.

```APIDOC
## mkdirSync(path[, options])

### Description
Synchronously creates a directory at the specified `path` (0.4.2).

### Parameters
- **path** (string) - Path of the directory to create
- **options** (integer | Object) - Optional mode integer or an options object
  - **mode** (number) - Mode option, by default is `0o777`

### Returns
`undefined`
```

--------------------------------

### GET /stream/zone_sync/

Source: https://nginx.org/en/docs/http/ngx_http_api_module.html

Returns the cluster synchronization status for a node.

```APIDOC
## GET /stream/zone_sync/

### Description
Returns synchronization status of a cluster node.

### Method
GET

### Endpoint
`/stream/zone_sync/`

### Response
#### Success Response (200)
- Returns Stream Zone Sync Node

#### Error Response (404)
- Unknown version (`UnknownVersion`)
```

--------------------------------

### Configure nginx build with auto/configure for Visual C

Source: https://nginx.org/en/docs/howto_build_on_win32.html

Runs the configure script specifying the Visual C compiler (`cl`), target paths, library locations, and SSL module options.

```shell
auto/configure \
    --with-cc=cl \
    --with-debug \
    --prefix= \
    --conf-path=conf/nginx.conf \
    --pid-path=logs/nginx.pid \
    --http-log-path=logs/access.log \
    --error-log-path=logs/error.log \
    --sbin-path=nginx.exe \
    --http-client-body-temp-path=temp/client_body_temp \
    --http-proxy-temp-path=temp/proxy_temp \
    --http-fastcgi-temp-path=temp/fastcgi_temp \
    --http-scgi-temp-path=temp/scgi_temp \
    --http-uwsgi-temp-path=temp/uwsgi_temp \
    --with-cc-opt=-DFD_SETSIZE=1024 \
    --with-pcre=objs/lib/pcre2-10.39 \
    --with-zlib=objs/lib/zlib-1.3.1 \
    --with-openssl=objs/lib/openssl-3.0.14 \
    --with-openssl-opt=no-asm \
    --with-http_ssl_module

```
Tokens:
Raw