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.github.io/], 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 GPLv2 or later.
  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 install it via RubyGems on RubyGems.org:
 101
 102   gem install rainbows
 103
 104 == Usage
 105
 106 === for Rack applications
 107
 108 In APP_ROOT (where config.ru is located), run:
 109
 110   rainbows
 111
 112 \Rainbows! will bind to all interfaces on TCP port 8080 by default.
 113
 114 === Configuration File(s)
 115
 116 \Rainbows! will look for the config.ru file used by rackup in APP_ROOT.
 117
 118 For deployments, it can use a config file for Unicorn and
 119 \Rainbows!-specific options specified by the +--config-file/-c+
 120 command-line switch.  \Rainbows! accepts all options found in
 121 {Unicorn::Configurator}[http://unicorn.bogomips.org/Unicorn/Configurator.html]
 122 as well as the "\Rainbows!" block, so you can have the following in your
 123 config file:
 124
 125     worker_processes 4 # assuming four CPU cores
 126     Rainbows! do
 127       use :FiberSpawn
 128       worker_connections 100
 129     end
 130
 131 See the {Rainbows! configuration}[link:Rainbows/Configurator.html]
 132 {documentation}[link:Rainbows/Configurator.html]
 133 for more details.
 134
 135 == Development
 136
 137 You can get the latest source via git from the following locations
 138 (these versions may not be stable):
 139
 140   git://bogomips.org/rainbows.git
 141   git://repo.or.cz/rainbows.git (mirror)
 142
 143 You may browse the code from the web and download the latest snapshot
 144 tarballs here:
 145
 146 * http://bogomips.org/rainbows.git (cgit)
 147 * http://repo.or.cz/w/rainbows.git (gitweb)
 148
 149 Inline patches (from "git format-patch") to the mailing list are
 150 preferred because they allow code review and comments in the reply to
 151 the patch.
 152
 153 We will adhere to mostly the same conventions for patch submissions as
 154 git itself.  See the Documentation/SubmittingPatches document
 155 distributed with git on on patch submission guidelines to follow.  Just
 156 don't email the git mailing list or maintainer with \Rainbows! patches.
 157
 158 == Disclaimer
 159
 160 There is NO WARRANTY whatsoever if anything goes wrong, but let us know
 161 and we'll try our best to fix it.
 162
 163 == Contact
 164
 165 All feedback (bug reports, user/development discussion, patches, pull
 166 requests) go to the mailing list.  Patches must be sent inline
 167 (git format-patch -M + git send-email).  No subscription is necessary
 168 to post on the mailing list.  No top posting.  Address replies +To:+
 169 the mailing list.
 170
 171 * email: mailto:rainbows-public@bogomips.org
 172 * subscribe: mailto:rainbows-public+subscribe@bogomips.org
 173 * archives: http://bogomips.org/rainbows-public/