Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 5.86 KB

Readme.md

File metadata and controls

53 lines (40 loc) · 5.86 KB
Raw

#RequestReduce RequestReduce allows any IIS based website to automaticaly sprite background images into a single optimized PNG as well as combine and minify javascript and CSS with absolutely no coding beyond a few config tweaks. RequestReduce registers itself as a response filter that will fiter any response of content type text/html. The filter looks for all css links and javascripts in the <head/> tag as well as all adjacent external javascripts in the body separated by either white space, comments or noscript tags and replaces them with a set of generated urls that contain the combined and minified javascripts and CSS using optimized sprites [where it can] (http://github.com/mwrock/RequestReduce/wiki/Can-I-make-changes-to-my-CSS-classes-to-optimize-RequestReduce-spriting%3F). RequestReduce uses a quantization algorithm (adapted from Xiaolin Wu's fast optimal color quantizer) and [optipng] (http://optipng.sourceforge.net/) to optimize the generated sprite images producing the smallest file size possible without impacting image quality.

RequestReduce performs these optimizations without [sacrificing the server performance of your web site] (http://github.com/mwrock/RequestReduce/wiki/Will-RequestReduce-impact-server-performance%3F). While the process of finding and generating the sprite image and minifying the javascript and CSS is naturally an expensive operation, requests will not block on this operation since RequestReduce performs these operations in a background thread and only once until the CSS and javascript changes or is [explicitly asked to flush its reductions] (http://github.com/mwrock/RequestReduce/wiki/How-can-I-get-RequestReduce-to-refresh-changed-CSS-or-images%3F).

RequestReduce excercises common best practices when serving its javascript, css and sprited images ensuring that the appropriate [caching headers] (http://github.com/mwrock/RequestReduce/wiki/Will-browsers-cache-the-css-and-image-files-that-RequestReduce-serves%3F) are sent to the browser so that browsers will not need to pull down a new http response until absolutely necessary. Chances are you will see an immediate rise in your yslow and google page speed tests.

RequestReduce provides several [configuration options] (http://github.com/mwrock/RequestReduce/wiki/RequestReduce-Configuration-options) to support [CDN hosting] (http://github.com/mwrock/RequestReduce/wiki/Can-I-have-all-RequestReduce-CSS-and-sprite-resources-pulled-from-a-CDN%3F), [multiple server environments] (http://github.com/mwrock/RequestReduce/wiki/Will-RequestReduce-sync-css-and-sprite-image-files-accross-all-of-the-web-servers-in-my-web-farm%3F) and more.

##Getting started

  1. If you have [Nuget] (http://docs.nuget.org/docs/start-here/installing-nuget), simply enter Install-Package RequestReduce in the Package Manager Console and skip steps two and three, otherwise download the latest RequestReduce version [here] (http://www.requestreduce.com/)
  2. Extract the contents of the downloaded zip and copy RequestReduce.dll and optipng.exe to your website's bin directory
  3. Add the RequestReduceModule to your web.config or using the IIS GUI.

Assuming you are using IIS 7, you would add it by ensuring that your web.config's system.webServer/modules element contains an add element as follows:

<system.web>
  <httpModules>
    <add name="RequestReduce" type="RequestReduce.Module.RequestReduceModule, RequestReduce" />
  </httpModules>
</system.web>
<system.webServer>
  <validation validateIntegratedModeConfiguration="false"/>  
	<modules>
      <add name="RequestReduce" type="RequestReduce.Module.RequestReduceModule, RequestReduce" />
	</modules>
</system.webServer>

All background images you want to sprite [must have an explicit width in their css class] (http://github.com/mwrock/RequestReduce/wiki/Can-I-make-changes-to-my-CSS-classes-to-optimize-RequestReduce-spriting%3F). Otherwise RequestReduce cannot guarantee that the background positions it injects will not cause adjacent sprites to bleed into a background image's view port. Also, RequestReduce will ignore repeating images so make sure to mark the image no-repeat if it is not a repeating image.

##Troubleshooting If RequestReduce does not appear to be doing anything, check out this [troubleshooting wiki] (https://github.com/mwrock/RequestReduce/wiki/RequestReduce-is-not-working.-I-don%27t-see-any-spriting-or-minification.-How-can-I-troubleshoot-this%3F) which provides several scenarios, options and debugging tips for figuring out why your content may not be being reduced. Also check the [list of wiki support pages] (https://github.com/mwrock/RequestReduce/wiki) which provides documentation addressing several topics to help you optimize RequestReduce and explain how RequestReduce works.

##Requirements

  • Compatible with Framework versions 3.5 and 4.0
  • Standard Features are Medium Trust compliant
  • The identity that your asp.net worker process runs under must have write access to your web root directory for creating sprite and css files

##What's Next? There are a ton of features I intend to add in order to make web performance optimizations just happen as part of installing Request Reduce. Here is what's at the top of the backlog:

  • Support defered javascript loading
  • Leverege CSS 3 to allow RequestReduce to sprite more images without any need for css modifications for supporting browsers
  • Options to sprite foreground images
  • Provide a command line utility for incorporating RequestReduce optimizations into a build task

##Resources

##License Licenced under [Apache 2.0] (http://www.apache.org/licenses/LICENSE-2.0)