README

   1 = Rainbows! Unicorn for sleepy apps and slow clients
   2
   3 Rainbows! is a HTTP server for sleepy Rack applications.  It is based on
   4 Unicorn, but designed to handle applications that expect long
   5 request/response times and/or slow clients.  For Rack applications not
   6 heavily bound by slow external network dependencies, consider Unicorn
   7 instead as it simpler and easier to debug.
   8
   9 == \Rainbows! is about Diversity
  10
  11 We aim to support as many concurrency models as we can because they all
  12 suck; differently.
  13
  14 For network concurrency, models we currently support are:
  15
  16 * {:ThreadSpawn}[link:Rainbows/ThreadSpawn.html]
  17 * {:ThreadPool}[link:Rainbows/ThreadPool.html]
  18 * {:Revactor}[link:Rainbows/Revactor.html]
  19
  20 We have {more on the way}[link:TODO.html] for handling network concurrency.
  21 Additionally, we also use multiple processes (managed by Unicorn) for
  22 CPU/memory/disk concurrency.
  23
  24 == Features
  25
  26 * Designed for {Rack}[http://rack.rubyforge.org/], the standard for
  27   modern Ruby HTTP applications.
  28
  29 * Built on {Unicorn}[http://unicorn.bogomips.org/], inheriting its
  30   process/socket management features
  31   such as transparent upgrades and Ruby configuration DSL.
  32
  33 * As with Unicorn, it is able to stream large request bodies off the
  34   socket to the application while the client is still uploading.  Since
  35   \Rainbows! can handle slow clients, this feature is more useful than
  36   it is with Unicorn.
  37
  38 * Combines heavyweight concurrency (worker processes) with lightweight
  39   concurrency (Actors or Threads), allowing CPU/memory/disk to be scaled
  40   independently of client connections.  Alternative concurrency models
  41   (listed in the TODO) will be supported as we find time for them.
  42
  43 == Applications
  44
  45 \Rainbows is for the odd things Unicorn sucks at:
  46
  47 * 3rd-party APIs (to services outside your control/LAN)
  48 * OpenID consumers (to providers outside your control/LAN)
  49 * Reverse proxy implementations with editing/censoring
  50   (to upstreams outside your control/LAN)
  51 * Comet
  52 * BOSH (with slow clients)
  53 * HTTP server push
  54 * Long polling
  55 * Reverse Ajax
  56
  57 == License
  58
  59 \Rainbows! is copyright 2009 by all contributors (see logs in git).
  60 It is based on Mongrel and Unicorn and carries the same license.
  61
  62 Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed
  63 under the Ruby license and the GPL2. See the included LICENSE file for
  64 details.
  65
  66 \Rainbows! is 100% Free Software.
  67
  68 == Install
  69
  70 You may download the tarball from the Rainbows project page on Rubyforge
  71 and run setup.rb after unpacking it:
  72
  73 http://rubyforge.org/frs/?group_id=8977
  74
  75 You may also install it via Rubygems on Rubyforge:
  76
  77   gem install rainbows
  78
  79 == Usage
  80
  81 === for Rack applications
  82
  83 In APP_ROOT (where config.ru is located), run:
  84
  85   rainbows
  86
  87 \Rainbows! will bind to all interfaces on TCP port 8080 by default.
  88
  89 === Configuration File(s)
  90
  91 \Rainbows! will look for the config.ru file used by rackup in APP_ROOT.
  92
  93 For deployments, it can use a config file for Unicorn and
  94 \Rainbows!-specific options specified by the +--config-file/-c+
  95 command-line switch.  \Rainbows! accepts all options found in
  96 {Unicorn::Configurator}[http://unicorn.bogomips.org/Unicorn/Configurator.html]
  97 as well as the "\Rainbows!" block, so you can have the following in your
  98 config file:
  99
 100     Rainbows! do
 101       use :Revactor
 102       worker_connections 400
 103     end
 104
 105 See the {Rainbows! configuration documentation}[link:Rainbows.html#M000001]
 106 for more details.
 107
 108 == Development
 109
 110 * git: git://git.bogomips.org/rainbows.git
 111 * cgit: http://git.bogomips.org/cgit/rainbows.git
 112
 113 Inline patches (from "git format-patch") to the mailing list are
 114 preferred because they allow code review and comments in the reply to
 115 the patch.
 116
 117 We will adhere to mostly the same conventions for patch submissions as
 118 git itself.  See the Documentation/SubmittingPatches document
 119 distributed with git on on patch submission guidelines to follow.  Just
 120 don't email the git mailing list or maintainer with \Rainbows! patches.
 121
 122 == Disclaimer
 123
 124 There is NO WARRANTY whatsoever if anything goes wrong, but let us know
 125 and we'll try our best to fix it.
 126
 127 == Contact
 128
 129 All feedback (bug reports, user/development dicussion, patches, pull
 130 requests) go to the mailing list/newsgroup.  Patches must be sent inline
 131 (git format-patch -M + git send-email).  No subscription is necessary
 132 to post on the mailing list.  No top posting.  Address replies +To:+
 133 the mailing list.
 134
 135 * email: mailto:rainbows-talk@rubyforge.org
 136 * archives: http://rubyforge.org/pipermail/rainbows-talk
 137 * subscribe: http://rubyforge.org/mailman/listinfo/rainbows-talk