nengine

nengine

A static node http/https server

Getting started

Install

$ npm install nengine

Note: nengine require nengine-cli

Introduction

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

$ nengine

and use:

$ nengine -h

for help.

you can config server by nengine.yml under server root:

port: # default: 80
  80
hostname: # default: 127.0.0.1
  127.0.0.1
dir: # default: deny
  allow
key: # options if not https server
  /key.pem
cert:  # options if not https server
  /cert.pem
ignoreAccess: # default: deny
  deny
ignore: # default: []
  - /nengine.yml
  - /node_modules(|/**)
maxAge: # default: 0
  2592000
index: # default: []
  - index.htm
  - index.html
  - default.htm
  - default.html
etag: # default: true
  true
lastModified: # default: true
  true
error: # default: {}
  404:
    /error/404.html
  default:
    /error/default.html

port: server port. {Number}

hostname: server hostname. {String}

key: https key path relative to root. {String}

cert: https cert path relative to root. {String}

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

ignoreAccess: set how "ignore" are treated when encountered. {String}

the default value is 'deny'.

• 'deny' send a 403 for any request for ignore matched.
• 'ignore' pretend like the ignore matched does not exist and 404.

ignore: set dir and files ignore glob rules. {Array|String}

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

index: set default document. {Array|String}

etag: set etag. {Boolean}

lastModified: set lastModified. {Boolean}

error: set custom error page. {Object}

License

MIT