npmpackage.info

Gathering detailed insights and metrics for http-server

Other packages similar to http-server

@types/http-server

0.12.4

TypeScript definitions for http-server

1.0.2

HTTP server cookie parsing and serialization

@adonisjs/http-server

7.5.0

AdonisJS HTTP server with support packed with Routing and Cookies

http-shutdown

1.2.2

Gracefully shutdown a running HTTP server.

Gathering detailed insights and metrics for http-server

http-server

a simple zero-configuration command-line http server

14.1.1

13,784

MIT

JavaScript

266.09 kB

480,062,580 3.8

Installations

npm install http-server

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=12

Node Version

16.15.0

NPM Version

8.5.5 Score

93.4

Supply Chain

98.3

Quality

79.2

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

45

Total

365

Closed

176

Merged

144

Issues

Open

99

Total

535

Closed

436

Releases

v14.1.1

Updated on May 31, 2022

v14.1.0

Updated on Jan 10, 2022

v13.1.0

Updated on Jan 10, 2022

v14.0.0

Updated on Oct 19, 2021

v13.0.2

Updated on Sep 13, 2021

v13.0.1

Updated on Aug 20, 2021

View All 12 releases

Contributors

View All 94 Contributors

Languages

JavaScript

HTML

Dockerfile

JavaScript (98.32%)

HTML (1.51%)

Dockerfile (0.16%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

http-party

Download Statistics

Total Downloads

480,062,580

Last Day

554,076

Last Week

2,900,537

Last Month

12,657,244

Last Year

124,418,482

GitHub Statistics

MIT License

13,784 Stars

636 Commits

1,518 Forks

193 Watchers

7 Branches

94 Contributors

Updated on Feb 26, 2025

Bundle Size

532.68 kB

Minified

266.09 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

14.1.1

Package Id

http-server@14.1.1

Unpacked Size

121.54 kB

Size

58.22 kB

File Count

NPM Version

8.5.5

Node Version

16.15.0

Total Downloads

Cumulative downloads

Total Downloads

480,062,580

Last Day

-5%

554,076

Compared to previous day

Last Week

-1.8%

2,900,537

Compared to previous week

Last Month

25.3%

12,657,244

Compared to previous month

Last Year

36%

124,418,482

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

basic-auth chalk corser he html-encoding-sniffer http-proxy mime minimist opener portfinder secure-compare union url-join

Dev Dependencies

eol eslint eslint-config-populist express request tap

http-server: a simple static HTTP server

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.

Example of running http-server

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.

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

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 `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first.	`false`
`-e` or `--ext`	Default file extension if none supplied	`html`
`-s` or `--silent`	Suppress log messages from output
`--cors`	Enable CORS via the `Access-Control-Allow-Origin` header
`-o [path]`	Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/
`-c`	Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds. To disable caching, use `-c-1`.	`3600`
`-U` or `--utc`	Use UTC time format in log messages.
`--log-ip`	Enable logging of the client's IP address	`false`
`-P` or `--proxy`	Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com
`--proxy-options`	Pass proxy options using nested dotted objects. e.g.: --proxy-options.secure false
`--username`	Username for basic authentication
`--password`	Password for basic authentication
`-S`, `--tls` or `--ssl`	Enable secure request serving with TLS/SSL (HTTPS)	`false`
`-C` or `--cert`	Path to ssl cert file	`cert.pem`
`-K` or `--key`	Path to ssl key file	`key.pem`
`-r` or `--robots`	Automatically provide a /robots.txt (The content of which defaults to `User-agent: *\nDisallow: /`)	`false`
`--no-dotfiles`	Do not show dotfiles
`--mimetypes`	Path to a .types file for custom mimetype definition
`-h` or `--help`	Print this list and exit.
`-v` or `--version`	Print the version and exit.

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:

1openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem

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.

1http-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)

e.g. openssl req -newkey rsa:2048 -passout pass:foobar -keyout key.pem -x509 -days 365 -out cert.pem

For security reasons, the passphrase will only be read from the NODE_HTTP_SERVER_SSL_PASSPHRASE environment variable.

This is what should be output if successful:

1Starting up http-server, serving ./ through https
2
3http-server settings:
4CORS: disabled
5Cache: 3600 seconds
6Connection Timeout: 120 seconds
7Directory Listings: visible
8AutoIndex: visible
9Serve GZIP Files: false
10Serve Brotli Files: false
11Default File Extension: none
12
13Available on:
14  https://127.0.0.1:8080
15  https://192.168.1.101:8080
16  https://192.168.1.104:8080
17Hit CTRL-C to stop the server

Development

Checkout this repository locally, then:

1$ npm i
2$ npm start

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.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.8

/10

Last Scanned on 2025-02-24

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to http-server

http-server

Installations

Developer Guide

No

CommonJS

>=12

16.15.0

8.5.5

Score

Pull Requests

45

365

176

144

Issues

99

535

436

Releases

Contributors

Languages

validate.email 🚀

Developer

http-party

Download Statistics

GitHub Statistics

Bundle Size

532.68 kB

266.09 kB

Maintainers

Package Meta Information

Total Downloads

480,062,580

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

http-server: a simple static HTTP server

Installation:

Running on-demand:

Globally via npm

Globally via Homebrew

As a dependency in your npm package:

Usage:

Available Options:

Magic Files

Catch-all redirect

TLS/SSL

Development

10

10

10

10

5

2

0

0

0

0

0

0

0

3.8

/10

Other packages similar to http-server

Globally via `npm`

As a dependency in your `npm` package: