nginx-binaries/README.md

A downloader for nginx and njs standalone binaries.

This project provides standalone nginx and njs (NGINX JavaScript) binaries for **any** Linux system [^1] (x86_64, aarch64, ppc64le), macOS (x86_64), and Windows (x86_64).
It also provides a JS library for downloading these binaries (for use in integration tests).

## Installation

``` sh
# using npm:
npm install --save-dev nginx-binaries
# or using yarn:
yarn add --dev nginx-binaries
```

## Usage Example

``` js
import { NginxBinary, NjsBinary } from 'nginx-binaries'

await NginxBinary.versions({ version: '^1.21.5' })
// => ['1.21.5', '1.21.6', '1.22.0']

await NginxBinary.download({ version: '1.22.x' })
// => '[...]/node_modules/.cache/nginx-binaries/nginx-1.22.0-x86_64-linux'

await NjsBinary.versions({ version: '^0.7.0' })
// => ['0.7.1', '0.7.2', '0.7.3', '0.7.4']

await NjsBinary.download({ version: '^0.7.0', variant: 'debug' }, '.tmp/njs')
// => '.tmp/njs'
```

## API

[See on GitHub](https://github.com/jirutka/nginx-binaries#api).

[^1]: nginx binaries are built as standalone static executables, so they works on every Linux system regardless of used libc.