1 = Rainbows! Unicorn for sleepy apps and slow clients
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.
9 == \Rainbows! is about Diversity
11 We aim to support as many concurrency models as we can because they all
14 For network concurrency, models we currently support are:
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]
25 We have {many more on the way}[link:TODO.html] for handling network
26 concurrency. Additionally, we also use multiple processes (managed by
27 Unicorn) for robustness and CPU/memory/disk concurrency.
29 We also provide Rainbows::AppPool Rack middleware for some network
30 concurrency models for limiting application concurrency independently of
35 * Designed for {Rack}[http://rack.rubyforge.org/], the standard for
36 modern Ruby HTTP applications.
38 * Built on {Unicorn}[http://unicorn.bogomips.org/], inheriting its
39 process/socket management features such as transparent upgrades and
40 Ruby configuration DSL.
42 * As with Unicorn, it is able to stream large request bodies off the
43 socket to the application while the client is still uploading. Since
44 \Rainbows! can handle slow clients, this feature is more useful than
47 * Combines heavyweight concurrency (worker processes) with lightweight
48 concurrency (Events/Fibers/Actors/Threads), allowing CPU/memory/disk to
49 be scaled independently of client connections. More concurrency models
50 (listed in the TODO) will be supported as we find time for them.
52 * We give you {lots of options}[link:Summary.html] with more
53 {on the way}[link:TODO.html].
57 \Rainbows is mainly designed for the odd things Unicorn sucks at:
59 * 3rd-party APIs (to services outside your control/LAN)
60 * OpenID consumers (to providers outside your control/LAN)
61 * Reverse proxy implementations with editing/censoring
62 (to upstreams outside your control/LAN)
64 * BOSH (with slow clients)
69 * real-time upload processing
71 \Rainbows can also be used to service slow clients directly even with
76 \Rainbows! is copyright 2009 by all contributors (see logs in git).
77 It is based on Mongrel and Unicorn and carries the same license.
79 Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed
80 under the Ruby license and the GPL2. See the included LICENSE file for
83 \Rainbows! is 100% Free Software.
87 You may download the tarball from the Rainbows project page on Rubyforge
88 and run setup.rb after unpacking it:
90 http://rubyforge.org/frs/?group_id=8977
92 You may also install it via RubyGems on Gemcutter:
98 === for Rack applications
100 In APP_ROOT (where config.ru is located), run:
104 \Rainbows! will bind to all interfaces on TCP port 8080 by default.
106 === Configuration File(s)
108 \Rainbows! will look for the config.ru file used by rackup in APP_ROOT.
110 For deployments, it can use a config file for Unicorn and
111 \Rainbows!-specific options specified by the +--config-file/-c+
112 command-line switch. \Rainbows! accepts all options found in
113 {Unicorn::Configurator}[http://unicorn.bogomips.org/Unicorn/Configurator.html]
114 as well as the "\Rainbows!" block, so you can have the following in your
119 worker_connections 400
122 See the {Rainbows! configuration documentation}[link:Rainbows.html#M000001]
127 You can get the latest source via git from the following locations
128 (these versions may not be stable):
130 git://git.bogomips.org/rainbows.git
131 git://repo.or.cz/rainbows.git (mirror)
133 You may browse the code from the web and download the latest snapshot
136 * http://git.bogomips.org/cgit/rainbows.git (cgit)
137 * http://repo.or.cz/w/rainbows.git (gitweb)
139 Inline patches (from "git format-patch") to the mailing list are
140 preferred because they allow code review and comments in the reply to
143 We will adhere to mostly the same conventions for patch submissions as
144 git itself. See the Documentation/SubmittingPatches document
145 distributed with git on on patch submission guidelines to follow. Just
146 don't email the git mailing list or maintainer with \Rainbows! patches.
150 There is NO WARRANTY whatsoever if anything goes wrong, but let us know
151 and we'll try our best to fix it.
155 All feedback (bug reports, user/development dicussion, patches, pull
156 requests) go to the mailing list/newsgroup. Patches must be sent inline
157 (git format-patch -M + git send-email). No subscription is necessary
158 to post on the mailing list. No top posting. Address replies +To:+
161 * email: mailto:rainbows-talk@rubyforge.org
162 * nntp: nntp://news.gmane.org/gmane.comp.lang.ruby.rainbows.general
163 * subscribe: http://rubyforge.org/mailman/listinfo/rainbows-talk
164 * archives: http://rubyforge.org/pipermail/rainbows-talk