ngx_cache_purge-2.0.tar.gz

About ===== `ngx_cache_purge` is `nginx` module which adds ability to purge content from `FastCGI`, `proxy`, `SCGI` and `uWSGI` caches. Sponsors ======== Work on the original patch was fully funded by [yo.se](http://yo.se). Status ====== This module is production-ready and it's compatible with following nginx releases: - 0.7.x (tested with 0.7.60 to 0.7.69), - 0.8.x (tested with 0.8.0 to 0.8.55), - 0.9.x (tested with 0.9.0 to 0.9.7), - 1.0.x (tested with 1.0.0 to 1.0.15), - 1.1.x (tested with 1.1.0 to 1.1.19), - 1.2.x (tested with 1.2.0 to 1.2.5), - 1.3.x (tested with 1.3.0 to 1.3.9). Configuration directives (same location syntax) =============================================== fastcgi_cache_purge ------------------- * **syntax**: `fastcgi_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]` * **default**: `none` * **context**: `http`, `server`, `location` Allow purging of selected pages from `FastCGI`'s cache. proxy_cache_purge ----------------- * **syntax**: `proxy_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]` * **default**: `none` * **context**: `http`, `server`, `location` Allow purging of selected pages from `proxy`'s cache. scgi_cache_purge ---------------- * **syntax**: `scgi_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]` * **default**: `none` * **context**: `http`, `server`, `location` Allow purging of selected pages from `SCGI`'s cache. uwsgi_cache_purge ----------------- * **syntax**: `uwsgi_cache_purge on|off|<method> [from all|<ip> [.. <ip>]]` * **default**: `none` * **context**: `http`, `server`, `location` Allow purging of selected pages from `uWSGI`'s cache. Configuration directives (separate location syntax) =================================================== fastcgi_cache_purge ------------------- * **syntax**: `fastcgi_cache_purge zone_name key` * **default**: `none` * **context**: `location` Sets area and key used for purging selected pages from `FastCGI`'s cache. proxy_cache_purge ----------------- * **syntax**: `proxy_cache_purge zone_name key` * **default**: `none` * **context**: `location` Sets area and key used for purging selected pages from `proxy`'s cache. scgi_cache_purge ---------------- * **syntax**: `scgi_cache_purge zone_name key` * **default**: `none` * **context**: `location` Sets area and key used for purging selected pages from `SCGI`'s cache. uwsgi_cache_purge ----------------- * **syntax**: `uwsgi_cache_purge zone_name key` * **default**: `none` * **context**: `location` Sets area and key used for purging selected pages from `uWSGI`'s cache. Sample configuration (same location syntax) =========================================== http { proxy_cache_path /tmp/cache keys_zone=tmpcache:10m; server { location / { proxy_pass http://127.0.0.1:8000; proxy_cache tmpcache; proxy_cache_key $uri$is_args$args; proxy_cache_purge PURGE from 127.0.0.1; } } } Sample configuration (separate location syntax) =============================================== http { proxy_cache_path /tmp/cache keys_zone=tmpcache:10m; server { location / { proxy_pass http://127.0.0.1:8000; proxy_cache tmpcache; proxy_cache_key $uri$is_args$args; } location ~ /purge(/.*) { allow 127.0.0.1; deny all; proxy_cache_purge tmpcache $1$is_args$args; } } } Testing ======= `ngx_cache_purge` comes with complete test suite based on [Test::Nginx](http://github.com/agentzh/test-nginx). You can test it by running: `$ prove` License ======= Copyright (c) 2009-2012, FRiCKLE <info@frickle.com> Copyright (c) 2009-2012, Piotr Sikora <piotr.sikora@frickle.com> All rights reserved. This project was fully funded by yo.se. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. See also ======== - [ngx_slowfs_cache](http://github.com/FRiCKLE/ngx_slowfs_cache).