artox/incubator-pagespeed-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme with goals and status

Browse Source
This commit is contained in:
Ilya Grigorik
2012-10-09 15:24:58 -07:00
parent 25c54e1a60
commit bd8e56aeea
1 changed files with 21 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -14
View File
@@ -1,13 +1,25 @@
# ngx_pagespeed
This is the [nginx](http://nginx.org/) port of
[mod_pagespeed](https://developers.google.com/speed/pagespeed/).
This is the [nginx](http://nginx.org/) port of [mod_pagespeed](https://developers.google.com/speed/pagespeed/mod).
**ngx_pagespeed is a work in progress**, and only a few of the mod_pagespeed filters are currently functional. If you are interested in test-driving the module, or contributing to the project, please follow the instructions below, and do provide feedback if you run into any issues or questions!
---
ngx_pagespeed speeds up your site and reduces page load time by automatically applying web performance best practices to pages, and associated assets (CSS, JavaScript, images) without requiring that you modify your existing content or workflow. Features (will) include:
- Image optimization: stripping meta-data, dynamic resizing, recompression
- CSS & JavaScript minification, concatenation, inlining, and outlining
- Small resource inlining
- Deferring image and JavaScript loading
- HTML rewriting
- Cache lifetime extension
- and [more](http://igrigorik.mtv.corp.google.com:8080/speed/docs/mod_pagespeed/config_filters)
## How to build
nginx does not support dynamic loading of modules. You need to add
ngx_pagespeed as a build time dependency, and to do that you have to first build
the pagespeed optimization library.
nginx does not support dynamic loading of modules. You need to add ngx_pagespeed as a build time dependency, and to do that you have to first build the pagespeed optimization library.
First build mod_pagespeed, following these instructions:
http://code.google.com/p/modpagespeed/wiki/HowToBuild
@@ -17,8 +29,7 @@ Then build the pagespeed optimization library:
$ cd /where/you/built/mod_pagespeed/src/net/instaweb/automatic
$ make all
Then move the mod_pagespeed directory to a parallel directory to your
ngx_pagespeed checkout:
Then move the mod_pagespeed directory to a parallel directory to your ngx_pagespeed checkout:
$ cd /path/to/ngx_pagespeed
$ mv /where/you/built/mod_pagespeed /path/to/mod_pagespeed
@@ -29,9 +40,7 @@ Now build nginx:
$ auto/configure --add-module=/path/to/ngx_pagespeed
$ make install
While ngx_pagespeed doesn't need to be anywhere specific in relation to nginx,
the mod_pagespeed directory and the ngx_pagespeed directory must have the same
parent.
While ngx_pagespeed doesn't need to be anywhere specific in relation to nginx, the mod_pagespeed directory and the ngx_pagespeed directory must have the same parent.
## How to use
@@ -39,8 +48,6 @@ To your nginx.conf add to the main block or to a server or location block:
pagespeed on;
Then fetch a page and note that it adds a comment:
To confirm that the module is working, fetch a page and check that you see the following comment in the source:
<!-- Processed through ngx_pagespeed using PSOL version 0.10.0.0 -->
That's all it does so far.
<!-- Processed through ngx_pagespeed using PSOL version 0.10.0.0 -->