https://github.com/kaelzhang/ngx

Data-driven nginx configuration manager.
https://github.com/kaelzhang/ngx

configuration configuration-management nginx ngx nodejs

Last synced: 3 months ago
JSON representation

Data-driven nginx configuration manager.

• Host: GitHub
• URL: https://github.com/kaelzhang/ngx
• Owner: kaelzhang
• License: mit
• Created: 2017-03-17T08:37:47.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-13T12:55:03.000Z (almost 7 years ago)
• Last Synced: 2024-04-15T12:33:00.967Z (9 months ago)
• Topics: configuration, configuration-management, nginx, ngx, nodejs
• Language: JavaScript
• Homepage:
• Size: 102 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/kaelzhang/node-ngx.svg?branch=master)](https://travis-ci.org/kaelzhang/node-ngx)

# ngx

The Data-driven nginx configuration manager, featured:

- Resolved path calculation for `include`, `root`, and other directives.

- Nginx-style template engine and building system to reuse a template with several sets of data.

- Directive `include` with glob patterns, such as `include conf.d/**/*.conf;`

## Install

```sh

$ npm install -g ngx

```

## Usage

```sh

NGX_ENV=production ngx start

# or

ngx start --env production

```

For now, you can find the example at the [sample](https://github.com/kaelzhang/node-ngx/tree/master/sample) directory.

```sh

git clone [email protected]:kaelzhang/node-ngx.git

cd node-ngx

npm link

cd sample

ngx start --env production

```

And the nginx will start and you will find compiled nginx conf files at `sample/nginx` directory.

## Contributing

PRs or wishlists are welcome. Please be free to create an [issue](https://github.com/kaelzhang/node-ngx/issues/new).

## License

MIT