= regurgitator - read-only Rack endpoints for MogileFS

regurgitator is a GPL-licensed library and Rack middleware for
serving files stored in MogileFS.  It can be embedded inside
any existing Rack application or be used as a standalone Rack app.

regurgitator talks directly to the underlying RDBMS powering MogileFS
to avoid extra layers and latency.  regurgitator only needs
read-only access to the RDBMS and can connect to slave databases.

== Rack Endpoints

regurgitator comes with your choice of three standard Rack endpoints for
serving files stored in MogileFS.  Pick the one best suited for your
application:

* {DomainPath}[link:Regurgitator/DomainPath.html]
* {DomainHost}[link:Regurgitator/DomainHost.html]
* {OneDomain}[link:Regurgitator/OneDomain.html]

It should also be easy to roll your own based on your needs by reusing
our library code.  See {examples}[link:examples/] for rackup config files.

== Hacking

You can get the latest source via git from the following locations:

  git://yhbt.net/regurgitator.git
  git://repo.or.cz/regurgitator.git (mirror)

You may browse the code from the web and download the latest snapshot
tarballs here:

* https://yhbt.net/regurgitator.git
* http://repo.or.cz/w/regurgitator.git (gitweb)

Inline patches (from "git format-patch") to the mailing list are
preferred because they allow code review and comments in the reply to
the patch.

We will adhere to mostly the same conventions for patch submissions as
git itself.  See the Documentation/SubmittingPatches document
distributed with git on on patch submission guidelines to follow.  Just
don't email the git mailing list or maintainer with regurgitator patches.

== Contact

All feedback (bug reports, user/development discussion, patches, pull
requests) go to the public mailing list: regurgitator-public@yhbt.net

Archives are available at https://yhbt.net/regurgitator-public/
and nntp://news.public-inbox.org/inbox.comp.lang.ruby.regurgitator