41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
# @pushrocks/smartnginx
|
|
control nginx from node, TypeScript ready
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartnginx)
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartnginx)
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartnginx)
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartnginx/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartnginx/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartnginx/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smartnginx)
|
|
[](https://snyk.io/test/npm/@pushrocks/smartnginx)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## 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
|
|
```
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|