Path: | README (CVS) |
Last Update: | Mon Apr 29 09:35:47 +0000 2013 |
\Unicorn is an HTTP server for Rack applications designed to only serve fast clients on low-latency, high-bandwidth connections and take advantage of features in Unix/Unix-like kernels. Slow clients should only be served by placing a reverse proxy capable of fully buffering both the the request and response in between \Unicorn and slow clients.
\Unicorn is copyright 2009 by all contributors (see logs in git). It is based on Mongrel 1.1.5 and carries the same license.
Mongrel is copyright 2007 Zed A. Shaw and contributors. It is tri-licensed under (your choice) of the GPLv3, GPLv2 or Ruby-specific terms. See the included LICENSE file for details.
\Unicorn is 100% Free Software.
The library consists of a C extension so you‘ll need a C compiler and Ruby development libraries/headers.
You may download the tarball from the Mongrel project page on Rubyforge and run setup.rb after unpacking it:
rubyforge.org/frs/?group_id=1306
You may also install it via RubyGems on RubyGems.org:
gem install unicorn
You can get the latest source via git from the following locations (these versions may not be stable):
git://bogomips.org/unicorn.git git://repo.or.cz/unicorn.git (mirror)
You may browse the code from the web and download the latest snapshot tarballs here:
See the HACKING guide on how to contribute and build prerelease gems from git.
In APP_ROOT, run:
unicorn
In RAILS_ROOT, run:
unicorn_rails
\Unicorn will bind to all interfaces on TCP port 8080 by default. You may use the +—listen/-l+ switch to bind to a different address:port or a UNIX socket.
\Unicorn will look for the config.ru file used by rackup in APP_ROOT.
For deployments, it can use a config file for \Unicorn-specific options specified by the +—config-file/-c+ command-line switch. See Unicorn::Configurator for the syntax of the \Unicorn-specific options. The default settings are designed for maximum out-of-the-box compatibility with existing applications.
Most command-line options for other Rack applications (above) are also supported. Run `unicorn -h` or `unicorn_rails -h` to see command-line options.
There is NO WARRANTY whatsoever if anything goes wrong, but let us know and we‘ll try our best to fix it.
\Unicorn is designed to only serve fast clients either on the local host or a fast LAN. See the PHILOSOPHY and DESIGN documents for more details regarding this.
All feedback (bug reports, user/development dicussion, patches, pull requests) go to the mailing list/newsgroup. See the ISSUES document for information on the mailing list.
For the latest on \Unicorn releases, you may also finger us at unicorn@bogomips.org or check our NEWS page (and subscribe to our Atom feed).