Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme added at least detailing some dependencies #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme added at least detailing some dependencies #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d75e5e
Readme added at least detailing some dependencies
hexgnu Oct 5, 2015
ee0853e
some more dependencies I see
hexgnu Oct 5, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,47 @@
luchador
========

Luchador is a project that utilizes the speed of Lua and Memcached to bring page caching to Nginx. It does this in an easy to configure fashion unlike Varnish.

The goal of Luchador is to be easy to use as well as close in speed with Varnish.

How to setup
============

Dependencies
------------

Luchador has a few dependencies:
* luarocks
* lzlib
* lua-messagepack
* lua-resty-memcached (https://github.com/agentzh/lua-resty-memcached/archive/v#{lua_memcached_version}.tar.gz)
* nginx with lua configured
* luajit
* lua-nginx-module https://github.com/openresty/lua-nginx-module


Vanilla Setup
-------------

After all of those files are installed then someone needs to run a make install on the server


Heroku
------

TBD


Chef Recipe
------------

TBD

Speed
======

this is where we can put results from speed differences vs varnish vs plain caching.

Maintainers
============