README

   1 = unicorn: Rack HTTP server for fast clients and Unix
   2
   3 unicorn is an HTTP server for Rack applications designed to only serve
   4 fast clients on low-latency, high-bandwidth connections and take
   5 advantage of features in Unix/Unix-like kernels.  Slow clients should
   6 only be served by placing a reverse proxy capable of fully buffering
   7 both the the request and response in between unicorn and slow clients.
   8
   9 == Features
  10
  11 * Designed for Rack, Unix, fast clients, and ease-of-debugging.  We
  12   cut out everything that is better supported by the operating system,
  13   {nginx}[https://nginx.org/] or {Rack}[https://rack.github.io/].
  14
  15 * Compatible with Ruby 1.9.3 and later.
  16   unicorn 4.x remains supported for Ruby 1.8 users.
  17
  18 * Process management: unicorn will reap and restart workers that
  19   die from broken apps.  There is no need to manage multiple processes
  20   or ports yourself.  unicorn can spawn and manage any number of
  21   worker processes you choose to scale to your backend.
  22
  23 * Load balancing is done entirely by the operating system kernel.
  24   Requests never pile up behind a busy worker process.
  25
  26 * Does not care if your application is thread-safe or not, workers
  27   all run within their own isolated address space and only serve one
  28   client at a time for maximum robustness.
  29
  30 * Builtin reopening of all log files in your application via
  31   USR1 signal.  This allows logrotate to rotate files atomically and
  32   quickly via rename instead of the racy and slow copytruncate method.
  33   unicorn also takes steps to ensure multi-line log entries from one
  34   request all stay within the same file.
  35
  36 * nginx-style binary upgrades without losing connections.
  37   You can upgrade unicorn, your entire application, libraries
  38   and even your Ruby interpreter without dropping clients.
  39
  40 * transparent upgrades using systemd socket activation is
  41   supported since unicorn 5.0
  42
  43 * before_fork and after_fork hooks in case your application
  44   has special needs when dealing with forked processes.  These
  45   should not be needed when the "preload_app" directive is
  46   false (the default).
  47
  48 * Can be used with copy-on-write-friendly GC in Ruby 2.0+
  49   to save memory (by setting "preload_app" to true).
  50
  51 * Able to listen on multiple interfaces including UNIX sockets,
  52   each worker process can also bind to a private port via the
  53   after_fork hook for easy debugging.
  54
  55 * Simple and easy Ruby DSL for configuration.
  56
  57 * Decodes chunked requests on-the-fly.
  58
  59 == License
  60
  61 unicorn is copyright 2009-2018 by all contributors (see logs in git).
  62 It is based on Mongrel 1.1.5.
  63 Mongrel is copyright 2007 Zed A. Shaw and contributors.
  64
  65 unicorn is licensed under (your choice) of the GPLv2 or later
  66 (GPLv3+ preferred), or Ruby (1.8)-specific terms.
  67 See the included LICENSE file for details.
  68
  69 unicorn is 100% Free Software (including all development tools used).
  70
  71 == Install
  72
  73 The library consists of a C extension so you'll need a C compiler
  74 and Ruby development libraries/headers.
  75
  76 You may install it via RubyGems on RubyGems.org:
  77
  78   gem install unicorn
  79
  80 You can get the latest source via git from the following locations
  81 (these versions may not be stable):
  82
  83   https://yhbt.net/unicorn.git
  84   https://repo.or.cz/unicorn.git (mirror)
  85
  86 You may browse the code from the web:
  87
  88 * https://yhbt.net/unicorn.git
  89 * https://repo.or.cz/w/unicorn.git (gitweb)
  90
  91 See the HACKING guide on how to contribute and build prerelease gems
  92 from git.
  93
  94 == Usage
  95
  96 === Rack (including Rails 3+) applications
  97
  98 In APP_ROOT, run:
  99
 100   unicorn
 101
 102 unicorn will bind to all interfaces on TCP port 8080 by default.
 103 You may use the +--listen/-l+ switch to bind to a different
 104 address:port or a UNIX socket.
 105
 106 === Configuration File(s)
 107
 108 unicorn will look for the config.ru file used by rackup in APP_ROOT.
 109
 110 For deployments, it can use a config file for unicorn-specific options
 111 specified by the +--config-file/-c+ command-line switch.  See
 112 Unicorn::Configurator for the syntax of the unicorn-specific options.
 113 The default settings are designed for maximum out-of-the-box
 114 compatibility with existing applications.
 115
 116 Most command-line options for other Rack applications (above) are also
 117 supported.  Run `unicorn -h` to see command-line options.
 118
 119 == Disclaimer
 120
 121 There is NO WARRANTY whatsoever if anything goes wrong, but
 122 {let us know}[link:ISSUES.html] and we'll try our best to fix it.
 123
 124 unicorn is designed to only serve fast clients either on the local host
 125 or a fast LAN.  See the PHILOSOPHY and DESIGN documents for more details
 126 regarding this.
 127
 128 Due to its ability to tolerate crashes and isolate clients, unicorn
 129 is unfortunately known to prolong the existence of bugs in applications
 130 and libraries which run on top of it.
 131
 132 == Contact
 133
 134 All feedback (bug reports, user/development dicussion, patches, pull
 135 requests) go to the mailing list/newsgroup.  See the ISSUES document for
 136 information on the {mailing list}[mailto:unicorn-public@yhbt.net].
 137
 138 The mailing list is archived at https://yhbt.net/unicorn-public/
 139 Read-only NNTP access is available at:
 140 nntp://news.public-inbox.org/inbox.comp.lang.ruby.unicorn and
 141 nntp://news.gmane.io/gmane.comp.lang.ruby.unicorn.general
 142
 143 For the latest on unicorn releases, you may also finger us at
 144 unicorn@yhbt.net or check our NEWS page (and subscribe to our Atom
 145 feed).