express-cdn   

Node.js module for delivering optimized, minified, mangled, gzipped, and CDN-hosted assets in Express (currently by Amazon S3 and Amazon CloudFront).

Follow @niftylettuce on Twitter for updates.

Like this module? Check out node-email-templates!

## Index

- Features
- Add-On Modules
- How Does It Work?
- Environment Differences
- CDN Setup Instructions
- Quick Start
- Custom Logging
- Lazyweb Requests
- Changelog
- Contributors
- License

Features

* Automatic parsing of background, background-image and content for url({{absoluteUrl}}) in stylesheets and scripts.
* Built-in optimization of images in production mode using binaries from NPM of [OptiPNG][1] and [JPEGTran][2].
* Supports [Sass][3], [LESS][4], and [Stylus][5] using respective stylesheet compilers.
* JavaScript assets are mangled and minified using [UglifyJS][6].
* Automatic detection of asset changes and will only upload changed assets to S3 in production mode.
* Utilizes cachebusting, which is inspired by [express-cachebuster][7] and [h5bp][8].
* All assets are compressed using [zlib][9] into a gzip buffer for S3 uploading with Content-Encoding header set to gzip.
* Embed multiple assets as a single



`

#### Production Mode

The protocol will automatically change to "https" or "http" depending on the SSL option.

The module will automatically upload and detect new/modified assets based off timestamp,
as it utilizes the timestamp for version control! There is built-in magic to detect if
individual assets were changed when concatenating multiple assets together (it adds the
timestamps together and checks if the combined asset timestamp on S3 exists!).

`html





`

Custom Logging

By default log messages will be sent to the console. If you would like to use a custom logger function you may pass it in as options.logger

The example below uses the [Winston][12] logging library.

`javascript
var winston = require('winston');
winston.add(winston.transports.File, {filename: 'somefile.log'});

// Set the CDN options
var options = {
publicDir : path.join(__dirname, 'public')
, viewsDir : path.join(__dirname, 'views')
, domain : 'cdn.your-domain.com'
, bucket : 'bucket-name'
, key : 'amazon-s3-key'
, secret : 'amazon-s3-secret'
, hostname : 'localhost'
, port : 1337
, ssl : false
, production : true
, logger : winston.info
};

// Initialize the CDN magic
var CDN = require('express-cdn')(app, options);

app.configure(function() {
app.set('view engine', 'jade');
app.set('view options', { layout: false, pretty: true });
app.enable('view cache');
app.use(express.bodyParser());
app.use(express.static(path.join(__dirname, 'public')));
});

// Add the dynamic view helper
app.dynamicHelpers({ CDN: CDN });

`

Any output from express-cdn is now passed to winston.info() which writes to both console and somefile.log.

Lazyweb Requests

These are feature requests that we would appreciate contributors for:

* Git SHA cachebusting instead of timestamp
* Add support for multiple view directories
* Add cache busting for CSS scraper
* Add font CSS scraper for uploading fonts with proper mimetypes and cachebusting
* Add options to pick CDN network (e.g. MaxCDN vs. Amazon vs. Rackspace)
* Add tests for all asset types.
* Modularization of /lib/main.js please!
* Support Express 3.x.x+ and utilize async with view helper.
* Convert from fs.statSync to fs.stat with callback for image assets modified timestamp hack.
* Investigate why Chrome Tools Audit returns leverage proxy cookieless jargon.

Changelog

* 0.2.3 - Added support for SVG files (by @zhangchiqing)

* 0.2.2 - Fixed uglifyjs license comment regex (by @kudos), fixed wrong mimetypes for minify case in compile method (by @kaskovsky)

* 0.2.1 - Fixed cursor css property also can be url (by @sars)

* 0.2.0 - Support for CSS @media query attribute with parenthesis (by @jfred)

* 0.1.9 - Added cleanCSS support to minify CSS (by @DServy)

* 0.1.8 - Added favicon support (by @mateusz-)

* 0.1.7 - Fixed issue with knox (by @DServy)

* 0.1.6 - Fixed extracting CSS border-image resources and image snot followed by ; in CSS (by @lxe)

* 0.1.5 - Preserved license comments with UglifyJS version 2.0 (by @mateusz-)

* 0.1.4 - Added case insensitive usage of cdn or CDN (by @leostera)

* 0.1.3 - Explicity set x-amz-acl to public-read.

* 0.1.2 - Added protocol relative paths for HTTP/HTTPS via // (by @Nevtep)

* 0.1.1 - Add ability to specify template extension

* 0.1.0 - Fixed endpoint issue, fixed knox issue, added optipng binary, added jpegtran binary, no longer requires optipng or jpegtran server dependencies!

* 0.0.9 - Allowed explicit setting of S3 endpoint (by @eladb)

* 0.0.8 - Enabled string-only output for CDN assets.

`jade
- var href = CDN('/img/full/foo.jpg', { raw : true });
a(class="fancybox", href="#{href}")
!= CDN('/img/small/foo.jpg', { alt : 'Foo', width : 800, height : 600 })
`

* 0.0.7 - Removed CSS minification due to over-optimization of the clean-css module.

* 0.0.6 - Added temporary support for CSS usage of background-image, background, and contents attributes by absolute image paths.

`css
/ Valid - Proper way to write CSS with express-cdn /
#example-valid {
background: url(/something.png);
}

/ Invalid - Don't do this! /
#example-invalid {
background: url(../something.png);
}
``

Contributors

* Nick Baugh
* Daniel Santiago
* James Wyse
* Jon Keating
* Andrew de Andrade
* Joshua Gross
* Dominik Lessel
* Elad Ben-Israel
* Aleksey Smolenchuk
* David Staley
* Joshua Frederick
* Rodion
* kaskovsky
* Jonathan Cremin
* Leo Zhang
* Herman-Scheer

License

The MIT License

Copyright (c) 2012- Nick Baugh niftylettuce@gmail.com (http://niftylettuce.com/)

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.

[1]: http://optipng.sourceforge.net/
[2]: http://jpegclub.org/jpegtran/
[3]: http://sass-lang.com/
[4]: http://lesscss.org/
[5]: http://learnboost.github.com/stylus/
[6]: https://github.com/mishoo/UglifyJS/
[7]: https://github.com/niftylettuce/express-cachebuster/
[8]: http://h5bp.com/
[9]: http://nodejs.org/api/zlib.html
[10]: https://github.com/LearnBoost/knox/
[11]: https://github.com/mxcl/homebrew/
[12]: https://github.com/flatiron/winston/
[13]: https://github.com/niftylettuce/express-cdn-cloudfront
[14]: https://github.com/niftylettuce/express-cdn-maxcdn
[15]: https://github.com/niftylettuce/express-cdn-cloudfiles
[16]: https://github.com/niftylettuce/express-cdn-cloudflare