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