https://github.com/colinmollenhour/node-caching-proxy

A caching reverse proxy powered by Node.js and MongoDb.
https://github.com/colinmollenhour/node-caching-proxy

Last synced: 16 days ago
JSON representation

A caching reverse proxy powered by Node.js and MongoDb.

• Host: GitHub
• URL: https://github.com/colinmollenhour/node-caching-proxy
• Owner: colinmollenhour
• License: other
• Created: 2012-12-28T08:02:27.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-10-29T23:28:07.000Z (about 11 years ago)
• Last Synced: 2024-10-04T13:35:20.635Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 162 KB
• Stars: 19
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Node.js Caching Reverse HTTP Proxy #

cachingReverseProxy is a connect middleware which reverse-proxies requests to

an upstream server with full support for RFC2616 protocol and then some.

It utilizes MongoDb as the default cache storage backend but could easily be

extended with other backends.

The primary feature that sets this caching proxy apart from others is the

full support for ETag, Vary and revalidate requests including simultaneous

storage for multiple versions of the same page and allowing the origin to

select from them with If-None-Match (server-side content-negotiation).

## Status: ALPHA

## Example Application

``` js

    var connect = require('connect');

    var cachingProxy = require('caching-proxy');

    var gatewayErrorApp = connect()

      .use(connect.logger('errors'))

      .use(function(req, res) { res.write("We'll be right back!"); });

    var proxyApp = connect()

      .use(connect.logger('dev'))

      .use(cachingProxy.createProxy(

        {

          debug: false,

          defaultExpiration: 3600,

          defaultLifetime: 3600,

          target: {host: 'app1.example.com', port: 80},

        //  distribution: 'weighted',

        //  upstreams: [

        //    {host: app1.example.com, port: 80, weight: 5},

        //    {host: app2.example.com, port: 80, weight: 2},

        //    {host: app3.example.com, port: 80, backup: true},

        //  ],

        //  badGateway: gatewayErrorApp,

        //  gatewayTimeout: gatewayErrorApp

        },

        cacheBackend: cachingProxy.backends.mongodb({

            server: 'mongodb://127.0.0.1:27017/proxy_cache'

        }

      );

    var mainApp = connect()

      .use(connect.vhost('example.com', proxyApp))

      .use(function(req, res){

        res.end('Oops!');

      })

      .listen(3000);

```

## Special (Non-RFC) Features

### X-Accel-Expires ("off"|int)

Set to "off" to prevent caching, or give a lifetime in seconds for the cache to

hold the page in storage.

### X-Accel-Cache-Control (cache_control)

If an X-Accel-Cache-Control header is present it will be used in place of the

Cache-Control header in determining the caching policy. This allows the origin

to specify a separate Cache-Control header for clients and the proxy.

### X-Accel-Cloak (header_name, ...)

List of headers which should be removed from the response before proxying

upstream. All X-Accel headers will be removed regardless.

### X-Accel-Vary-Cookie (cookie_name, ...)

When used in conjunction with "Vary: *" this header tells the proxy which

cookie value was used to determine the response. Allows simultaneous use of

ETag/Vary and anti-stampeding if the client's identifying cookie is present.

## TODO

 - Add anti-stampeding feature (serve stale response when already updating a given page)

 - Add pre-fetching of 503 pages in case upstream becomes unreachable and no stale record exists

## License

This module is distributed under the GPLv3 license. To receive a copy

under a different license please contact the author.

http-caching-proxy

Copyright (C) 2013  Colin Mollenhour (http://colin.mollenhour.com)

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see http://www.gnu.org/licenses/