Unicorn: Rack HTTP server for fast clients and Unix

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.

Features

License

Unicorn is copyright 2009 by all contributors (see logs in git). It is based on Mongrel 1.1.5. Mongrel is copyright 2007 Zed A. Shaw and contributors.

Unicorn is licensed under (your choice) of the GPLv2 or later (GPLv3+ preferred), or Ruby (1.8)-specific terms. See the included LICENSE file for details.

Unicorn is 100% Free Software.

Install

The library consists of a C extension so you'll need a C compiler and Ruby development libraries/headers.

You may 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.

Usage

non-Rails Rack applications

In APP_ROOT, run:

unicorn

for Rails applications (should work for all 1.2 or later versions)

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.

Configuration File(s)

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.

Disclaimer

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.

Contact

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).

Originally generated with the Darkfish Rdoc Generator 2, modified by wrongdoc.

We love to hear from you!
Email patches (with git send-email), pull requests, questions, bug reports, suggestions, etc. to us publically at: unicorn-public@bogomips.org
This is a public-inbox with no sign up required. Please Cc: all recipients on replies, as not everybody subscribes with ssoma.
See http://bogomips.org/unicorn-public/ for archives and more information.
Do not waste bandwidth with HTML, HTML mail will not be read.
Quote only parts you're responding to and do not top post.
For sensitive topics, email us privately at: unicorn@bogomips.org