npmpackage.info

Gathering detailed insights and metrics for static-server

Other packages similar to static-server

send

1.1.0

Better streaming static file server with Range and conditional-GET support

egg-static

2.3.1

static server plugin for egg

http-server

14.1.1

A simple zero-configuration command-line http server

koa-static-server

1.5.2

Static file serving middleware for koa with directory, rewrite and index support

static-server

A simple static server written in node.js

2.2.1

210

JavaScript

11.95 kB

16,877,256 1.7

Installations

npm install static-server

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=4

Node Version

8.1.4

NPM Version

5.5.1 Score

96.7

Supply Chain

Quality

75.3

Maintenance

Vulnerability

100

License

Pull Requests

Open

0

Total

28

Closed

10

Merged

18

Issues

Open

0

Total

28

Closed

28

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 17 Contributors

Languages

JavaScript

Shell

JavaScript (99.58%)

Shell (0.42%)

validate.email 🚀

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

Developer

nbluis

Download Statistics

Total Downloads

16,877,256

Last Day

6,384

Last Week

31,394

Last Month

134,879

Last Year

1,304,953

GitHub Statistics

210 Stars

101 Commits

51 Forks

5 Watchers

1 Branches

17 Contributors

Updated on Feb 18, 2025

Bundle Size

38.43 kB

Minified

11.95 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.2.1

Package Id

static-server@2.2.1

Size

9.54 kB

NPM Version

5.5.1

Node Version

8.1.4

Published on

Apr 03, 2018

Total Downloads

Cumulative downloads

Total Downloads

16,877,256

Last Day

16.8%

6,384

Compared to previous day

Last Week

6.9%

31,394

Compared to previous week

Last Month

32.6%

134,879

Compared to previous month

Last Year

-23.1%

1,304,953

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

chalk commander file-size mime opn

Dev Dependencies

istanbul mocha should supertest

Node static server

A simple http server to serve static resource files from a local directory.

Getting started

Install node.js
Install npm package globally npm -g install static-server
Go to the folder you want to serve
Run the server static-server

Options

-h, --help                 output usage information
-V, --version              output the version number
-p, --port <n>             the port to listen to for incoming HTTP connections
-i, --index <filename>     the default index file if not specified
-f, --follow-symlink       follow links, otherwise fail with file not found
-d, --debug                enable to show error messages
-n, --not-found <filename> the error 404 file
-c, --cors <pattern>       Cross Origin Pattern. Use "*" to allow all origins
-z, --no-nocache           disable cache (http 304) responses.
-o, --open                 open server in the local browser

Using as a node module

The server may be used as a dependency HTTP server.

Example

1var StaticServer = require('static-server');
2var server = new StaticServer({
3  rootPath: '.',            // required, the root of the server file tree
4  port: 1337,               // required, the port to listen
5  name: 'my-http-server',   // optional, will set "X-Powered-by" HTTP header
6  host: '10.0.0.100',       // optional, defaults to any interface
7  cors: '*',                // optional, defaults to undefined
8  followSymlink: true,      // optional, defaults to a 404 error
9  templates: {
10    index: 'foo.html',      // optional, defaults to 'index.html'
11    notFound: '404.html'    // optional, defaults to undefined
12  }
13});
14
15server.start(function () {
16  console.log('Server listening to', server.port);
17});
18
19server.on('request', function (req, res) {
20  // req.path is the URL resource (file name) from server.rootPath
21  // req.elapsedTime returns a string of the request's elapsed time
22});
23
24server.on('symbolicLink', function (link, file) {
25  // link is the source of the reference
26  // file is the link reference
27  console.log('File', link, 'is a link to', file);
28});
29
30server.on('response', function (req, res, err, file, stat) {
31  // res.status is the response status sent to the client
32  // res.headers are the headers sent
33  // err is any error message thrown
34  // file the file being served (may be null)
35  // stat the stat of the file being served (is null if file is null)
36
37  // NOTE: the response has already been sent at this point
38});

FAQ

Can I use this project in production environments? Obviously not.
Can this server run php, ruby, python or any other cgi script? No.
Is this server ready to receive thousands of requests? Preferably not.

Contributors

An special thank you to all contributors who allow this project to continue to evolve.

License

The MIT License (MIT)

Stable Version

2.2.1

High

7.5/10

Summary

static-server Path Traversal vulnerability

Affected Versions

<= 2.2.1

10

Binary-Artifacts

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

4

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

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.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-02-17

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