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