push.rocks/smartnginx
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Philipp Kunz 2016-07-25 02:02:24 +02:00
parent 6de1352f5f
commit 52c3b40879
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -4,6 +4,13 @@ control nginx from node, TypeScript ready
## Status ## Status
[![build status](https://gitlab.com/pushrocks/smartnginx/badges/master/build.svg)](https://gitlab.com/pushrocks/smartnginx/commits/master) [![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 ## Usage
We recommend the use of TypeScript! :) We recommend the use of TypeScript! :)
@ -16,5 +23,5 @@ myNginxZone = new smartnginx.NginxZone({
destination:"192.192.192.192" // some destination IP destination:"192.192.192.192" // some destination IP
}); });
myNginxConfig.addZone(myNginxZone); // adds the zone to the config myNginxConfig.addZone(myNginxZone); // adds the zone to the config
myNginxConfig.deploy(); // deploys the referenced NginxConfig and restarts nginx myNginxConfig.deploy(); // deploys the referenced NginxConfig and gracefully reloads it
``` ```