Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Unofficial Unicorn Mirror.
Ruby Shell Ragel in Ruby Host C Makefile Nginx

apply TCP socket options on inherited sockets

TCP socket options are now set when inheriting existing sockets from
a parent process.  I'm fairly certain all the TCP setsockopt knobs
we use are idempotent and harmless to change.

If anything, the only directive I'd be uncomfortable changing is
shortening the listen(2) (aka :backlog) size, but we've always
changed that anyways since it also applies to UNIX sockets.

Note: removing a configuration knob in a unicorn config file can not
reset the value to the OS-provided default setting.  Inherited
sockets must use a new setting to override existing ones.
(or the socket needs to be closed and re-created in the process
 launcher before unicorn inherits it).

Noticed-by: Christos Trochalakis <>
latest commit 1db9a8243d
Eric Wong authored
Failed to load latest commit information.
Documentation doc: update some invalid URLs
archive add slrnpull.conf example for gmane archives
bin favor more string literals for cold call sites
examples remove old inetd+git examples and exec_cgi
ext/unicorn_http http: move response_start_sent into the C ext
lib apply TCP socket options on inherited sockets
t ensure body is closed during hijack
test ensure body is closed during hijack
.CHANGELOG.old Remove Echoe and roll our own packaging/release...
.document switch docs + website to olddoc
.gitignore switch docs + website to olddoc
.mailmap Add .mailmap file for "git shortlog" and other tools
.olddoc.yml switch docs + website to olddoc
Application_Timeouts doc: add Application Timeouts document
COPYING add GPLv3 option to the license
DESIGN doc: update doc for Ruby 2.0.0dev CoW-friendliness
FAQ FAQ: reorder bit on Rack 1.1.x and Rails 2.3.x
GIT-VERSION-GEN unicorn 5.0.0.pre1 - incompatible changes!
GNUmakefile www: install NEWS.atom.xml properly
HACKING doc: update support status for Ruby versions
ISSUES ISSUES: discourage HTML mail strongly, welcome nyms
KNOWN_ISSUES doc: update some invalid URLs
LICENSE license: allow all future versions of the GNU GPL
Links doc: update some invalid URLs
PHILOSOPHY swap out most of the links
README doc: update some invalid URLs
Rakefile remove RubyForge and Freecode references
SIGNALS doc: update some invalid URLs
Sandbox doc: update some invalid URLs
TODO TODO: remove scalability to >= 1024 workers item
TUNING doc: document Etc.nprocessors for worker_processes
setup.rb "encoding: binary" comments for all sources (1.9)
unicorn.gemspec gemspec: fixup olddoc migration


= 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

* Designed for Rack, Unix, fast clients, and ease-of-debugging.  We
  cut out everything that is better supported by the operating system,
  {nginx}[] or {Rack}[].

* Compatible with Ruby 1.9.3 and later.
  unicorn 4.8.x will remain supported for Ruby 1.8 users.

* Process management: \Unicorn will reap and restart workers that
  die from broken apps.  There is no need to manage multiple processes
  or ports yourself.  \Unicorn can spawn and manage any number of
  worker processes you choose to scale to your backend.

* Load balancing is done entirely by the operating system kernel.
  Requests never pile up behind a busy worker process.

* Does not care if your application is thread-safe or not, workers
  all run within their own isolated address space and only serve one
  client at a time for maximum robustness.

* Supports all Rack applications, along with pre-Rack versions of
  Ruby on Rails via a Rack wrapper.

* Builtin reopening of all log files in your application via
  USR1 signal.  This allows logrotate to rotate files atomically and
  quickly via rename instead of the racy and slow copytruncate method.
  \Unicorn also takes steps to ensure multi-line log entries from one
  request all stay within the same file.

* nginx-style binary upgrades without losing connections.
  You can upgrade \Unicorn, your entire application, libraries
  and even your Ruby interpreter without dropping clients.

* before_fork and after_fork hooks in case your application
  has special needs when dealing with forked processes.  These
  should not be needed when the "preload_app" directive is
  false (the default).

* Can be used with copy-on-write-friendly memory management
  to save memory (by setting "preload_app" to true).

* Able to listen on multiple interfaces including UNIX sockets,
  each worker process can also bind to a private port via the
  after_fork hook for easy debugging.

* Simple and easy Ruby DSL for configuration.

* Decodes chunked transfers on-the-fly, thus allowing upload progress
  notification to be implemented as well as being able to tunnel
  arbitrary stream-based protocols over HTTP.

== 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

  gem install unicorn

You can get the latest source via git from the following locations
(these versions may not be stable):

  git:// (mirror)

You may browse the code from the web and download the latest snapshot
tarballs here:

* (cgit)
* (gitweb)

See the HACKING guide on how to contribute and build prerelease gems
from git.

== Usage

=== Rack (including Rails 3+) applications

In APP_ROOT, run:


=== Ancient Rails 1.2 - 2.x versions



\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 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` to see command-line options.

== Disclaimer

There is NO WARRANTY whatsoever if anything goes wrong, but
{let us know}[link:ISSUES.html] 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 or check our NEWS page (and subscribe to our Atom
Something went wrong with that request. Please try again.