README

   1 = Rainbows! Unicorn for sleepy apps and slow clients
   2
   3 Rainbows! is an 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 * {Revactor}[link:Rainbows/Revactor.html]
  17 * {ThreadPool}[link:Rainbows/ThreadPool.html]
  18 * {Rev}[link:Rainbows/Rev.html]
  19 * {ThreadSpawn}[link:Rainbows/ThreadSpawn.html]
  20 * {EventMachine}[link:Rainbows/EventMachine.html]
  21 * {RevThreadSpawn}[link:Rainbows/RevThreadSpawn.html]
  22 * {FiberSpawn}[link:Rainbows/FiberSpawn.html]
  23 * {FiberPool}[link:Rainbows/FiberPool.html]
  24 * {NeverBlock}[link:Rainbows/NeverBlock.html]
  25
  26 We have {many more on the way}[link:TODO.html] for handling network
  27 concurrency.  Additionally, we also use multiple processes (managed by
  28 Unicorn) for robustness and CPU/memory/disk concurrency.
  29
  30 We also provide Rainbows::AppPool Rack middleware for some network
  31 concurrency models for limiting application concurrency independently of
  32 network concurrency.
  33
  34 == Features
  35
  36 * Designed for {Rack}[http://rack.rubyforge.org/], the standard for
  37   modern Ruby HTTP applications.
  38
  39 * Built on {Unicorn}[http://unicorn.bogomips.org/], inheriting its
  40   process/socket management features such as transparent upgrades and
  41   Ruby configuration DSL.
  42
  43 * As with Unicorn, it is able to stream large request bodies off the
  44   socket to the application while the client is still uploading.  Since
  45   \Rainbows! can handle slow clients, this feature is more useful than
  46   it is with Unicorn.
  47
  48 * Combines heavyweight concurrency (worker processes) with lightweight
  49   concurrency (Events/Fibers/Actors/Threads), allowing CPU/memory/disk to
  50   be scaled independently of client connections.  More concurrency models
  51   (listed in the TODO) will be supported as we find time for them.
  52
  53 * We give you {lots of options}[link:Summary.html] with more
  54   {on the way}[link:TODO.html].
  55
  56 == Applications
  57
  58 \Rainbows is mainly designed for the odd things Unicorn sucks at:
  59
  60 * 3rd-party APIs (to services outside your control/LAN)
  61 * OpenID consumers (to providers outside your control/LAN)
  62 * Reverse proxy implementations with editing/censoring
  63   (to upstreams outside your control/LAN)
  64 * Comet
  65 * BOSH (with slow clients)
  66 * HTTP server push
  67 * Long polling
  68 * Reverse AJAX
  69 * HTML 5 Web Sockets
  70 * real-time upload processing
  71
  72 \Rainbows can also be used to service slow clients directly even with
  73 fast applications.
  74
  75 == License
  76
  77 \Rainbows! is copyright 2009 by all contributors (see logs in git).
  78 It is based on Mongrel and Unicorn and carries the same license.
  79
  80 Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed
  81 under the Ruby license and the GPL2. See the included LICENSE file for
  82 details.
  83
  84 \Rainbows! is 100% Free Software.
  85
  86 == Install
  87
  88 You may download the tarball from the Rainbows project page on Rubyforge
  89 and run setup.rb after unpacking it:
  90
  91 http://rubyforge.org/frs/?group_id=8977
  92
  93 You may also install it via RubyGems on Gemcutter:
  94
  95   gem install rainbows
  96
  97 == Usage
  98
  99 === for Rack applications
 100
 101 In APP_ROOT (where config.ru is located), run:
 102
 103   rainbows
 104
 105 \Rainbows! will bind to all interfaces on TCP port 8080 by default.
 106
 107 === Configuration File(s)
 108
 109 \Rainbows! will look for the config.ru file used by rackup in APP_ROOT.
 110
 111 For deployments, it can use a config file for Unicorn and
 112 \Rainbows!-specific options specified by the +--config-file/-c+
 113 command-line switch.  \Rainbows! accepts all options found in
 114 {Unicorn::Configurator}[http://unicorn.bogomips.org/Unicorn/Configurator.html]
 115 as well as the "\Rainbows!" block, so you can have the following in your
 116 config file:
 117
 118     Rainbows! do
 119       use :Revactor
 120       worker_connections 400
 121     end
 122
 123 See the {Rainbows! configuration documentation}[link:Rainbows.html#M000001]
 124 for more details.
 125
 126 == Development
 127
 128 You can get the latest source via git from the following locations
 129 (these versions may not be stable):
 130
 131   git://git.bogomips.org/rainbows.git
 132   git://repo.or.cz/rainbows.git (mirror)
 133
 134 You may browse the code from the web and download the latest snapshot
 135 tarballs here:
 136
 137 * http://git.bogomips.org/cgit/rainbows.git (cgit)
 138 * http://repo.or.cz/w/rainbows.git (gitweb)
 139
 140 Inline patches (from "git format-patch") to the mailing list are
 141 preferred because they allow code review and comments in the reply to
 142 the patch.
 143
 144 We will adhere to mostly the same conventions for patch submissions as
 145 git itself.  See the Documentation/SubmittingPatches document
 146 distributed with git on on patch submission guidelines to follow.  Just
 147 don't email the git mailing list or maintainer with \Rainbows! patches.
 148
 149 == Disclaimer
 150
 151 There is NO WARRANTY whatsoever if anything goes wrong, but let us know
 152 and we'll try our best to fix it.
 153
 154 == Contact
 155
 156 All feedback (bug reports, user/development dicussion, patches, pull
 157 requests) go to the mailing list/newsgroup.  Patches must be sent inline
 158 (git format-patch -M + git send-email).  No subscription is necessary
 159 to post on the mailing list.  No top posting.  Address replies +To:+
 160 the mailing list.
 161
 162 * email: mailto:rainbows-talk@rubyforge.org
 163 * nntp: nntp://news.gmane.org/gmane.comp.lang.ruby.rainbows.general
 164 * subscribe: http://rubyforge.org/mailman/listinfo/rainbows-talk
 165 * archives: http://rubyforge.org/pipermail/rainbows-talk