UpNode

RESTful file server to upload and serve static files. Powererd by Node.js.

Installation

$ npm install

This will create a node_modules folder and install all required dependencies to run UpNode.

Usage

Start the server via node command. The port parameter is optional and defaults to port 8888.

$ node server.js [port]

File server running at
  => http://localhost:8888/
CTRL + C to shutdown

Uploading files

A POST request uploads any given files and displays a summary of the file's properties in JSON format.

$ curl -F 'upload=@img.png' http://localhost:8888

{
  "errors": false,
  "numberOfFiles": 1,
  "files": [
    {
      "path": "/path/to/UpNode/uploads/img.png",
      "uploadsPath": "/path/to/UpNode/uploads/",
      "filename": "img.png",
      "size": 1036163,
      "lastModifiedDate": "2012-10-02T10:02:53.460Z",
      "mimeType": "image/png"
    }
  ],
  "fields": {}
}

You may upload multiple files by providing additional files within the request.

$ curl -F 'upload[]=@img.png' -F 'upload[]=@anotherimg.png' http://localhost:8888

You can assign additional parameters to the upload as well (e.g. a user to associate to the upload). These params will be shown in the fields object of the server response.

$ curl -F 'upload=@img.png' -F 'user=123456789' http://localhost:8888

Serving files

A GET request will serve previously uploaded files.

You can access any uploaded files by pointing your browser to the uploaded file's path.

E.g. if you uploaded img.png, your file will be located at http://localhost:8888/uploads/img.png.

Configuration options

Whitelisting MIME types

In most cases, you might not want the server to accept every file that is uploaded.

To restrict the type of files that can be uploaded, edit the mimeTypeWhitelist array in server.js.

// only allow jpg and png images to be uploaded 
mimeTypeWhitelist = ["image/jpeg", "image/png"];

You can find a list of possible mime types at Apache mime.types.

Contributing

Create something awesome, make the code better, add some functionality, whatever (this is the hardest part).
Fork it
Create new branch to make your changes
Commit all your changes to your branch
Submit a pull request

Contact

Feel free to get in touch.

Website: http://schuch.me
Twitter: @schuchalexander

Licence

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.

aschuch/UpNode