README

   1 = Unicorn: Unix + LAN/localhost-optimized fork of Mongrel
   2
   3 Unicorn is designed to only serve fast clients.  See the PHILOSOPHY
   4 and DESIGN documents for more details regarding this.
   5
   6 == Features
   7
   8 * Built on the solid Mongrel code base and takes full advantage
   9   of functionality exclusive to Unix-like operating systems.
  10
  11 * Mostly written in Ruby, only the HTTP parser (stolen and trimmed
  12   down from Mongrel) is written in C.  Unicorn is compatible with
  13   both Ruby 1.8 and 1.9.
  14
  15 * Process management: Unicorn will reap and restart workers that
  16   die from broken apps.  There is no need to manage multiple processes
  17   yourself.
  18
  19 * Load balancing is done entirely by the operating system kernel.
  20   Requests never pile up behind a busy worker.
  21
  22 * Does not care if your application is thread-safe or not, workers
  23   all run within their own isolated address space and only serve one
  24   client at a time.
  25
  26 * Supports all Rack applications, along with pre-Rack versions of
  27   Ruby on Rails via a Rack wrapper.
  28
  29 * Builtin reopening of all log files in your application via
  30   USR1 signal.  This allows logrotate to rotate files atomically
  31   and quickly via rename instead of the racy and slow
  32   copytruncate method.
  33
  34 * nginx-style binary re-execution without losing connections.
  35   You can upgrade Unicorn, your entire application, libraries
  36   and even your Ruby interpreter as long as Unicorn is
  37   installed in the same path.
  38
  39 * before_fork and after_fork hooks in case your application
  40   has special needs when dealing with forked processes.  These
  41   should not be needed when the "preload_app" directive is
  42   false (the default).
  43
  44 * Can be used with copy-on-write-friendly memory management
  45   to save memory (by setting "preload_app" to true).
  46
  47 * Able to listen on multiple interfaces including UNIX sockets,
  48   each worker process can also bind to a private port via the
  49   after_fork hook for easy debugging.
  50
  51 == License
  52
  53 Unicorn is copyright 2009 Eric Wong and contributors.
  54 It is based on Mongrel and carries the same license:
  55
  56 Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed
  57 under the Ruby license and the GPL2. See the include LICENSE file for
  58 details.
  59
  60 Unicorn is 100% Free Software.
  61
  62 == Install
  63
  64 The library consists of a C extension so you'll need a C compiler or at
  65 least a friend who can build it for you.
  66
  67 You may download the tarball from the Mongrel project page on Rubyforge
  68 and run setup.rb after unpacking it:
  69
  70 http://rubyforge.org/frs/?group_id=1306
  71
  72 You may also install it via Rubygems on Rubyforge:
  73
  74   gem install unicorn
  75
  76 You can get the latest source via git from the following locations
  77 (these versions may not be stable):
  78
  79   git://git.bogomips.org/unicorn.git
  80   http://git.bogomips.org/unicorn.git
  81   git://repo.or.cz/unicorn.git (mirror)
  82   http://repo.or.cz/r/unicorn.git (mirror)
  83
  84 If you have web browser software for the World Wide Web
  85 (on the Information Superhighway), you may browse the code from
  86 your web browser and download the latest snapshot tarballs here:
  87
  88 * http://git.bogomips.org/cgit/unicorn.git (this server runs Unicorn!)
  89 * http://repo.or.cz/w/unicorn.git (gitweb mirror)
  90
  91 == Usage
  92
  93 === non-Rails Rack applications
  94
  95 In APP_ROOT, run:
  96
  97   unicorn
  98
  99 === for Rails applications (should work for all 1.2 or later versions)
 100
 101 In RAILS_ROOT, run:
 102
 103   unicorn_rails
 104
 105 Unicorn will bind to all interfaces TCP port 8080 by default.
 106 You may use the '-l/--listen' switch to bind to a different
 107 address:port or a UNIX socket.
 108
 109 === Configuration File(s)
 110
 111 Unicorn will look for the config.ru file used by rackup in APP_ROOT.
 112
 113 For deployments, it can use a config file for Unicorn-specific options
 114 specified by the --config-file/-c command-line switch.  See
 115 Unicorn::Configurator for the syntax of the Unicorn-specific options.
 116 The default settings are designed for maximum out-of-the-box
 117 compatibility with existing applications.
 118
 119 Most command-line options for other Rack applications (above) are also
 120 supported.  Run `unicorn -h` or `unicorn_rails -h` to see command-line
 121 options.
 122
 123 == Disclaimer
 124
 125 Like the creatures themselves, production deployments of Unicorn are rare.
 126 There is NO WARRANTY whatsoever if anything goes wrong, but let us know and
 127 we'll try our best to fix it.
 128
 129 Rainbows are NOT included.
 130
 131 == Known Issues
 132
 133 * WONTFIX: code reloading with Sinatra 0.3.2 (and likely older
 134   versions) apps is broken.  The workaround is to force production
 135   mode to disable code reloading in your Sinatra application:
 136     set :env, :production
 137   Since this is no longer an issue with Sinatra 0.9.x apps and only
 138   affected non-production instances, this will not be fixed on our end.
 139   Also remember we're capable of replacing the running binary without
 140   dropping any connections regardless of framework :)
 141
 142 == Contact
 143
 144 Newsgroup and mailing list maybe coming...
 145 Email Eric Wong at normalperson@yhbt.net for now.