http-server
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

http-server

A simple zero-configuration command-line http server

0.11.1  •  Published 2 years ago  •  by http-party  •  MIT License

build status dependencies status npm license

http-server: a command-line http server

http-server is a simple, zero-configuration command-line http server. It is powerful enough for production usage, but it’s simple and hackable enough to be used for testing, local development, and learning.

Installing globally:

Installation via npm:

 npm install http-server -g

This will install http-server globally so that it may be run from the command line.

Usage:

 http-server [path] [options]

[path] defaults to ./public if the folder exists, and ./ otherwise.

Now you can visit http://localhost:8080 to view your server

Available Options:

-p Port to use (defaults to 8080)

-a Address to use (defaults to 0.0.0.0)

-d Show directory listings (defaults to ‘True’)

-i Display autoIndex (defaults to ‘True’)

-g or --gzip When enabled (defaults to ‘False’) it will serve ./public/some-file.js.gz in place of ./public/some-file.js when a gzipped version of the file exists and the request accepts gzip encoding.

-e or --ext Default file extension if none supplied (defaults to ‘html’)

-s or --silent Suppress log messages from output

--cors Enable CORS via the Access-Control-Allow-Origin header

-o Open browser window after starting the server

-c Set cache time (in seconds) for cache-control max-age header, e.g. -c10 for 10 seconds (defaults to ‘3600’). To disable caching, use -c-1.

-U or --utc Use UTC time format in log messages.

-P or --proxy Proxies all requests which can’t be resolved locally to the given url. e.g.: -P http://someurl.com

-S or --ssl Enable https.

-C or --cert Path to ssl cert file (default: cert.pem).

-K or --key Path to ssl key file (default: key.pem).

-r or --robots Provide a /robots.txt (whose content defaults to ‘User-agent: *\nDisallow: /’)

-h or --help Print this list and exit.

Development

Checkout this repository locally, then:

$ npm i
$ node bin/http-server

Now you can visit http://localhost:8080 to view your server

You should see the turtle image in the screenshot above hosted at that URL. See the ./public folder for demo content.

Popularity

Weekly Downloads
235.5K
Stars
8.9K

Maintenance

Development

Last ver 2 years ago
Created 8 years ago
Last commit 9 days ago
9 days between commits

Technology

Node version: 8.8.1
0 unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

79 contributors
indexzero
Maintainer, 75 commits, 33 merges, 2 PRs
Works at GoDaddy
Jade Thornton
Maintainer, 47 commits, 24 merges, 15 PRs
Works at flightaware
Marak Squires
46 commits, 5 merges
AvianFlu
29 commits, 4 merges, 1 PRs
Works at Blue Apron
BigBlueHat
Maintainer, 19 commits, 10 merges, 1 PRs
Works at WileyLabs
Maciej Małecki
23 commits, 4 merges, 7 PRs

Tags

cli
command
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things