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