31 lines
893 B
Markdown
31 lines
893 B
Markdown
# 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';
|
|
const smartnginxInstance = new smartnginx.SmartNginx();
|
|
myNginxHost = new smartnginx.NginxHost({
|
|
hostName: '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
|
|
```
|