1 # -*- encoding: binary -*-
3 require 'unicorn/ssl_configurator'
5 # Implements a simple DSL for configuring a \Unicorn server.
7 # See http://unicorn.bogomips.org/examples/unicorn.conf.rb and
8 # http://unicorn.bogomips.org/examples/unicorn.conf.minimal.rb
9 # example configuration files. An example config file for use with
10 # nginx is also available at
11 # http://unicorn.bogomips.org/examples/nginx.conf
13 # See the link:/TUNING.html document for more information on tuning unicorn.
14 class Unicorn::Configurator
16 include Unicorn::SSLConfigurator
19 attr_accessor :set, :config_file, :after_reload
21 # used to stash stuff for deferred processing of cli options in
22 # config.ru after "working_directory" is bound. Do not rely on
23 # this being around later on...
26 :host => Unicorn::Const::DEFAULT_HOST,
27 :port => Unicorn::Const::DEFAULT_PORT,
28 :set_listener => false,
29 :options => { :listeners => [] }
32 # Default settings for Unicorn
35 :logger => Logger.new($stderr),
36 :worker_processes => 1,
37 :after_fork => lambda { |server, worker|
38 server.logger.info("worker=#{worker.nr} spawned pid=#{$$}")
40 :before_fork => lambda { |server, worker|
41 server.logger.info("worker=#{worker.nr} spawning...")
43 :before_exec => lambda { |server|
44 server.logger.info("forked child re-executing...")
47 :preload_app => false,
48 :rewindable_input => true, # for Rack 2.x: (Rack::VERSION[0] <= 1),
49 :client_body_buffer_size => Unicorn::Const::MAX_BODY,
50 :trust_x_forwarded => true,
54 def initialize(defaults = {}) #:nodoc:
55 self.set = Hash.new(:unset)
56 @use_defaults = defaults.delete(:use_defaults)
57 self.config_file = defaults.delete(:config_file)
59 # after_reload is only used by unicorn_rails, unsupported otherwise
60 self.after_reload = defaults.delete(:after_reload)
62 set.merge!(DEFAULTS) if @use_defaults
63 defaults.each { |key, value| self.__send__(key, value) }
64 Hash === set[:listener_opts] or
65 set[:listener_opts] = Hash.new { |hash,key| hash[key] = {} }
66 Array === set[:listeners] or set[:listeners] = []
70 def reload(merge_defaults = true) #:nodoc:
71 if merge_defaults && @use_defaults
72 set.merge!(DEFAULTS) if @use_defaults
74 instance_eval(File.read(config_file), config_file) if config_file
78 RACKUP[:set_listener] and
79 set[:listeners] << "#{RACKUP[:host]}:#{RACKUP[:port]}"
81 # unicorn_rails creates dirs here after working_directory is bound
82 after_reload.call if after_reload
84 # working_directory binds immediately (easier error checking that way),
85 # now ensure any paths we changed are correctly set.
86 [ :pid, :stderr_path, :stdout_path ].each do |var|
87 String === (path = set[var]) or next
88 path = File.expand_path(path)
89 File.writable?(path) || File.writable?(File.dirname(path)) or \
90 raise ArgumentError, "directory for #{var}=#{path} not writable"
94 def commit!(server, options = {}) #:nodoc:
95 skip = options[:skip] || []
96 if ready_pipe = RACKUP.delete(:ready_pipe)
97 server.ready_pipe = ready_pipe
99 set.each do |key, value|
100 value == :unset and next
101 skip.include?(key) and next
102 server.__send__("#{key}=", value)
106 def [](key) # :nodoc:
110 # sets object to the +obj+ Logger-like object. The new Logger-like
111 # object must respond to the following methods:
117 # The default Logger will log its output to the path specified
118 # by +stderr_path+. If you're running Unicorn daemonized, then
119 # you must specify a path to prevent error messages from going
122 %w(debug info warn error fatal).each do |m|
123 obj.respond_to?(m) and next
124 raise ArgumentError, "logger=#{obj} does not respond to method=#{m}"
130 # sets after_fork hook to a given block. This block will be called by
131 # the worker after forking. The following is an example hook which adds
132 # a per-process listener to every worker:
134 # after_fork do |server,worker|
135 # # per-process listener ports for debugging/admin:
136 # addr = "127.0.0.1:#{9293 + worker.nr}"
138 # # the negative :tries parameter indicates we will retry forever
139 # # waiting on the existing process to exit with a 5 second :delay
140 # # Existing options for Unicorn::Configurator#listen such as
141 # # :backlog, :rcvbuf, :sndbuf are available here as well.
142 # server.listen(addr, :tries => -1, :delay => 5, :backlog => 128)
144 def after_fork(*args, &block)
145 set_hook(:after_fork, block_given? ? block : args[0])
148 # sets before_fork got be a given Proc object. This Proc
149 # object will be called by the master process before forking
151 def before_fork(*args, &block)
152 set_hook(:before_fork, block_given? ? block : args[0])
155 # sets the before_exec hook to a given Proc object. This
156 # Proc object will be called by the master process right
157 # before exec()-ing the new unicorn binary. This is useful
158 # for freeing certain OS resources that you do NOT wish to
159 # share with the reexeced child process.
160 # There is no corresponding after_exec hook (for obvious reasons).
161 def before_exec(*args, &block)
162 set_hook(:before_exec, block_given? ? block : args[0], 1)
165 # sets the timeout of worker processes to +seconds+. Workers
166 # handling the request/app.call/response cycle taking longer than
167 # this time period will be forcibly killed (via SIGKILL). This
168 # timeout is enforced by the master process itself and not subject
169 # to the scheduling limitations by the worker process. Due the
170 # low-complexity, low-overhead implementation, timeouts of less
171 # than 3.0 seconds can be considered inaccurate and unsafe.
173 # For running Unicorn behind nginx, it is recommended to set
174 # "fail_timeout=0" for in your nginx configuration like this
175 # to have nginx always retry backends that may have had workers
176 # SIGKILL-ed due to timeouts.
178 # # See http://wiki.nginx.org/NginxHttpUpstreamModule for more details
179 # # on nginx upstream configuration:
180 # upstream unicorn_backend {
181 # # for UNIX domain socket setups:
182 # server unix:/path/to/unicorn.sock fail_timeout=0;
185 # server 192.168.0.7:8080 fail_timeout=0;
186 # server 192.168.0.8:8080 fail_timeout=0;
187 # server 192.168.0.9:8080 fail_timeout=0;
190 set_int(:timeout, seconds, 3)
191 # POSIX says 31 days is the smallest allowed maximum timeout for select()
192 max = 30 * 60 * 60 * 24
193 set[:timeout] = seconds > max ? max : seconds
196 # sets the current number of worker_processes to +nr+. Each worker
197 # process will serve exactly one client at a time. You can
198 # increment or decrement this value at runtime by sending SIGTTIN
199 # or SIGTTOU respectively to the master process without reloading
200 # the rest of your Unicorn configuration. See the SIGNALS document
201 # for more information.
202 def worker_processes(nr)
203 set_int(:worker_processes, nr, 1)
206 # sets listeners to the given +addresses+, replacing or augmenting the
207 # current set. This is for the global listener pool shared by all
208 # worker processes. For per-worker listeners, see the after_fork example
209 # This is for internal API use only, do not use it in your Unicorn
210 # config file. Use listen instead.
211 def listeners(addresses) # :nodoc:
212 Array === addresses or addresses = Array(addresses)
213 addresses.map! { |addr| expand_addr(addr) }
214 set[:listeners] = addresses
217 # Adds an +address+ to the existing listener set. May be specified more
218 # than once. +address+ may be an Integer port number for a TCP port, an
219 # "IP_ADDRESS:PORT" for TCP listeners or a pathname for UNIX domain sockets.
221 # listen 3000 # listen to port 3000 on all TCP interfaces
222 # listen "127.0.0.1:3000" # listen to port 3000 on the loopback interface
223 # listen "/tmp/.unicorn.sock" # listen on the given Unix domain socket
224 # listen "[::1]:3000" # listen to port 3000 on the IPv6 loopback interface
226 # The following options may be specified (but are generally not needed):
228 # [:backlog => number of clients]
230 # This is the backlog of the listen() syscall.
232 # Some operating systems allow negative values here to specify the
233 # maximum allowable value. In most cases, this number is only
234 # recommendation and there are other OS-specific tunables and
235 # variables that can affect this number. See the listen(2)
236 # syscall documentation of your OS for the exact semantics of
239 # If you are running unicorn on multiple machines, lowering this number
240 # can help your load balancer detect when a machine is overloaded
241 # and give requests to a different machine.
245 # [:rcvbuf => bytes, :sndbuf => bytes]
247 # Maximum receive and send buffer sizes (in bytes) of sockets.
249 # These correspond to the SO_RCVBUF and SO_SNDBUF settings which
250 # can be set via the setsockopt(2) syscall. Some kernels
251 # (e.g. Linux 2.4+) have intelligent auto-tuning mechanisms and
252 # there is no need (and it is sometimes detrimental) to specify them.
254 # See the socket API documentation of your operating system
255 # to determine the exact semantics of these settings and
256 # other operating system-specific knobs where they can be
259 # Defaults: operating system defaults
261 # [:tcp_nodelay => true or false]
263 # Disables Nagle's algorithm on TCP sockets if +true+.
265 # Setting this to +true+ can make streaming responses in Rails 3.1
266 # appear more quickly at the cost of slightly higher bandwidth usage.
267 # The effect of this option is most visible if nginx is not used,
268 # but nginx remains highly recommended with \Unicorn.
270 # This has no effect on UNIX sockets.
272 # Default: +true+ (Nagle's algorithm disabled) in \Unicorn,
273 # +true+ in Rainbows! This defaulted to +false+ in \Unicorn
276 # [:tcp_nopush => true or false]
278 # Enables/disables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
280 # This prevents partial TCP frames from being sent out and reduces
281 # wakeups in nginx if it is on a different machine. Since \Unicorn
282 # is only designed for applications that send the response body
283 # quickly without keepalive, sockets will always be flushed on close
286 # This has no effect on UNIX sockets.
289 # This defaulted to +true+ in \Unicorn 3.4 - 3.7
291 # [:ipv6only => true or false]
293 # This option makes IPv6-capable TCP listeners IPv6-only and unable
294 # to receive IPv4 queries on dual-stack systems. A separate IPv4-only
295 # listener is required if this is true.
297 # This option is only available for Ruby 1.9.2 and later.
299 # Enabling this option for the IPv6-only listener and having a
300 # separate IPv4 listener is recommended if you wish to support IPv6
301 # on the same TCP port. Otherwise, the value of \env[\"REMOTE_ADDR\"]
302 # will appear as an ugly IPv4-mapped-IPv6 address for IPv4 clients
303 # (e.g ":ffff:10.0.0.1" instead of just "10.0.0.1").
305 # Default: Operating-system dependent
307 # [:tries => Integer]
309 # Times to retry binding a socket if it is already in use
311 # A negative number indicates we will retry indefinitely, this is
312 # useful for migrations and upgrades when individual workers
313 # are binding to different ports.
317 # [:delay => seconds]
319 # Seconds to wait between successive +tries+
321 # Default: 0.5 seconds
325 # Sets the file mode creation mask for UNIX sockets. If specified,
326 # this is usually in octal notation.
328 # Typically UNIX domain sockets are created with more liberal
329 # file permissions than the rest of the application. By default,
330 # we create UNIX domain sockets to be readable and writable by
331 # all local users to give them the same accessibility as
332 # locally-bound TCP listeners.
334 # This has no effect on TCP listeners.
336 # Default: 0000 (world-read/writable)
338 # [:tcp_defer_accept => Integer]
340 # Defer accept() until data is ready (Linux-only)
342 # For Linux 2.6.32 and later, this is the number of retransmits to
343 # defer an accept() for if no data arrives, but the client will
344 # eventually be accepted after the specified number of retransmits
345 # regardless of whether data is ready.
347 # For Linux before 2.6.32, this is a boolean option, and
348 # accepts are _always_ deferred indefinitely if no data arrives.
349 # This is similar to <code>:accept_filter => "dataready"</code>
352 # Specifying +true+ is synonymous for the default value(s) below,
353 # and +false+ or +nil+ is synonymous for a value of zero.
355 # A value of +1+ is a good optimization for local networks
356 # and trusted clients. For Rainbows! and Zbatery users, a higher
357 # value (e.g. +60+) provides more protection against some
358 # denial-of-service attacks. There is no good reason to ever
359 # disable this with a +zero+ value when serving HTTP.
361 # Default: 1 retransmit for \Unicorn, 60 for Rainbows! 0.95.0\+
363 # [:accept_filter => String]
365 # defer accept() until data is ready (FreeBSD-only)
367 # This enables either the "dataready" or (default) "httpready"
368 # accept() filter under FreeBSD. This is intended as an
369 # optimization to reduce context switches with common GET/HEAD
370 # requests. For Rainbows! and Zbatery users, this provides
371 # some protection against certain denial-of-service attacks, too.
373 # There is no good reason to change from the default.
375 # Default: "httpready"
376 def listen(address, options = {})
377 address = expand_addr(address)
378 if String === address
379 [ :umask, :backlog, :sndbuf, :rcvbuf, :tries ].each do |key|
380 value = options[key] or next
382 raise ArgumentError, "not an integer: #{key}=#{value.inspect}"
384 [ :tcp_nodelay, :tcp_nopush, :ipv6only ].each do |key|
385 (value = options[key]).nil? and next
386 TrueClass === value || FalseClass === value or
387 raise ArgumentError, "not boolean: #{key}=#{value.inspect}"
389 unless (value = options[:delay]).nil?
391 raise ArgumentError, "not numeric: delay=#{value.inspect}"
393 set[:listener_opts][address].merge!(options)
396 set[:listeners] << address
399 # sets the +path+ for the PID file of the unicorn master process
400 def pid(path); set_path(:pid, path); end
402 # Enabling this preloads an application before forking worker
403 # processes. This allows memory savings when using a
404 # copy-on-write-friendly GC but can cause bad things to happen when
405 # resources like sockets are opened at load time by the master
406 # process and shared by multiple children. People enabling this are
407 # highly encouraged to look at the before_fork/after_fork hooks to
408 # properly close/reopen sockets. Files opened for logging do not
409 # have to be reopened as (unbuffered-in-userspace) files opened with
410 # the File::APPEND flag are written to atomically on UNIX.
412 # In addition to reloading the unicorn-specific config settings,
413 # SIGHUP will reload application code in the working
414 # directory/symlink when workers are gracefully restarted when
415 # preload_app=false (the default). As reloading the application
416 # sometimes requires RubyGems updates, +Gem.refresh+ is always
417 # called before the application is loaded (for RubyGems users).
419 # During deployments, care should _always_ be taken to ensure your
420 # applications are properly deployed and running. Using
421 # preload_app=false (the default) means you _must_ check if
422 # your application is responding properly after a deployment.
423 # Improperly deployed applications can go into a spawn loop
424 # if the application fails to load. While your children are
425 # in a spawn loop, it is is possible to fix an application
426 # by properly deploying all required code and dependencies.
427 # Using preload_app=true means any application load error will
428 # cause the master process to exit with an error.
430 def preload_app(bool)
431 set_bool(:preload_app, bool)
434 # Toggles making \env[\"rack.input\"] rewindable.
435 # Disabling rewindability can improve performance by lowering
436 # I/O and memory usage for applications that accept uploads.
437 # Keep in mind that the Rack 1.x spec requires
438 # \env[\"rack.input\"] to be rewindable, so this allows
439 # intentionally violating the current Rack 1.x spec.
441 # +rewindable_input+ defaults to +true+ when used with Rack 1.x for
442 # Rack conformance. When Rack 2.x is finalized, this will most
443 # likely default to +false+ while still conforming to the newer
444 # (less demanding) spec.
445 def rewindable_input(bool)
446 set_bool(:rewindable_input, bool)
449 # The maximum size (in +bytes+) to buffer in memory before
450 # resorting to a temporary file. Default is 112 kilobytes.
451 # This option has no effect if "rewindable_input" is set to
453 def client_body_buffer_size(bytes)
454 set_int(:client_body_buffer_size, bytes, 0)
457 # Allow redirecting $stderr to a given path. Unlike doing this from
458 # the shell, this allows the unicorn process to know the path its
459 # writing to and rotate the file if it is used for logging. The
460 # file will be opened with the File::APPEND flag and writes
461 # synchronized to the kernel (but not necessarily to _disk_) so
462 # multiple processes can safely append to it.
464 # If you are daemonizing and using the default +logger+, it is important
465 # to specify this as errors will otherwise be lost to /dev/null.
466 # Some applications/libraries may also triggering warnings that go to
467 # stderr, and they will end up here.
468 def stderr_path(path)
469 set_path(:stderr_path, path)
472 # Same as stderr_path, except for $stdout. Not many Rack applications
473 # write to $stdout, but any that do will have their output written here.
474 # It is safe to point this to the same location a stderr_path.
475 # Like stderr_path, this defaults to /dev/null when daemonized.
476 def stdout_path(path)
477 set_path(:stdout_path, path)
480 # sets the working directory for Unicorn. This ensures SIGUSR2 will
481 # start a new instance of Unicorn in this directory. This may be
482 # a symlink, a common scenario for Capistrano users. Unlike
483 # all other Unicorn configuration directives, this binds immediately
484 # for error checking and cannot be undone by unsetting it in the
485 # configuration file and reloading.
486 def working_directory(path)
487 # just let chdir raise errors
488 path = File.expand_path(path)
490 config_file[0] != ?/ &&
491 ! File.readable?("#{path}/#{config_file}")
493 "config_file=#{config_file} would not be accessible in" \
494 " working_directory=#{path}"
497 Unicorn::HttpServer::START_CTX[:cwd] = ENV["PWD"] = path
500 # Runs worker processes as the specified +user+ and +group+.
501 # The master process always stays running as the user who started it.
502 # This switch will occur after calling the after_fork hook, and only
503 # if the Worker#user method is not called in the after_fork hook
504 # +group+ is optional and will not change if unspecified.
505 def user(user, group = nil)
506 # raises ArgumentError on invalid user/group
508 Etc.getgrnam(group) if group
509 set[:user] = [ user, group ]
512 # Sets whether or not the parser will trust X-Forwarded-Proto and
513 # X-Forwarded-SSL headers and set "rack.url_scheme" to "https" accordingly.
514 # Rainbows!/Zbatery installations facing untrusted clients directly
515 # should set this to +false+. This is +true+ by default as Unicorn
516 # is designed to only sit behind trusted nginx proxies.
518 # This has never been publically documented and is subject to removal
519 # in future releases.
520 def trust_x_forwarded(bool) # :nodoc:
521 set_bool(:trust_x_forwarded, bool)
524 # expands "unix:path/to/foo" to a socket relative to the current path
525 # expands pathnames of sockets if relative to "~" or "~username"
526 # expands "*:port and ":port" to "0.0.0.0:port"
527 def expand_addr(address) #:nodoc:
528 return "0.0.0.0:#{address}" if Integer === address
529 return address unless String === address
532 when %r{\Aunix:(.*)\z}
535 File.expand_path(address)
536 when %r{\A(?:\*:)?(\d+)\z}
538 when %r{\A\[([a-fA-F0-9:]+)\]\z}, %r/\A((?:\d+\.){3}\d+)\z/
539 canonicalize_tcp($1, 80)
540 when %r{\A\[([a-fA-F0-9:]+)\]:(\d+)\z}, %r{\A(.*):(\d+)\z}
541 canonicalize_tcp($1, $2.to_i)
548 def set_int(var, n, min) #:nodoc:
549 Integer === n or raise ArgumentError, "not an integer: #{var}=#{n.inspect}"
550 n >= min or raise ArgumentError, "too low (< #{min}): #{var}=#{n.inspect}"
554 def canonicalize_tcp(addr, port)
555 packed = Socket.pack_sockaddr_in(port, addr)
556 port, addr = Socket.unpack_sockaddr_in(packed)
557 /:/ =~ addr ? "[#{addr}]:#{port}" : "#{addr}:#{port}"
560 def set_path(var, path) #:nodoc:
562 when NilClass, String
569 def check_bool(var, bool) # :nodoc:
574 raise ArgumentError, "#{var}=#{bool.inspect} not a boolean"
577 def set_bool(var, bool) #:nodoc:
578 set[var] = check_bool(var, bool)
581 def set_hook(var, my_proc, req_arity = 2) #:nodoc:
584 arity = my_proc.arity
585 (arity == req_arity) or \
587 "#{var}=#{my_proc.inspect} has invalid arity: " \
588 "#{arity} (need #{req_arity})"
590 my_proc = DEFAULTS[var]
592 raise ArgumentError, "invalid type: #{var}=#{my_proc.inspect}"
597 # this is called _after_ working_directory is bound. This only
598 # parses the embedded switches in .ru files
599 # (for "rackup" compatibility)
600 def parse_rackup_file # :nodoc:
601 ru = RACKUP[:file] or return # we only return here in unit tests
603 # :rails means use (old) Rails autodetect
605 File.readable?('config.ru') or return
609 File.readable?(ru) or
610 raise ArgumentError, "rackup file (#{ru}) not readable"
612 # it could be a .rb file, too, we don't parse those manually
613 ru =~ /\.ru\z/ or return
615 /^#\\(.*)/ =~ File.read(ru) or return
616 RACKUP[:optparse].parse!($1.split(/\s+/))
618 if RACKUP[:daemonize]
619 # unicorn_rails wants a default pid path, (not plain 'unicorn')
622 pid('tmp/pids/unicorn.pid') if spid.nil? || spid == :unset
624 unless RACKUP[:daemonized]
625 Unicorn::Launcher.daemonize!(RACKUP[:options])
626 RACKUP[:ready_pipe] = RACKUP[:options].delete(:ready_pipe)