Blueimp file uploader for Express js
A simple express module for integrating the jQuery File Upload frontend plugin.
Contents
- History
- Installation
- Configuration
- Usage with options
- SSL Support
- Multiple thumbnails
- Tests
- Contributions
History
The code was forked from a sample backend code from the plugin's repo. Adaptations were made to show how to use this plugin with the popular Express Node.js framework.
Although this code was initially meant for educational purposes, enhancements were made. Users can additionally:
- upgrade lwip to version 0.0.6 or higher to support gif images.
- choose the destination filesystem, local or cloud-based Amazon S3.
- create thumbnail without heavy external dependencies using lwip.
- setup server-side rules by configuration.
- modify the code against a test harness.
Installation
Setup an Express Project and install the package.
$ npm install blueimp-file-uploader-express --save
Configuration
options = tmpDir: __dirname + "/public/tmp" // tmp dir to upload files to uploadDir: __dirname + "/public/files" // actual location of the file uploadUrl: "/files/" // end point for delete route maxPostSize: 11000000000 // 11 GB minFileSize: 1 maxFileSize: 10000000000 // 10 GB acceptFileTypes: /.+/i inlineFileTypes: /\./i imageTypes: /\./i copyImgAsThumb: true // required imageVersions: maxWidth: 200 maxHeight: 200 accessControl: allowOrigin: "*" allowMethods: "OPTIONS, HEAD, GET, POST, PUT, DELETE" allowHeaders: "Content-Type, Content-Range, Content-Disposition" storage: type: "local" // local or aws aws: accessKeyId: "xxxxxxxxxxxxxxxxx" // required if aws secretAccessKey: "xxxxxxxxxxxxxxxxxxxxxxx" // required if aws region: "sa-east-1" // make sure you know the region, else leave this option out bucketName: "xxxxxxxxx" // required if aws path: "some-directory-in-your-bucket/" // optional if aws ;
Usage with options
// config the uploadervar options = tmpDir: __dirname + "/../public/uploaded/tmp" uploadDir: __dirname + "/../public/uploaded/files" uploadUrl: "/uploaded/files/" maxPostSize: 11000000000 // 11 GB minFileSize: 1 maxFileSize: 10000000000 // 10 GB acceptFileTypes: /.+/i // Files not matched by this regular expression force a download dialog, // to prevent executing any scripts in the context of the service domain: inlineFileTypes: /\./i imageTypes: /\./i copyImgAsThumb: true // required imageVersions: maxWidth: 200 maxHeight: 200 accessControl: allowOrigin: "*" allowMethods: "OPTIONS, HEAD, GET, POST, PUT, DELETE" allowHeaders: "Content-Type, Content-Range, Content-Disposition" storage: type: "aws" aws: accessKeyId: "xxxxxxxxxxxxxxxxx" secretAccessKey: "xxxxxxxxxxxxxxxxx" region: "sa-east-1" // make sure you know the region, else leave this option out bucketName: "xxxxxxxxxxxxxxxxx" ; // Init the uploadervar uploader = options; module { router; router; /** * The path SHOULD match options.uploadUrl * * If you are using the optional parameter path: for aws, you need to pass the reference before the file name, e.g: * router.delete("/uploaded/files/:directory/:name", function (req, res) * * Otherwise just pass a single reference, e.g: * router.delete("/uploaded/files/:name", function (req, res) */ router; return router;}
Note:
You can use the optional parameter
path
in order to store images in that specific directory.
SSL Support
Set the useSSL
option to true
to use the package with an HTTPS server.
var express = fs = https = app = ; // config the uploadervar options = ... useSSL: true ...; // init the uploadervar uploader = options; app
Multiple thumbnails
To generate multiple thumbnails while uploading.
var options = tmpDir: __dirname + "/../public/uploaded/tmp" uploadDir: __dirname + "/../public/uploaded/files" uploadUrl: "/uploaded/files/" copyImgAsThumb: true // required imageVersions: maxWidth: 200 maxHeight: 200 storage: type: "local" ;
copyImgAsThumb
needs to be set to true. imageVersions
, maxWidth
and maxHeight
will by default create a thumbnail
folder and place the specified width/height thumbnail in it.
Optionally, you can omit the maxHeight
. In this case, it will be resize proportionally to the specified width.
imageVersions: maxWidth: 200
also
imageVersions: maxWidth: 200 maxHeight : "auto"
PS : auto
value works only with height.
You can also specify multiple thumbnail generations like
var options = tmpDir: __dirname + "/../public/uploaded/tmp" uploadDir: __dirname + "/../public/uploaded/files" uploadUrl: "/uploaded/files/" copyImgAsThumb: true imageVersions: maxWidth: 200 maxHeight: "auto" "large" : width : 600 height : 600 "medium" : width : 300 height : 300 "small" : width : 150 height : 150 storage: type: "local" ;
Refer to : How to submit additional form data to send additional form data from the client.
Tests
Unit tests can be run with Jasmine using npm test
or this command:
$ jasmine-node specs/
Contributions
Changes and improvements are welcome! Feel free to fork and open a pull request.
To Do
- Make Configuration documentation clearer and shorter.
- Refactor code to build tests and provide generic transports as in
winston
. - Write end to end tests with WebdriverIO.
- Provide a basic image processing pipeline (resizing, croping, filter effects).
- Fix AWS thubnail issue (preview at uploading).
- Provide access to other cloud-based services like Microsoft Azure.