Start — node-http-server

CLI quick start

Serve a folder locally.

Install the command globally, or use npx. The default listener is reachable only from this machine.

shell

npm install --global node-http-server
node-http-server --root ./public

Expected output

node-http-server listening at http://127.0.0.1:8080

No global install: run npx node-http-server --root ./public. See the CLI task guide for flags, failures, exit behavior, and deployment examples.

Library quick start

Create an isolated server.

CommonJS

const {Server}=require('node-http-server');

new Server({root:'./public'}).deploy();

ESM

import {Server} from 'node-http-server';

new Server({root:'./public'}).deploy();

The original default singleton remains available in both module systems. New applications should normally create a named Server instance so listener and configuration state stay isolated.

Import reference →Multiple servers and shutdown →

Starting behavior

Know the defaults before changing them.

127.0.0.1Listen address

8080HTTP port

index.htmlDirectory index

current directoryStatic root

Behavior	Default	Change it
Request-body limit	Unlimited	`server.maxRequestBodyBytes`
Compression	Off	`server.compression`
SPA fallback	Off	`server.spaFallback`
Dotfiles	Blocked with `403`	`server.allowDotfiles`
Automatic MIME types	Built-in map	`contentType`
Request logging	Off	`log`
HTTPS	Off	`https`

Network exposure: set host:'0.0.0.0' or --host 0.0.0.0 only when other machines should connect. Read Operations and security first.

Documentation by task

Go directly to the job.

Run the command

Install, flags, common tasks, expected output, and failure behavior.

CLI → Embed the server

Imports, lifecycle, public methods, request data, and hooks.

Library API → Set exact behavior

Every Config key, default, opt-out value, and validation rule.

Configuration → Copy a working pattern

SPA, HTTPS, domains, logging, hooks, limits, and shutdown.

Examples → Generate a config

Build CommonJS, ESM, CLI, or JSON without running a server.

Playground → Test and measure

Test commands, coverage gates, reports, badges, and CI artifacts.

Testing → Operate or upgrade

Exposure, status failures, logging, certificates, and v8 migration.

Operations → Browse the docs hub

A compact map of every page and the source documents.

Docs hub →

Project status

Published facts and measured coverage.

CINode 22.12 and 24 on main.

npmLatest published package.

Line coverageUbuntu Node coverage report.

DependenciesZero runtime; one owner-maintained dev tool.