# smartnginx

> control nginx from node, TypeScript ready

Latest version **1.0.6** (published 2016-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install smartnginx
pnpm add smartnginx
yarn add smartnginx
bun add smartnginx
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2016-08-03 |
| First published | 2016-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Lossless GmbH |
| Maintainers | lossless |
| Keywords | nginx |

## Links

- npm: https://www.npmjs.com/package/smartnginx
- Repository: https://gitlab.com/pushrocks/smartnginx
- Homepage: https://gitlab.com/pushrocks/smartnginx#README
- Issues: https://gitlab.com/pushrocks/smartnginx/issues
- npm.io page: https://npm.io/package/smartnginx

## Dependencies (8)

- [q](https://npm.io/package/q.md) ^1.4.1
- [cert](https://npm.io/package/cert.md) ^1.0.7
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.3
- [@types/q](https://npm.io/package/@types/q.md) 0.x.x
- [beautylog](https://npm.io/package/beautylog.md) ^5.0.20
- [smartfile](https://npm.io/package/smartfile.md) ^4.0.13
- [smartstring](https://npm.io/package/smartstring.md) ^2.0.15
- [@types/shelljs](https://npm.io/package/@types/shelljs.md) 0.x.x

## Recent versions

- 1.0.6 (latest) — 2016-08-03
- 1.0.5 — 2016-08-03
- 1.0.4 — 2016-08-02
- 1.0.3 — 2016-08-02
- 1.0.2 — 2016-08-02
- 1.0.1 — 2016-08-02
- 1.0.0 — 2016-07-25
- 0.0.7 — 2016-07-21
- 0.0.6 — 2016-07-12
- 0.0.5 — 2016-07-11
- 0.0.4 — 2016-07-08
- 0.0.3 — 2016-07-08
- 0.0.2 — 2016-07-06
- 0.0.1 — 2016-07-06

## README

# smartnginx
control nginx from node, TypeScript ready

## Status
[![build status](https://gitlab.com/pushrocks/smartnginx/badges/master/build.svg)](https://gitlab.com/pushrocks/smartnginx/commits/master)

## Features

* easy reverse configuration
* automatic letsencrypt DNS01 challenge based ssl cert generation
* automatic nginx process handling zero-downtime config reloading
* works in Docker environements

## Usage
We recommend the use of TypeScript! :)

```typescript
import * as smartnginx from "smartnginx";
myNginxConfig = new smartnginx.NginxConfig();
myNginxZone = new smartnginx.NginxZone({
    zoneName:"some.example.com",
    type:"reverseProxy",
    destination:"192.192.192.192" // some destination IP
});
myNginxConfig.addZone(myNginxZone); // adds the zone to the config
myNginxConfig.deploy(); // deploys the referenced NginxConfig and gracefully reloads it
```

---
_Source: https://npm.io/package/smartnginx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._