nengine/README.md

The nengine http server

Nengine
==========

>A static node http server

>[![NPM Version][npm-image]][npm-url]
>[![Download Status][download-image]][npm-url]
>![Node Version][node-image]
>[![Dependencies][david-image]][david-url]

Getting started
==========

### Install

```shell
$ npm install nengine
```

*`Note: nengine require nengine-cli`*

### Introduction

if you have installed `nengine-cli` and `nengine`, you can run nengine by command:

```shell
$ nengine
```

and use:

```shell
$ nengine -h
```

for help.

you can config server by `nengine.json` under server root:
```json
{
  "port": 80,
  "directory": "allow",
  "dotFiles": "deny",
  "maxAge": 2592000,
  "index": ["index.html"],
  "extensions": ["html"],
  "etag": true,
  "lastModified": true,
  "status": {
    "404": "/error/404.html",
    "default": "/error/default.html"
  }
}
```

`port`: server port. `{Number}`

`directory`: show directory, you can set "allow", "deny", "ignore". `{String}`

`dotFiles`: show dot file, like directory. `{String}`

`maxAge`: set max-age, unit: seconds and also you can set like "2 days". `{Number|String}`

`index`: set default document. `{Array|String}`

`extensions`: set default extname, program will automatic add extname. `{Array|String}`

`etag`: set etag. `{Boolean}`

`lastModified`: set lastModified. `{Boolean}`

`status`: set custom error page. `{Object}`

## License

[MIT](LICENSE)

[david-image]: http://img.shields.io/david/nuintun/nengine.svg?style=flat-square
[david-url]: https://david-dm.org/nuintun/nengine
[node-image]: http://img.shields.io/node/v/nengine.svg?style=flat-square
[npm-image]: http://img.shields.io/npm/v/nengine.svg?style=flat-square
[npm-url]: https://www.npmjs.org/package/nengine
[download-image]: http://img.shields.io/npm/dm/nengine.svg?style=flat-square