http-server is a simple, zero-configuration command-line static 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.
Installation:
Running on-demand:
Using npx you can run the script without installing it first:
npx http-server [path] [options]
Globally via npm
npm install --global http-server
This will install http-server globally so that it may be run from the command line anywhere.
Globally via Homebrew
brew install http-server
As a dependency in your npm package:
npm install http-server
Usage:
http-server [path] [options]
[path] defaults to ./public if the folder exists, and ./ otherwise.
Note: Caching is on by default. Add -c-1 as an option to disable caching.
Available Options:
Command
Description
Defaults
-p or --port
Port to use. Use -p 0 to look for an open port, starting at 8080. It will also read from process.env.PORT.
8080
-a
Address to use
0.0.0.0
-d
Show directory listings
true
-i
Display autoIndex
true
-g or --gzip
When enabled 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. If brotli is also enabled, it will try to serve brotli first.
false
-b or --brotli
When enabled it will serve in place of when a brotli compressed version of the file exists and the request accepts encoding. If gzip is also enabled, it will try to serve brotli first.
Magic Files
index.html will be served as the default file to any directory requests.
404.html will be served if a file is not found. This can be used for Single-Page App (SPA) hosting to serve the entry page.
Catch-all redirect
To implement a catch-all redirect, use the index page itself as the proxy with:
http-server --proxy http://localhost:8080?
Note the ? at the end of the proxy URL. Thanks to @houston3 for this clever hack!
TLS/SSL
First, you need to make sure that openssl is installed correctly, and you have key.pem and cert.pem files. You can generate them using this command:
You will be prompted with a few questions after entering the command. Use 127.0.0.1 as value for Common name if you want to be able to install the certificate in your OS's root certificate store or browser so that it is trusted.
This generates a cert-key pair and it will be valid for 3650 days (about 10 years).
Then you need to run the server with -S for enabling SSL and -C for your certificate file.
http-server -S -C cert.pem
If you wish to use a passphrase with your private key you can include one in the openssl command via the -passout parameter (using password of foobar)