Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Drop-in page caching using nginx, lua, and memcached
Ruby Lua MoonScript Shell
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
nginx
spec
src
.gitignore
.rvmrc
Gemfile
Guardfile
LICENSE
README.md
Rakefile
accelerator-1.0-1.rockspec
accelerator.gemspec
build

README.md

Nginx Accelerator

Drop-in page caching using nginx, lua, and memcached.

Features

  • Listens to Cache-Control max-age header
  • The memcached key is the URI (easy to expire on demand)
  • Really, really fast

Requirements

You'll need an nginx build with the following modules:

Configure nginx

nginx.conf

Drop the following line in any location directive:

access_by_lua "require('accelerator').access()";

For example:

http {
  server {
    listen 8080;

    location = / {
      access_by_lua "require('accelerator').access()";
    }
  }
}

The TTL is based on Cache-Control: max-age, but defaults to 10 seconds.

To configure your memcached connection information:

access_by_lua "require('accelerator').access({ host='127.0.0.1', port=11211 })";

Ruby client

Install gem

gem install accelerator

Example

cache = Accelerator.new("localhost:11211")
cache.get("/test")
cache.set("/test", "body")
cache.delete("/test") 
cache.expire("/test", 10)

Running specs

Install Lua and Moonscript

brew install lua
brew install luarocks
luarocks build http://moonscript.org/rocks/moonscript-0.2.3-2.rockspec

Add moonscript to your path:

export PATH=$PATH:/usr/local/lib/luarocks/bin/

Install nginx-accelerator rock via luarocks

git clone git://github.com/winton/nginx-accelerator.git
cd nginx-accelerator
luarocks make

Install PCRE

brew update
brew install pcre

Install OpenResty (nginx)

curl -O http://openresty.org/download/ngx_openresty-1.2.6.6.tar.gz
tar xzvf ngx_openresty-1.2.6.6.tar.gz
cd ngx_openresty-1.2.6.6/

Get your PCRE version:

brew info pcre

Replace VERSION below with the PCRE version:

./configure --with-luajit --with-cc-opt="-I/usr/local/Cellar/pcre/VERSION/include" --with-ld-opt="-L/usr/local/Cellar/pcre/VERSION/lib" --prefix=~/OpenResty
make
make install

Start nginx

cd nginx-accelerator
./nginx/start

Run specs

bundle install
bundle exec rspec spec
Something went wrong with that request. Please try again.