tj / serve

Simple command-line file / directory server built with connect - supports stylus, jade, etc

serve

Simple 5 minute command-line file / directory server built with connect, inspired by nodejitsu's http-server to show off the simplicity and flexibility of connect as a modular server.

Installation

$ npm install -g tj/serve

Note: the "serve" name on NPM (as of 2.x) refers to https://github.com/zeit/serve.

Usage

Usage: serve [options] [dir]

Options:

  -h, --help                output usage information
  -V, --version             output the version number
  -o, --open                opens a browser window to this server
  -a, --auth <user>:<pass>  specify basic auth credentials
  -F, --format <fmt>        specify the log format string
  -p, --port <port>         specify the port [3000]
  -r, --root <root>         specify the root directory []
      --https-port <port>   specify the port [3443]
  -H, --hidden              enable hidden file serving
  -S, --no-stylus           disable stylus rendering
  -J, --no-jade             disable jade rendering
      --no-less             disable less css rendering
  -I, --no-icons            disable icons
  -L, --no-logs             disable request logging
  -D, --no-dirs             disable directory serving
  -f, --favicon <path>      serve the given favicon
  -C, --cors                allows cross origin access serving
  -s, --https               also serve over https
      --key                 key file path for https
      --cert                certificate file for https
      --ca                  CA certificate file for https
      --compress            gzip or deflate the response
      --exec <cmd>          execute command on each request

Examples

HTTP Accept support built into connect.directory():

 $ curl http://local:3000/ -H "Accept: text/plain"
 bin
 History.md
 node_modules
 package.json
 Readme.md

Requesting a file:

$ curl http://local:3000/Readme.md

 # serve
 ...

Requesting JSON for the directory listing:

$ curl http://local:3000/ -H "Accept: application/json"
["bin","History.md","node_modules","package.json","Readme.md"]

Directory listing served by connect's connect.directory() middleware.

License

(The MIT License)

Copyright (c) 2011 TJ Holowaychuk <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

serve's Issues

How to generate static file to upload to ftp?

Support custom root route

Hi,

It would be convenient if it was possible to set up a server so that rather than pointing at / by default, it could point to something else (like /foo). We could call this option -R (--root).

Having this option would make it very easy for me to test certain paths generated by a static generator of mine. I'm not sure if there's an utility beyond that, though.

Consolidate support

It'd be cool to make it really flexible as far as compilers supported.

add file metadata

More file metadata would be great.Serve could be a great tool to develop simple REST JSON based tools. For example with QT QML.

• File Extension
• File Create Date
• File Modify Date
• File Accessed Date
• File Writeable True/False
• File Size (could be slow)

Update on NPM

Installing from git works, but installing from NPM still complains about out of date less-middleware usage. Please update!

File structure not navigatable on Firefox on Windows

Hey,

thanks for serve, it's a really cool tool! Just found one issue recently:

In Firefox on windows, links in the file structure view don't have their backslashes correctly replaced with slashes. The file view is not usable then.

To reproduce:

• use Firefox (I use 40) on Windows to access serve via http
• navigate into a directory from root (/build in my case)
• a '' is prepended to the URL (http://localhost:8000/%5Cbuild)
• navigate into a subdirectory in the new directory (in my case /build/dp)
• '' sneaks into the URL again, but this time escaped: http://localhost:8000/\build/\\build\dp\
• the server replies with an error message because the URL is not valid

Improper redirection?

When I go to localhost:3000 it gives me a page like this

http://i.imgur.com/5uxer9Z.png
The pages in them have url like this localhost:3000/\index.htm

Update dependencies

Connect 2.x is extremely outdated and there are other security concerns. Serve could even be using Express now.

(+) 8 vulnerabilities found
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ methodOverride Middleware Reflected Cross-Site Scrip… │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ connect                                               │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 2.3.9                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ <=2.8.0                                               │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ >=2.8.1                                               │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ serve > connect                                       │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/3                  │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Denial-of-Service Extended Event Loop Blocking        │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ qs                                                    │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 0.4.2                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ <1.0.0                                                │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ >= 1.x                                                │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ connect > qs                                          │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/28                 │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Denial-of-Service Memory Exhaustion                   │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ qs                                                    │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 0.4.2                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ <1.0.0                                                │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ >= 1.x                                                │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ connect > qs                                          │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/29                 │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Root Path Disclosure                                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ send                                                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 0.0.3                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ <0.11.1                                               │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ >=0.11.1                                              │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ connect > send                                        │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/56                 │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Directory Traversal                                   │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ send                                                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 0.0.3                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ < 0.8.4                                               │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ >= 0.8.4                                              │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ connect > send                                        │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/32                 │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Regular Expression Denial of Service                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ uglify-js                                             │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 2.5.0                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ All                                                   │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ None                                                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ jade > uglify-js                                      │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/48                 │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Regular Expression Denial of Service                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ uglify-js                                             │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 2.2.5                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ All                                                   │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ None                                                  │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ jade > transformers > uglify-js                       │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/48                 │
└───────────────┴───────────────────────────────────────────────────────┘
┌───────────────┬───────────────────────────────────────────────────────┐
│               │ Incorrect Handling of Non-Boolean Comparisons During… │
├───────────────┼───────────────────────────────────────────────────────┤
│ Name          │ uglify-js                                             │
├───────────────┼───────────────────────────────────────────────────────┤
│ Installed     │ 2.2.5                                                 │
├───────────────┼───────────────────────────────────────────────────────┤
│ Vulnerable    │ <= 2.4.23                                             │
├───────────────┼───────────────────────────────────────────────────────┤
│ Patched       │ >= 2.4.24                                             │
├───────────────┼───────────────────────────────────────────────────────┤
│ Path          │ jade > transformers > uglify-js                       │
├───────────────┼───────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/39                 │
└───────────────┴───────────────────────────────────────────────────────┘

release & publish?

current version in npm is unusable

$ npm uninstall serve
unbuild [email protected]
stephenmathieson at 0x6D746873 in ~/repos/components/rndid on master*
$ npm install serve@latest
[ . . . ]
$ node_modules/.bin/serve .

/Users/stephenmathieson/repos/components/rndid/node_modules/serve/node_modules/less-middleware/lib/middleware.js:50
    throw new Error('Please update your less-middleware usage: http://goo.gl/Y
          ^
Error: Please update your less-middleware usage: http://goo.gl/YnK8p0
    at module.exports.less.middleware (/Users/stephenmathieson/repos/components/rndid/node_modules/serve/node_modules/less-middleware/lib/middleware.js:50:11)
    at Object.<anonymous> (/Users/stephenmathieson/repos/components/rndid/node_modules/serve/bin/serve:81:14)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:902:3

Update Serve to use latest Less.js middleware api

Latest changes in less 0.2.1-beta modified it's API and broke 1.3.0 version of Serve. Serve needs to be modifed to use latest less middleware API, as pointed out here: https://github.com/emberfeather/less.js-middleware/wiki/Migration-0.1.x-0.2.0

cors doesn't work

Is this project still maintained?

Hi TJ, I'm a fan of serve. It doesn't look like it's maintained anymore and would love to adopt the project to clean up/add the features

port NaN

port argument allows NaN. Example:

serve -p foobar

Perhaps should be filed upstream with commander.

Version Command.js breaks with node 0.6.0

The current version of Command.js is breaking with node 0.6.0. I the latest seems to work at least by itself.

Support for HTTP 2

I could send a PR

gzip compression

Hi!

It's pretty cool to prototype quick stuff relying on HTTP without having to build an "app".

Do you have plans to support gzip compression?
The middleware PR should do the trick though, as it's already a connect middleware.

Thanks :-)

add option to automatically redirect to https

it would be so nice if it was an option. what do you think? would you accept a pull request if i would submit one solving this issue?

Add homepage/repo to package.json

Process SSI tags

Can an option be added to process Apache-style serverside includes? I think for most folks, a basic implementation would suffice. But any type of includes-system really, would be a great little thing to have.

Example:

<!--#include virtual="inc/footer.html"-->

This would be relative to the file being processed.

backgrounded serve process stays open when terminal is closed

not actually sure if this is my OS or serve, but I'm not sure if you've noticed but here are the steps:

1. Close the terminal window while a background serve process is running.
2. Go to the address of that background process. It should open back up again
3. Reload the page. The background process should shutdown.

This is annoying because it doesn't allow you to reclaim ports right away.

Ugly console output if port is already in use

Running serve twice prints

events.js:72
        throw er; // Unhandled 'error' event
              ^
Error: listen EADDRINUSE
    at errnoException (net.js:901:11)
    at Server._listen2 (net.js:1039:14)
    at listen (net.js:1061:10)
    at Server.listen (net.js:1127:5)
    at Function.app.listen (D:\dev\lng\JavaScript\node.js\node-globals\node_modules\serve\node_modules\connect\lib\proto.js:229:24)
    at Object.<anonymous> (D:\dev\lng\JavaScript\node.js\node-globals\node_modules\serve\bin\serve:113:8)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)

to the console the second time. Nicer output would be apreciated.

download same file without blocking *please close issue

If one user download a file, the next user must wait. It would be great if serve would deliver same files to multiples users without blocking. Is there a way?

Support 0.6.0

I don't want to cause more work for you but, serve and a few others are not supporting 0.6.0. I know it was just released; take your time. I just wanted to create issues. If you want I can fork and help with the migrations.

move to expressjs org?

since it uses the static middleware n stuff

Use default terminal color for font.

Use the default terminal color for the main font, otherwise it looks like this in some terminals (iterm2 in OS X in this case):

Nope, this package do not work

vagrant@precise32:~/repos/nemobile$ sudo npm install serve   
npm WARN package.json [email protected] No description
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No README data
npm WARN package.json [email protected] No license field.
npm WARN prefer global [email protected] should be installed with -g
[email protected] node_modules/serve
├── [email protected]
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
└── [email protected] ([email protected], [email protected], [email protected])
vagrant@precise32:~/repos$ node serve
module.js:338
    throw err;
          ^
Error: Cannot find module '/home/vagrant/repos/serve'
    at Function.Module._resolveFilename (module.js:336:15)
    at Function.Module._load (module.js:278:25)
    at Function.Module.runMain (module.js:501:10)
    at startup (node.js:129:16)
    at node.js:814:3

CoffeeScript

Can we get some input on whether CoffeeScript isn't going to be added or just hasn't been done correctly yet? There are two pull requests right now (#11 and #12) that attempt to add CoffeeScript, though I could see potential issues with each - nonstandard version and synchronous I/O, respectively. The version I've been using locally (and have pushed to my fork at btmills/serve):

• uses the standard CoffeeScript compiler
• reads the source file asynchronously
• detects .coffee or .js extensions (ex: <script src="foo.js"></script> will get the compiled version of foo.coffee)

I didn't want to send yet another pull request for the same feature until there was some feedback on what's really needed, though I think CoffeeScript support is definitely worth adding.

Support Live Reload

Is there a way to support watching and reloading the page on change?

Support Cache Busting

How

1. Create a function etag. It takes a url and appends the digest to the path.
2. Inject into JADE as local function and as a JS function.
3. Developer can use it on the client side where ever required.

Note in README that this is no longer what `npm serve` installs

Had a surprise today, actually a couple, when I npm installed projects with serve as a dep, and found the API has changed -- post 2.0 versions now install https://github.com/zeit/serve instead, and that package serves up on a random port by default. Not sure there's much left to do on this repo except change the README, but here's the thread over on the new repo describing me stumbling over that change.

Self-reported version is incorrect

serve --version reports 1.2.0 when the current version is 1.3.0.

Create a new release？

There has been some useful feature and fixes after the last release since Mar, 2014,
1.4.0...master

Consider a new release?

feature: Option to serve unfound routes as an entry file (e.g. for SPA's)

When running a web app (single page application) with HTML5 history API, for routes to work properly on reload, the server must serve the index file on unfound routes.

This is implemented in live-server as --entry-file=PATH:
https://github.com/tapio/live-server

adding --no-stylus option still attempts to compile stylus files

Looks like the stylus middleware line in the file is outside of the conditional that checks for the argument.

No mime-type for Opus audio

Opus files using the .opus extension should have audio/ogg; codecs=opus as mime-type.

dependency on [email protected] breaks when running on node 0.6

npm -g install serve

npm ERR! Unsupported
npm ERR! Not compatible with your version of node/npm: [email protected]
npm ERR! Required: {"node":"0.4.x"}
npm ERR! Actual: {"npm":"1.0.106","node":"0.6.0"}
npm ERR!

Add `-q`, `--quiet`