http-cli

http-cli

Simple Node.js command-line HTTP server with CORS support.

It uses the following modules and middlewares :

• command-line-args
• command-line-usage
• connect
• cors
• morgan
• serve-index
• serve-static

For more details, see also Connect/Express middlewares.

Installation

npm install http-cli

Usage

Command line options are :

Options

  -h, --help      Display this usage help.
  -p, --port      Listen port number.
  -a, --host      Listen ip address or hostname.
  -r, --root      Root folder path.
  -c, --config    JSON configuration file path.

Default behaviour is :

• accept connections on 127.0.0.1 and port 8000
• use combined log output
• use current directory as web root
• directory listing is enabled
• send "index.html" files in response to a request on a directory
• reflect the request origin header in Access-Control-Allow-Origin CORS header

Configuration

An optionnal JSON configuration file can be loaded with --config option.

Example configuration file :

{
  "port": 3000,
  "host": "0.0.0.0",
  "root": "./web/",
  "middlewares": {
    "cors": {
      "origin": "http://example.com"
    },
    "serveIndex": {
      "view": "details"
    },
    "serveStatic": {
      "index": ["index.html", "default.html"]
    }
  }
}

For middlewares options, see links above.

Default configuration is equivalent to :

{
  "port": 8000,
  "host": "127.0.0.1",
  "root": "./",
  "logFormat": "combined",
  "middlewares": {
    "cors": {
      "origin": true
    },
    "morgan": {
    },
    "serveIndex": {
      "icons": true
    },
    "serveStatic": {
      "index": ["index.html"]
    }
  }
}

Node.js module

const http = require('http-cli')

const config = http.Config.default()
// const config = http.Config.loadFromFile('path/to/config.json')

http.server(config)
  // .use(/* another middleware */)
  .listen(config.port, config.host, function() {
    console.log('http server listening on ' + config.host + ':' + config.port)
  })

License

MIT