README

   1 = regurgitator - read-only Rack endpoints for MogileFS
   2
   3 regurgitator is a GPL-licensed library and Rack middleware for
   4 serving files stored in MogileFS.  It can be embedded inside
   5 any existing Rack application or be used as a standalone Rack app.
   6
   7 regurgitator talks directly to the underlying RDBMS powering MogileFS
   8 to avoid extra layers and latency.  regurgitator only needs
   9 read-only access to the RDBMS and can connect to slave databases.
  10
  11 == Rack Endpoints
  12
  13 regurgitator comes with your choice of three standard Rack endpoints for
  14 serving files stored in MogileFS.  Pick the one best suited for your
  15 application:
  16
  17 * {DomainPath}[link:Regurgitator/DomainPath.html]
  18 * {DomainHost}[link:Regurgitator/DomainHost.html]
  19 * {OneDomain}[link:Regurgitator/OneDomain.html]
  20
  21 It should also be easy to roll your own based on your needs by reusing
  22 our library code.  See {examples}[link:examples/] for rackup config files.
  23
  24 == Hacking
  25
  26 You can get the latest source via git from the following locations:
  27
  28   git://yhbt.net/regurgitator.git
  29   git://repo.or.cz/regurgitator.git (mirror)
  30
  31 You may browse the code from the web and download the latest snapshot
  32 tarballs here:
  33
  34 * https://yhbt.net/regurgitator.git
  35 * http://repo.or.cz/w/regurgitator.git (gitweb)
  36
  37 Inline patches (from "git format-patch") to the mailing list are
  38 preferred because they allow code review and comments in the reply to
  39 the patch.
  40
  41 We will adhere to mostly the same conventions for patch submissions as
  42 git itself.  See the Documentation/SubmittingPatches document
  43 distributed with git on on patch submission guidelines to follow.  Just
  44 don't email the git mailing list or maintainer with regurgitator patches.
  45
  46 == Contact
  47
  48 All feedback (bug reports, user/development discussion, patches, pull
  49 requests) go to the public mailing list: regurgitator-public@yhbt.net
  50
  51 Archives are available at https://yhbt.net/regurgitator-public/
  52 and nntp://news.public-inbox.org/inbox.comp.lang.ruby.regurgitator