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.

Status

This module is production-ready.

Building as Dynamic Module on Ubuntu 20.04

1. Clone this repository just outside of the Nginx repo directory

git clone https://github.com/Danrancan/ngx_cache_purge_dynamic.git

2. Install build Essentials and Libraries

sudo apt update && sudo apt-get install build-essential libpcre3-dev libssl-dev zlib1g-dev libxml2-dev libxslt1-dev libgd-dev libgeoip-dev 

3. Get your current configure arguments with nginx -V
4. Navigate to your Nginx build directory and execute:

sudo ./configure --add-dynamic-module=../ngx_cache_purge_dynamic --with-compat --the-rest-of-your-configure-arguements

NOTE: Be sure to add the rest of the configure arguments from the output of nginx -V to the ./configure line above.

5. Make modules

sudo make modules

Your newly built module will be in objs/ngx_http_cache_purge_module.so

6. Move it to /etc/nginx/modules/

sudo mv objs/ngx_http_cache_purge_module.so /etc/nginx/modules/

7. Enable Nginx Cache Purge Module

sudo nano /etc/nginx/nginx.conf

8. Add the line load_module modules/ngx_http_cache_purge_module.so; to the top of your nginx.conf file.

user www-data www-data;
worker_processes auto;
pid /run/nginx.pid;
load_module modules/ngx_http_cache_purge_module.so;

http {

9. Restart nginx sudo service nginx restart

ALL DONE!

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.

You can test it by running:

$ prove

License

Copyright (c) 2009-2014, FRiCKLE <info@frickle.com>
Copyright (c) 2009-2014, 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.