Documentation/unicorn.1.txt

   1 % UNICORN(1) Unicorn User Manual
   2 % The Unicorn Community <mongrel-unicorn@rubyforge.org>
   3 % September 15, 2009
   4
   5 # NAME
   6
   7 unicorn - a rackup-like command to launch the Unicorn HTTP server
   8
   9 # SYNOPSIS
  10
  11 unicorn [-c CONFIG_FILE] [-E RACK_ENV] [-D] [RACKUP_FILE]
  12
  13 # DESCRIPTION
  14
  15 A rackup(1)-like command to launch Rack applications using Unicorn.
  16 It is expected to be started in your application root (APP_ROOT),
  17 but the "working_directory" directive may be used in the CONFIG_FILE.
  18
  19 While unicorn takes a myriad of command-line options for
  20 compatibility with ruby(1) and rackup(1), it is recommended to stick
  21 to the few command-line options specified in the SYNOPSIS and use
  22 the CONFIG_FILE as much as possible.
  23
  24 # RACKUP FILE
  25
  26 This defaults to \"config.ru\" in APP_ROOT.  It should be the same
  27 file used by rackup(1) and other Rack launchers, it uses the
  28 *Rack::Builder* DSL.
  29
  30 Embedded command-line options are mostly parsed for compatibility
  31 with rackup(1) but strongly discouraged.
  32
  33 # UNICORN OPTIONS
  34 -c, \--config-file CONFIG_FILE
  35 :   Path to the Unicorn-specific config file.  The config file is
  36     implemented as a Ruby DSL, so Ruby code may executed.
  37     See the RDoc/ri for the *Unicorn::Configurator* class for the full
  38     list of directives available from the DSL.
  39     Using an absolute path for for CONFIG_FILE is recommended as it
  40     makes multiple instances of Unicorn easily distinguishable when
  41     viewing ps(1) output.
  42
  43 -D, \--daemonize
  44 :   Run daemonized in the background.  The process is detached from
  45     the controlling terminal and stdin is redirected to "/dev/null".
  46     Unlike many common UNIX daemons, we do not chdir to \"/\"
  47     upon daemonization to allow more control over the startup/upgrade
  48     process.
  49     Unless specified in the CONFIG_FILE, stderr and stdout will
  50     also be redirected to "/dev/null".
  51
  52 -E, \--env RACK_ENV
  53 :   Run under the given RACK_ENV.  See the RACK ENVIRONMENT section
  54     for more details.
  55
  56 -l, \--listen ADDRESS
  57 :   Listens on a given ADDRESS.  ADDRESS may be in the form of
  58     HOST:PORT or PATH, HOST:PORT is taken to mean a TCP socket
  59     and PATH is meant to be a path to a UNIX domain socket.
  60     Defaults to "0.0.0.0:8080" (all addresses on TCP port 8080)
  61     For production deployments, specifying the "listen" directive in
  62     CONFIG_FILE is recommended as it allows fine-tuning of socket
  63     options.
  64
  65 # RACKUP COMPATIBILITY OPTIONS
  66 -o, \--host HOST
  67 :   Listen on a TCP socket belonging to HOST, default is
  68     "0.0.0.0" (all addresses).
  69     If specified multiple times on the command-line, only the
  70     last-specified value takes effect.
  71     This option only exists for compatibility with the rackup(1) command,
  72     use of "-l"/"\--listen" switch is recommended instead.
  73
  74 -p, \--port PORT
  75 :   Listen on the specified TCP PORT, default is 8080.
  76     If specified multiple times on the command-line, only the last-specified
  77     value takes effect.
  78     This option only exists for compatibility with the rackup(1) command,
  79     use of "-l"/"\--listen" switch is recommended instead.
  80
  81 -s, \--server SERVER
  82 :   No-op, this exists only for compatibility with rackup(1).
  83
  84 # RUBY OPTIONS
  85 -e, \--eval LINE
  86 :   Evaluate a LINE of Ruby code.  This evaluation happens
  87     immediately as the command-line is being parsed.
  88
  89 -d, \--debug
  90 :   Turn on debug mode, the $DEBUG variable is set to true.
  91
  92 -w, \--warn
  93 :   Turn on verbose warnings, the $VERBOSE variable is set to true.
  94
  95 -I, \--include PATH
  96 :   specify $LOAD_PATH.  PATH will be prepended to $LOAD_PATH.
  97     The \':\' character may be used to delimit multiple directories.
  98     This directive may be used more than once.  Modifications to
  99     $LOAD_PATH take place immediately and in the order they were
 100     specified on the command-line.
 101
 102 -r, \--require LIBRARY
 103 :   require a specified LIBRARY before executing the application.  The
 104     \"require\" statement will be executed immediately and in the order
 105     they were specified on the command-line.
 106
 107 # SIGNALS
 108
 109 The following UNIX signals may be sent to the master process:
 110
 111 * HUP - reload config file, app, and gracefully restart all workers
 112 * INT/TERM - quick shutdown, kills all workers immediately
 113 * QUIT - graceful shutdown, waits for workers to finish their
 114   current request before finishing.
 115 * USR1 - reopen all logs owned by the master and all workers
 116   See Unicorn::Util.reopen_logs for what is considered a log.
 117 * USR2 - reexecute the running binary.  A separate QUIT
 118   should be sent to the original process once the child is verified to
 119   be up and running.
 120 * WINCH - gracefully stops workers but keep the master running.
 121   This will only work for daemonized processes.
 122 * TTIN - increment the number of worker processes by one
 123 * TTOU - decrement the number of worker processes by one
 124
 125 See the [SIGNALS][4] document for full description of all signals
 126 used by Unicorn.
 127
 128 #  RACK ENVIRONMENT
 129
 130 Accepted values of RACK_ENV and the middleware they automatically load
 131 (outside of RACKUP_FILE) are exactly as those in rackup(1):
 132
 133 * development - loads Rack::CommonLogger, Rack::ShowExceptions, and
 134                 Rack::Lint middleware
 135 * deployment  - loads Rack::CommonLogger middleware
 136 * none        - loads no middleware at all, relying
 137                 entirely on RACKUP_FILE
 138
 139 All unrecognized values for RACK_ENV are assumed to be
 140 "none".  Production deployments are strongly encouraged to use
 141 "deployment" or "none" for maximum performance.
 142
 143 As of Unicorn 0.94.0, RACK_ENV is exported as a process-wide environment
 144 variable as well.  While not current a part of the Rack specification as
 145 of Rack 1.0.1, this has become a de facto standard in the Rack world.
 146
 147 Note that the Rack::ContentLength and Rack::Chunked middlewares
 148 are never loaded by default.  If needed, they should be
 149 individually specified in the RACKUP_FILE, some frameworks do
 150 not require them.
 151
 152 # ENVIRONMENT VARIABLES
 153
 154 The RACK_ENV variable is set by the aforementioned \-E switch.
 155 All application or library-specific environment variables (e.g. TMPDIR)
 156 may always be set in the Unicorn CONFIG_FILE in addition to the spawning
 157 shell.  When transparently upgrading Unicorn, all environment variables
 158 set in the old master process are inherited by the new master process.
 159 Unicorn only uses (and will overwrite) the UNICORN_FD environment
 160 variable internally when doing transparent upgrades.
 161
 162 # SEE ALSO
 163
 164 * unicorn_rails(1)
 165 * *Rack::Builder* ri/RDoc
 166 * *Unicorn::Configurator* ri/RDoc
 167 * [Unicorn RDoc][1]
 168 * [Rack RDoc][2]
 169 * [Rackup HowTo][3]
 170
 171 [1]: http://unicorn.bogomips.org/
 172 [2]: http://rack.rubyforge.org/doc/
 173 [3]: http://wiki.github.com/rack/rack/tutorial-rackup-howto
 174 [4]: http://unicorn.bogomips.org/SIGNALS.html