A simple static file server middleware. Use it with a raw http server or express/connect!
Examples:
express 3.0.x
var http = require('http');
var express = require('express');
var ecstatic = require('ecstatic');
var app = express();
app.use(ecstatic({ root: __dirname + '/public' }));
http.createServer(app).listen(8080);
console.log('Listening on :8080');
stock http server
var http = require('http');
var ecstatic = require('ecstatic');
http.createServer(
ecstatic({ root: __dirname + '/public' })
).listen(8080);
console.log('Listening on :8080');
fall through
To allow fall through to your custom routes:
ecstatic({ root: __dirname + '/public', handleError: false })
API:
ecstatic(opts);
Pass ecstatic an options hash, and it will return your middleware!
var opts = {
root : __dirname + '/public',
port : 8000,
baseDir : '/',
cache : 3600,
showDir : true,
showDotfiles : true,
autoIndex : false,
humanReadable : true,
headers : {},
si : false,
defaultExt : 'html',
gzip : false,
serverHeader : true,
contentType : 'application/octet-stream',
mimeTypes : undefined,
handleOptionsMethod: false
}
If opts
is a string, the string is assigned to the root folder and all other
options are set to their defaults.
opts.root
opts.root
is the directory you want to serve up.
opts.port
opts.port
is the port you want ecstatic to listen to. Defaults to 8000.
opts.baseDir
opts.baseDir
is /
by default, but can be changed to allow your static files
to be served off a specific route. For example, if opts.baseDir === "blog"
and opts.root = "./public"
, requests for localhost:8080/blog/index.html
will
resolve to ./public/index.html
.
opts.cache
Customize cache control with opts.cache
, if it is a number then it will set max-age in seconds.
Other wise it will pass through directly to cache-control. Time defaults to 3600 s (ie, 1 hour).
If it is a function, it will be executed on every request, and passed the pathname. Whatever it returns, string or number, will be used as the cache control header like above.
opts.showDir
Turn off directory listings with opts.showDir === false
. Defaults to true.
opts.showDotfiles
Exclude dotfiles from directory listings with opts.showDotfiles === false
. Defaults to true.
opts.humanReadable
If showDir is enabled, add human-readable file sizes. Defaults to true.
Aliases are humanreadable
and human-readable
.
opts.headers
Set headers on every response. opts.headers
can be an object mapping string
header names to string header values, a colon (:) separated string, or an array
of colon separated strings.
opts.H
and opts.header
are aliased to opts.headers
so that you can use
-H
and --header
options to set headers on the command-line like curl:
$ ecstatic ./public -p 5000 -H 'Access-Control-Allow-Origin: *'
opts.si
If showDir and humanReadable are enabled, print file sizes with base 1000 instead
of base 1024. Name is inferred from cli options for ls
. Aliased to index
, the
equivalent option in Apache.
opts.autoIndex
Serve /path/index.html
when /path/
is requested.
Turn off autoIndexing with opts.autoIndex === false
. Defaults to true.
opts.defaultExt
Turn on default file extensions with opts.defaultExt
. If opts.defaultExt
is
true, it will default to html
. For example if you want a request to /a-file
to resolve to ./public/a-file.html
, set this to true
. If you want
/a-file
to resolve to ./public/a-file.json
instead, set opts.defaultExt
to
json
.
opts.gzip
Set opts.gzip === true
in order to turn on "gzip mode," wherein ecstatic will
serve ./public/some-file.js.gz
in place of ./public/some-file.js
when the
gzipped version exists and ecstatic determines that the behavior is appropriate.
opts.serverHeader
Set opts.serverHeader
to false in order to turn off setting the Server
header
on all responses served by ecstatic.
opts.contentType
Set opts.contentType
in order to change default Content-Type header value.
Defaults to application/octet-stream.
opts.mimeTypes
Add new or override one or more mime-types. This affects the HTTP Content-Type header.
Can either be a path to a .types
file or an object hash of type(s).
ecstatic({ mimeType: { 'mime-type': ['file_extension', 'file_extension'] } })
opts.handleError
Turn off handleErrors to allow fall-through with opts.handleError === false
, Defaults to true.
opts.weakEtags
Set opts.weakEtags
to true in order to generate weak etags instead of strong etags. Defaults to false. See opts.weakCompare
as well.
opts.weakCompare
Turn on weakCompare to allow the weak comparison function for etag validation. Defaults to false. See https://www.ietf.org/rfc/rfc2616.txt Section 13.3.3 for more details.
opts.handleOptionsMethod
Set handleOptionsMethod to true in order to respond to 'OPTIONS' calls with any standard/set headers. Defaults to false. Useful for hacking up CORS support.
opts.cors
This is a convenience setting which turns on handleOptionsMethod
and sets the headers Access-Control-Allow-Origin: * and Access-Control-Allow-Headers: Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since. This should be enough to quickly make cross-origin resource sharing work between development APIs. More advanced usage can come either from overriding these headers with the headers argument, or by using the handleOptionsMethod
flag and then setting headers "manually." Alternately, just do it in your app using separate middlewares/abstractions.
Defaults to false.
middleware(req, res, next);
This works more or less as you'd expect.
ecstatic.showDir(folder);
This returns another middleware which will attempt to show a directory view. Turning on auto-indexing is roughly equivalent to adding this middleware after an ecstatic middleware with autoindexing disabled.
ecstatic
command
to start a standalone static http server,
run npm install -g ecstatic
and then run ecstatic [dir?] [options] --port PORT
all options work as above, passed in optimist style.
port
defaults to 8000
. If a dir
or --root dir
argument is not passed, ecsatic will
serve the current dir. Ecstatic also respects the PORT environment variable.
Tests:
Ecstatic has a fairly extensive test suite. You can run it with:
$ npm test
Contribute:
Without outside contributions, ecstatic would wither and die! Before contributing, take a quick look at the contributing guidelines in ./CONTRIBUTING.md . They're relatively painless, I promise. For Windows users, it is especially important to read the ./CONTRIBUTING.md section as you can not clone ecstatic without changing some settings in git.
License:
MIT. See LICENSE.txt. For contributors, see CONTRIBUTORS.md