express-cdn
Advanced tools
Node.js module for delivering optimized, minified, mangled, gzipped, and CDN-hosted assets in Express using S3 and CloudFront.
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
This module is compatible with Express versions 2.x.x and 3.x.x.
0.0.9: Allowed explicit setting of S3 endpoint (by @eladb)
0.0.8: Enabled string-only output for CDN assets.
Example:
- 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.
Example:
/* 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);
}
background, background-image and content for url({{absoluteUrl}}) in stylesheets and scripts.Content-Encoding header set to gzip.<script> or <link> tag using the built-in dynamic view helper./lib/main.js please!fs.statSync to fs.stat with callback for image assets modified timestamp hack.When the server is first started, the module returns a view helper depending on
the server environment (production or development). It also recursively
searches through your viewsDir for any views containing instances of the
CDN(...) view helper. After parsing each instance and removing duplicates,
it will use your S3 credentials to upload a new copy of the production-quality
assets. Enjoy :).
Development Mode:
Assets are untouched, cachebusted, and delivered as typical local files for rapid development.
Production Mode:
Assets are optimized, minified, mangled, gzipped, delivered by Amazon CloudFront CDN, and hosted from Amazon S3.
bucket-nameUS Standard (use options.endpoint
with 'bucket.s3-xxx.amazonaws.com' for non US Standard regions)index.html in the Objects and Folders view from your S3 console and click Actions → Make Public.bucket-name.s3.amazonaws.comS3-bucket-nameDefault (*)S3-bucket-nameHTTP and HTTPSUse Origin Cache HeadersNo (Improves Caching)cdn.your-domain.comindex.htmlOffCreated with express-cdn by @niftylettuce.Enabledxyz.cloudfront.net) to your clipboard.cdn, and paste the contents of your clipboard as the the "alias" or "points to" value.index.html file should get displayed).### Install Dependencies
# install optipng and jpegtran packages
sudo apt-get install optipng libjpeg-progs
# install optipng and jpegtran packages
brew install optipng libjpeg
npm install express-cdn
// # express-cdn
var express = require('express')
, path = require('path')
, app = express.createServer()
, semver = require('semver');
// Set the CDN options
var options = {
publicDir : path.join(__dirname, 'public')
, viewsDir : path.join(__dirname, 'views')
, domain : 'cdn.your-domain.com'
, bucket : 'bucket-name'
, endpoint : 'bucket-name.s3-eu-west-1.amazonaws.com' // optional
, key : 'amazon-s3-key'
, secret : 'amazon-s3-secret'
, hostname : 'localhost'
, port : 1337
, ssl : false
, production : true
};
// 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 view helper
if (semver.lt(express.version, '3.0.0')) {
app.locals({ CDN: CDN() });
} else {
app.dynamicHelpers({ CDN: CDN });
}
app.get('/', function(req, res, next) {
res.render('basic');
return;
});
console.log("Server started: http://localhost:1337");
app.listen(1337);
// #1 - Load an image
!= CDN('/img/sprite.png')
// #2 - Load an image with a custom tag attribute
!= CDN('/img/sprite.png', { alt: 'Sprite' })
// #3 - Load a script
!= CDN('/js/script.js')
// #4 - Load a script with a custom tag attribute
!= CDN('/js/script.js', { 'data-message': 'Hello' })
// #5 - Load and concat two scripts
!= CDN([ '/js/plugins.js', '/js/script.js' ])
// #6 - Load and concat two scripts with custom tag attributes
!= CDN([ '/js/plugins.js', '/js/script.js' ], { 'data-message': 'Hello' })
// #7 - Load a stylesheet
!= CDN('/css/style.css')
// #8 - Load and concat two stylesheets
!= CDN([ '/css/style.css', '/css/extra.css' ])
<!-- #1 - Load an image -->
<%- CDN('/img/sprite.png') %>
<!-- #2 - Load an image with a custom tag attribute -->
<%- CDN('/img/sprite.png', { alt: 'Sprite' }) %>
<!-- #3 - Load a script -->
<%- CDN('/js/script.js') %>
<!-- #4 - Load a script with a custom tag attribute -->
<%- CDN('/js/script.js', { 'data-message': 'Hello' }) %>
<!-- #5 - Load and concat two scripts -->
<%- CDN([ '/js/plugins.js', '/js/script.js' ]) %>
<!-- #6 - Load and concat two scripts with custom tag attributes -->
<%- CDN([ '/js/plugins.js', '/js/script.js' ], { 'data-message': 'Hello' }) %>
<!-- #7 - Load a stylesheet -->
<%- CDN('/css/style.css') %>
<!-- #8 - Load and concat two stylesheets -->
<%- CDN([ '/css/style.css', '/css/extra.css' ]) %>
<!-- #1 - Load an image -->
<img src="/img/sprite.png?v=1341214029" />
<!-- #2 - Load an image with a custom tag attribute -->
<img src="/img/sprite.png?v=1341214029" alt="Sprite" />
<!-- #3 - Load a script -->
<script src="/js/script.js?v=1341214029" type="text/javascript"></script>
<!-- #4 - Load a script with a custom tag attribute -->
<script src="/js/script.js?v=1341214029" type="text/javascript" data-message="Hello"></script>
<!-- #5 - Load and concat two scripts -->
<script src="/js/plugins.js?v=1341214029" type="text/javascript"></script>
<script src="/js/script.js?v=1341214029" type="text/javascript"></script>
<!-- #6 - Load and concat two scripts with custom tag attributes -->
<script src="/js/plugins.js?v=1341214029" type="text/javascript" data-message="Hello"></script>
<script src="/js/script.js?v=1341214029" type="text/javascript" data-message="Hello"></script>
<!-- #7 - Load a stylesheet -->
<link href="/css/style.css?v=1341214029" rel="stylesheet" type="text/css" />
<!-- #8 - Load and concat two stylesheets -->
<link href="/css/style.css?v=1341214029" rel="stylesheet" type="text/css" />
<link href="/css/extra.css?v=1341214029" rel="stylesheet" type="text/css" />
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!).
<!-- #1 - Load an image -->
<img src="https://cdn.your-site.com/img/sprite.1341382571.png" />
<!-- #2 - Load an image with a custom tag attribute -->
<img src="https://cdn.your-site.com/img/sprite.1341382571.png" alt="Sprite" />
<!-- #3 - Load a script -->
<script src="https://cdn.your-site.com/js/script.1341382571.js" type="text/javascript"></script>
<!-- #4 - Load a script with a custom tag attribute -->
<script src="https://cdn.your-site.com/js/script.1341382571.js" type="text/javascript" data-message="Hello"></script>
<!-- #5 - Load and concat two scripts -->
<script src="https://cdn.your-site.com/plugins%2Bscript.1341382571.js" type="text/javascript"></script>
<!-- #6 - Load and concat two scripts with custom tag attributes -->
<script src="https://cdn.your-site.com/plugins%2Bscript.1341382571.js" type="text/javascript" data-message="Hello"></script>
<!-- #7 - Load a stylesheet -->
<link href="https://cdn.your-site.com/css/style.1341382571.css" rel="stylesheet" type="text/css" />
<!-- #8 - Load and concat two stylesheets -->
<link href="https://cdn.your-site.com/style%2Bextra.1341382571.css" rel="stylesheet" type="text/css" />
## Optional Features
### Using a custom logger
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 logging library.
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.
MIT Licensed
FAQs
Node.js module for delivering optimized, minified, mangled, gzipped, and CDN-hosted assets in Express using S3 and CloudFront.
The npm package express-cdn receives a total of 20 weekly downloads. As such, express-cdn popularity was classified as not popular.
We found that express-cdn demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.