diff --git a/README.md b/README.md index 38b98648e..3315a1d4d 100644 --- a/README.md +++ b/README.md @@ -19,90 +19,15 @@ optimizations, see our demonstration site. ## How to build -Because nginx does not support dynamic loading of modules, you need to compile -nginx from source to add ngx_pagespeed. Alternatively, if you're using Tengine you can [install ngx_pagespeed without -recompiling Tengine](https://github.com/pagespeed/ngx_pagespeed/wiki/Using-ngx_pagespeed-with-Tengine). - -1. Install dependencies: - - ```bash - # These are for RedHat, CentOS, and Fedora. - $ sudo yum install gcc-c++ pcre-dev pcre-devel zlib-devel make - - # These are for Debian. Ubuntu will be similar. - $ sudo apt-get install build-essential zlib1g-dev libpcre3 libpcre3-dev - ``` - -2. Download ngx_pagespeed: - - ```bash - $ cd ~ - $ wget https://github.com/pagespeed/ngx_pagespeed/archive/v1.8.31.2-beta.zip - $ unzip v1.8.31.2-beta.zip # or unzip v1.8.31.2-beta - $ cd ngx_pagespeed-1.8.31.2-beta/ - $ wget https://dl.google.com/dl/page-speed/psol/1.8.31.2.tar.gz - $ tar -xzvf 1.8.31.2.tar.gz # expands to psol/ - ``` - -3. Download and build nginx: - - ```bash - $ cd ~ - $ # check http://nginx.org/en/download.html for the latest version - $ wget http://nginx.org/download/nginx-1.6.0.tar.gz - $ tar -xvzf nginx-1.6.0.tar.gz - $ cd nginx-1.6.0/ - $ ./configure --add-module=$HOME/ngx_pagespeed-1.8.31.2-beta - $ make - $ sudo make install - ``` - -If this doesn't work see the [build -troubleshooting](https://github.com/pagespeed/ngx_pagespeed/wiki/Build-Troubleshooting) page. - -This will use a binary PageSpeed Optimization Library, but it's also possible to -[build PSOL from -source](https://github.com/pagespeed/ngx_pagespeed/wiki/Building-PSOL-From-Source). - -Note: ngx_pagespeed currently doesn't support Windows or MacOS because the -underlying PSOL library doesn't. +Follow the steps on build +ngx_pagespeed from source. ## How to use -In your `nginx.conf`, add to the main or server block: - -```nginx -pagespeed on; -pagespeed FileCachePath /var/ngx_pagespeed_cache; # Use tmpfs for best results. -``` - -In every server block where pagespeed is enabled add: - -```apache -# Ensure requests for pagespeed optimized resources go to the pagespeed -# handler and no extraneous headers get set. -location ~ "\.pagespeed\.([a-z]\.)?[a-z]{2}\.[^.]{10}\.[^.]+" { add_header "" ""; } -location ~ "^/pagespeed_static/" { } -location ~ "^/ngx_pagespeed_beacon$" { } -``` - -To confirm that the module is loaded, fetch a page and check that you see the -`X-Page-Speed` header: - -```bash -$ curl -I 'http://localhost:8050/some_page/' | grep X-Page-Speed -X-Page-Speed: 1.8.31.2-... -``` - -Looking at the source of a few pages you should see various changes, such as -urls being replaced with new ones like `yellow.css.pagespeed.ce.lzJ8VcVi1l.css`. - -For complete documentation, see [Using -PageSpeed](https://developers.google.com/speed/pagespeed/module/using). - -There are extensive system tests which cover most of ngx_pagespeed's -functionality. Consider [testing your -installation](https://github.com/pagespeed/ngx_pagespeed/wiki/Testing). +Follow the steps on PageSpeed +configuration. For feedback, questions, and to follow the progress of the project: @@ -111,20 +36,3 @@ the progress of the project: list](https://groups.google.com/forum/#!forum/ngx-pagespeed-discuss) - [ngx-pagespeed-announce mailing list](https://groups.google.com/forum/#!forum/ngx-pagespeed-announce) - -Note: The -[canonicalize_javascript_libraries](https://developers.google.com/speed/pagespeed/module/filter-canonicalize-js) -depends on `pagespeed_libraries.conf` which is distributed in Apache's format. -To convert it to the Nginx format, run: - -```bash -$ scripts/pagespeed_libraries_generator.sh > ~/pagespeed_libraries.conf -$ sudo mv ~/pagespeed_libraries.conf /etc/nginx/ -``` - -And then include it in your Nginx configuration by reference: - -```nginx -include pagespeed_libraries.conf; -pagespeed EnableFilters canonicalize_javascript_libraries; -```