puma 5.2.2 → 6.3.0

data/README.md

@@ -2,21 +2,19 @@
   <img src="https://puma.io/images/logos/puma-logo-large.png">
 </p>
 
-# Puma: A Ruby Web Server Built For Concurrency
+# Puma: A Ruby Web Server Built For Parallelism
 
-[![Actions MRI](https://github.com/puma/puma/workflows/MRI/badge.svg?branch=master)](https://github.com/puma/puma/actions?query=workflow%3AMRI)
-[![Actions non MRI](https://github.com/puma/puma/workflows/non_MRI/badge.svg?branch=master)](https://github.com/puma/puma/actions?query=workflow%3Anon_MRI)
+[![Actions](https://github.com/puma/puma/workflows/Tests/badge.svg?branch=master)](https://github.com/puma/puma/actions?query=workflow%3ATests)
 [![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
-[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=puma&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=puma&package-manager=bundler&version-scheme=semver)
 [![StackOverflow](https://img.shields.io/badge/stackoverflow-Puma-blue.svg)]( https://stackoverflow.com/questions/tagged/puma )
 
-Puma is a **simple, fast, multi-threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications**.
+Puma is a **simple, fast, multi-threaded, and highly parallel HTTP 1.1 server for Ruby/Rack applications**.
 
-## Built For Speed &amp; Concurrency
+## Built For Speed &amp; Parallelism
 
-Puma processes requests using a C-optimized Ragel extension (inherited from Mongrel) that provides fast, accurate HTTP 1.1 protocol parsing in a portable way. Puma then serves the request using a thread pool. Each request is served in a separate thread, so truly concurrent Ruby implementations (JRuby, Rubinius) will use all available CPU cores.
+Puma processes requests using a C-optimized Ragel extension (inherited from Mongrel) that provides fast, accurate HTTP 1.1 protocol parsing in a portable way. Puma then serves the request using a thread pool. Each request is served in a separate thread, so truly parallel Ruby implementations (JRuby, Rubinius) will use all available CPU cores.
 
-Puma was designed to be the go-to server for [Rubinius](https://rubinius.com), but also works well with JRuby and MRI.
+Originally designed as a server for [Rubinius](https://github.com/rubinius/rubinius), Puma also works well with Ruby (MRI) and JRuby.
 
 On MRI, there is a Global VM Lock (GVL) that ensures only one thread can run Ruby code at a time. But if you're doing a lot of blocking IO (such as HTTP calls to external APIs like Twitter), Puma still improves MRI's throughput by allowing IO waiting to be done in parallel.
 
@@ -108,15 +106,23 @@ Puma also offers "clustered mode". Clustered mode `fork`s workers from a master
 $ puma -t 8:32 -w 3
 ```
 
+Or with the `WEB_CONCURRENCY` environment variable:
+
+```
+$ WEB_CONCURRENCY=3 puma -t 8:32
+```
+
 Note that threads are still used in clustered mode, and the `-t` thread flag setting is per worker, so `-w 2 -t 16:16` will spawn 32 threads in total, with 16 in each worker process.
 
-In clustered mode, Puma can "preload" your application. This loads all the application code *prior* to forking. Preloading reduces total memory usage of your application via an operating system feature called [copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write) (Ruby 2.0+ only). Use the `--preload` flag from the command line:
+In clustered mode, Puma can "preload" your application. This loads all the application code *prior* to forking. Preloading reduces total memory usage of your application via an operating system feature called [copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write).
+
+If the `WEB_CONCURRENCY` environment variable is set to a value > 1 (and `--prune-bundler` has not been specified), preloading will be enabled by default. Otherwise, you can use the `--preload` flag from the command line:
 
 ```
 $ puma -w 3 --preload
 ```
 
-If you're using a configuration file, use the `preload_app!` method:
+Or, if you're using a configuration file, you can use the `preload_app!` method:
 
 ```ruby
 # config/puma.rb
@@ -124,7 +130,9 @@ workers 3
 preload_app!
 ```
 
-Additionally, you can specify a block in your configuration file that will be run on boot of each worker:
+Preloading can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preloading copies the code of master into the workers.
+
+When using clustered mode, you can specify a block in your configuration file that will be run on boot of each worker:
 
 ```ruby
 # config/puma.rb
@@ -137,7 +145,10 @@ This code can be used to setup the process before booting the application, allow
 you to do some Puma-specific things that you don't want to embed in your application.
 For instance, you could fire a log notification that a worker booted or send something to statsd. This can be called multiple times.
 
-`before_fork` specifies a block to be run before workers are forked:
+Constants loaded by your application (such as `Rails`) will not be available in `on_worker_boot`
+unless preloading is enabled.
+
+You can also specify a block to be run before workers are forked, using `before_fork`:
 
 ```ruby
 # config/puma.rb
@@ -146,7 +157,14 @@ before_fork do
 end
 ```
 
-Preloading can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and `preload_app!` copies the code of master into the workers.
+You can also specify a block to be run after puma is booted using `on_booted`:
+
+```ruby
+# config/puma.rb
+on_booted do
+  # configuration here
+end
+```
 
 ### Error handling
 
@@ -187,6 +205,38 @@ Need a bit of security? Use SSL sockets:
 ```
 $ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
 ```
+#### Self-signed SSL certificates (via the [`localhost`] gem, for development use):
+
+Puma supports the [`localhost`] gem for self-signed certificates. This is particularly useful if you want to use Puma with SSL locally, and self-signed certificates will work for your use-case. Currently, the integration can only be used in MRI.
+
+Puma automatically configures SSL when the [`localhost`] gem is loaded in a `development` environment:
+
+```ruby
+# Add the gem to your Gemfile
+group(:development) do
+  gem 'localhost'
+end
+
+# And require it implicitly using bundler
+require "bundler"
+Bundler.require(:default, ENV["RACK_ENV"].to_sym)
+
+# Alternatively, you can require the gem in config.ru:
+require './app'
+require 'localhost'
+run Sinatra::Application
+```
+
+Additionally, Puma must be listening to an SSL socket:
+
+```shell
+$ puma -b 'ssl://localhost:9292' config.ru
+
+# The following options allow you to reach Puma over HTTP as well:
+$ puma -b ssl://localhost:9292 -b tcp://localhost:9393 config.ru
+```
+
+[`localhost`]: https://github.com/socketry/localhost
 
 #### Controlling SSL Cipher Suites
 
@@ -229,6 +279,30 @@ $ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&verification_f
 List of available flags: `USE_CHECK_TIME`, `CRL_CHECK`, `CRL_CHECK_ALL`, `IGNORE_CRITICAL`, `X509_STRICT`, `ALLOW_PROXY_CERTS`, `POLICY_CHECK`, `EXPLICIT_POLICY`, `INHIBIT_ANY`, `INHIBIT_MAP`, `NOTIFY_POLICY`, `EXTENDED_CRL_SUPPORT`, `USE_DELTAS`, `CHECK_SS_SIGNATURE`, `TRUSTED_FIRST`, `SUITEB_128_LOS_ONLY`, `SUITEB_192_LOS`, `SUITEB_128_LOS`, `PARTIAL_CHAIN`, `NO_ALT_CHAINS`, `NO_CHECK_TIME`
 (see https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_set_hostflags.html#VERIFICATION-FLAGS).
 
+#### Controlling OpenSSL Password Decryption
+
+To enable runtime decryption of an encrypted SSL key (not available for JRuby), use `key_password_command`:
+
+```
+$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&key_password_command=/path/to/command.sh'
+```
+
+`key_password_command` must:
+
+1. Be executable by Puma.
+2. Print the decryption password to stdout.
+
+ For example:
+
+```shell
+#!/bin/sh
+
+echo "this is my password"
+```
+
+`key_password_command` can be used with `key` or `key_pem`. If the key
+is not encrypted, the executable will not be called.
+
 ### Control/Status Server
 
 Puma has a built-in status and control app that can be used to query and control Puma.
@@ -255,11 +329,15 @@ You can also provide a configuration file with the `-C` (or `--config`) flag:
 $ puma -C /path/to/config
 ```
 
-If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` or the `RAILS_ENV` environment variables, Puma first looks for configuration at `config/puma/<environment_name>.rb`, and then falls back to `config/puma.rb`.
+If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified (via the `--environment` flag or through the `APP_ENV`, `RACK_ENV`, or `RAILS_ENV` environment variables) Puma looks for a configuration file at `config/puma/<environment_name>.rb` and then falls back to `config/puma.rb`.
 
-If you want to prevent Puma from looking for a configuration file in those locations, provide a dash as the argument to the `-C` (or `--config`) flag:
+If you want to prevent Puma from looking for a configuration file in those locations, include the `--no-config` flag:
 
 ```
+$ puma --no-config
+
+# or
+
 $ puma -C "-"
 ```
 
@@ -300,16 +378,18 @@ end
 
 ## Deployment
 
-Puma has support for Capistrano with an [external gem](https://github.com/seuros/capistrano-puma).
+ * Puma has support for Capistrano with an [external gem](https://github.com/seuros/capistrano-puma).
+
+ * Additionally, Puma has support for built-in daemonization via the [puma-daemon](https://github.com/kigster/puma-daemon) ruby gem. The gem restores the `daemonize` option that was removed from Puma starting version 5, but only for MRI Ruby.
+
 
 It is common to use process monitors with Puma. Modern process monitors like systemd or rc.d
-provide continuous monitoring and restarts for increased
-reliability in production environments:
+provide continuous monitoring and restarts for increased reliability in production environments:
 
 * [rc.d](docs/jungle/rc.d/README.md)
 * [systemd](docs/systemd.md)
 
-Community guides: 
+Community guides:
 
 * [Deploying Puma on OpenBSD using relayd and httpd](https://gist.github.com/anon987654321/4532cf8d6c59c1f43ec8973faa031103)
 
@@ -319,7 +399,8 @@ Community guides:
 
 * [puma-metrics](https://github.com/harmjanblok/puma-metrics) — export Puma metrics to Prometheus
 * [puma-plugin-statsd](https://github.com/yob/puma-plugin-statsd) — send Puma metrics to statsd
-* [puma-plugin-systemd](https://github.com/sj26/puma-plugin-systemd) — deeper integration with systemd for notify, status and watchdog
+* [puma-plugin-systemd](https://github.com/sj26/puma-plugin-systemd) — deeper integration with systemd for notify, status and watchdog. Puma 5.1.0 integrated notify and watchdog, which probably conflicts with this plugin. Puma 6.1.0 added status support which obsoletes the plugin entirely.
+* [puma-plugin-telemetry](https://github.com/babbel/puma-plugin-telemetry) - telemetry plugin for Puma offering various targets to publish
 
 ### Monitoring
 

data/bin/puma-wild

@@ -16,7 +16,7 @@ end
 
 module Puma; end
 
-Puma.const_set("WILD_ARGS", ["-I", inc])
+Puma.const_set(:WILD_ARGS, ["-I", inc])
 
 require 'puma/cli'
 

data/docs/architecture.md

@@ -4,37 +4,71 @@
 
 ![https://bit.ly/2iJuFky](images/puma-general-arch.png)
 
-Puma is a threaded Ruby HTTP application server, processing requests across a TCP or UNIX socket.
+Puma is a threaded Ruby HTTP application server processing requests across a TCP
+and/or UNIX socket.
 
-Puma processes (there can be one or many) accept connections from the socket via a thread (in the `Reactor` class). The connection, once fully buffered and read, moves in to the `todo` list, where it will be picked up by a free/waiting thread in the threadpool (the `ThreadPool` class).
 
-Puma works in two main modes: cluster and single. In single mode, only one Puma process is booted. In cluster mode, a `master` process is booted, which prepares (and may boot) the application, and then uses the `fork()` system call to create 1 or more `child` processes. These `child` processes all listen to the same socket. The `master` process does not listen to the socket or process requests - its purpose is mostly to manage and listen for UNIX signals and possibly kill or boot `child` processes.
+Puma processes (there can be one or many) accept connections from the socket via
+a thread (in the [`Reactor`](../lib/puma/reactor.rb) class). The connection,
+once fully buffered and read, moves into the `todo` list, where an available
+thread will pick it up (in the [`ThreadPool`](../lib/puma/thread_pool.rb)
+class).
 
-We sometimes call `child` processes (or Puma processes in `single` mode) _workers_, and we sometimes call the threads created by Puma's `ThreadPool` _worker threads_.
+Puma works in two main modes: cluster and single. In single mode, only one Puma
+process boots. In cluster mode, a `master` process is booted, which prepares
+(and may boot) the application and then uses the `fork()` system call to create
+one or more `child` processes. These `child` processes all listen to the same
+socket. The `master` process does not listen to the socket or process requests -
+its purpose is primarily to manage and listen for UNIX signals and possibly kill
+or boot `child` processes.
+
+We sometimes call `child` processes (or Puma processes in `single` mode)
+_workers_, and we sometimes call the threads created by Puma's
+[`ThreadPool`](../lib/puma/thread_pool.rb) _worker threads_.
 
 ## How Requests Work
 
 ![https://bit.ly/2zwzhEK](images/puma-connection-flow.png)
 
 * Upon startup, Puma listens on a TCP or UNIX socket.
-  * The backlog of this socket is configured (with a default of 1024). This determines the size of the queue for unaccepted connections. Generally, this setting is unimportant and will never be hit in production use. If the backlog is full, the connection will be refused by the operating system.
-  * This socket backlog is distinct from the `backlog` of work as reported by `Puma.stats` or the control server. The backlog as reported by Puma is the number of connections in the process' `todo` set waiting for a thread from the `ThreadPool`.
-* By default, a single, separate thread (created by the `Reactor` class) is used to read and buffer requests from the socket.
-  * When at least one worker thread is available for work, the reactor thread listens to the socket and accepts a request, if one is waiting.
+  * The backlog of this socket is configured with a default of 1024, but the
+    actual backlog value is capped by the `net.core.somaxconn` sysctl value.
+    The backlog determines the size of the queue for unaccepted connections. If
+    the backlog is full, the operating system is not accepting new connections.
+  * This socket backlog is distinct from the `backlog` of work as reported by
+    `Puma.stats` or the control server. The backlog that `Puma.stats` refers to
+    represents the number of connections in the process' `todo` set waiting for
+    a thread from the [`ThreadPool`](../lib/puma/thread_pool.rb).
+* By default, a single, separate thread (created by the
+  [`Reactor`](../lib/puma/reactor.rb) class) reads and buffers requests from the
+  socket.
+  * When at least one worker thread is available for work, the reactor thread
+    listens to the socket and accepts a request (if one is waiting).
   * The reactor thread waits for the entire HTTP request to be received.
-    * The time spent waiting for the HTTP request body to be received is exposed to the Rack app as `env['puma.request_body_wait']` (milliseconds).
-  * Once fully buffered and received, the connection is pushed into the "todo" set.
+    * Puma exposes the time spent waiting for the HTTP request body to be
+      received to the Rack app as `env['puma.request_body_wait']`
+      (milliseconds).
+  * Once fully buffered and received, the connection is pushed into the "todo"
+    set.
 * Worker threads pop work off the "todo" set for processing.
-  * The worker thread processes the request via `call`ing the configured Rack application. The Rack application generates the HTTP response.
-  * The worker thread writes the response to the connection. Note that while Puma buffers requests via a separate thread, it does not use a separate thread for responses.
-  * Once done, the thread become available to process another connection in the "todo" set.
+  * The worker thread processes the request via `call`ing the configured Rack
+    application. The Rack application generates the HTTP response.
+  * The worker thread writes the response to the connection. While Puma buffers
+    requests via a separate thread, it does not use a separate thread for
+    responses.
+  * Once done, the thread becomes available to process another connection in the
+    "todo" set.
 
 ### `queue_requests`
 
 ![https://bit.ly/2zxCJ1Z](images/puma-connection-flow-no-reactor.png)
 
-The `queue_requests` option is `true` by default, enabling the separate reactor thread used to buffer requests as described above.
+The `queue_requests` option is `true` by default, enabling the separate reactor
+thread used to buffer requests as described above.
 
-If set to `false`, this buffer will not be used for connections while waiting for the request to arrive.
+If set to `false`, this buffer will not be used for connections while waiting
+for the request to arrive.
 
-In this mode, when a connection is accepted, it is added to the "todo" queue immediately, and a worker will synchronously do any waiting necessary to read the HTTP request from the socket.
+In this mode, when a connection is accepted, it is added to the "todo" queue
+immediately, and a worker will synchronously do any waiting necessary to read
+the HTTP request from the socket.

data/docs/compile_options.md

@@ -1,10 +1,12 @@
 # Compile Options
 
-There are some `cflags` provided to change Puma's default configuration for its C extension.
+There are some `cflags` provided to change Puma's default configuration for its
+C extension.
 
 ## Query String, `PUMA_QUERY_STRING_MAX_LENGTH`
 
-By default, the max length of `QUERY_STRING` is `1024 * 10`. But you may want to adjust it to allow accept larger queries in GET requests.
+By default, the max length of `QUERY_STRING` is `1024 * 10`. But you may want to
+adjust it to accept longer queries in GET requests.
 
 For manual install, pass the `PUMA_QUERY_STRING_MAX_LENGTH` option like this:
 
@@ -17,3 +19,37 @@ For Bundler, use its configuration system:
 ```
 bundle config build.puma "--with-cflags='-D PUMA_QUERY_STRING_MAX_LENGTH=64000'"
 ```
+
+## Request Path, `PUMA_REQUEST_PATH_MAX_LENGTH`
+
+By default, the max length of `REQUEST_PATH` is `8192`. But you may want to
+adjust it to accept longer paths in requests.
+
+For manual install, pass the `PUMA_REQUEST_PATH_MAX_LENGTH` option like this:
+
+```
+gem install puma -- --with-cflags="-D PUMA_REQUEST_PATH_MAX_LENGTH=64000"
+```
+
+For Bundler, use its configuration system:
+
+```
+bundle config build.puma "--with-cflags='-D PUMA_REQUEST_PATH_MAX_LENGTH=64000'"
+```
+
+## Request URI, `PUMA_REQUEST_URI_MAX_LENGTH`
+
+By default, the max length of `REQUEST_URI` is `1024 * 12`. But you may want to
+adjust it to accept longer URIs in requests.
+
+For manual install, pass the `PUMA_REQUEST_URI_MAX_LENGTH` option like this:
+
+```
+gem install puma -- --with-cflags="-D PUMA_REQUEST_URI_MAX_LENGTH=64000"
+```
+
+For Bundler, use its configuration system:
+
+```
+bundle config build.puma "--with-cflags='-D PUMA_REQUEST_URI_MAX_LENGTH=64000'"
+```

data/docs/deployment.md

@@ -1,35 +1,32 @@
 # Deployment engineering for Puma
 
-Puma is software that is expected to be run in a deployed environment eventually.
-You can certainly use it as your dev server only, but most people look to use
-it in their production deployments as well.
+Puma expects to be run in a deployed environment eventually. You can use it as
+your development server, but most people use it in their production deployments.
 
-To that end, this is meant to serve as a foundation of wisdom how to do that
-in a way that increases happiness and decreases downtime.
+To that end, this document serves as a foundation of wisdom regarding deploying
+Puma to production while increasing happiness and decreasing downtime.
 
 ## Specifying Puma
 
-Most people want to do this by putting `gem "puma"` into their Gemfile, so we'll
-go ahead and assume that. Go add it now... we'll wait.
+Most people will specify Puma by including `gem "puma"` in a Gemfile, so we'll
+assume this is how you're using Puma.
 
-Welcome back!
+## Single vs. Cluster mode
 
-## Single vs Cluster mode
+Initially, Puma was conceived as a thread-only web server, but support for
+processes was added in version 2.
 
-Puma was originally conceived as a thread-only webserver, but grew the ability to
-also use processes in version 2.
+To run `puma` in single mode (i.e., as a development environment), set the
+number of workers to 0; anything higher will run in cluster mode.
 
-To run `puma` in single mode (e.g. for a development environment) you will need to
-set the number of workers to 0, anything above will run in cluster mode.
-
-Here are some rules of thumb for cluster mode:
+Here are some tips for cluster mode:
 
 ### MRI
 
-* Use cluster mode and set the number of workers to 1.5x the number of cpu cores
-  in the machine, minimum 2.
-* Set the number of threads to desired concurrent requests / number of workers.
-  Puma defaults to 5 and that's a decent number.
+* Use cluster mode and set the number of workers to 1.5x the number of CPU cores
+  in the machine, starting from a minimum of 2.
+* Set the number of threads to desired concurrent requests/number of workers.
+  Puma defaults to 5, and that's a decent number.
 
 #### Migrating from Unicorn
 
@@ -37,7 +34,7 @@ Here are some rules of thumb for cluster mode:
   * Set workers to half the number of unicorn workers you're using
   * Set threads to 2
   * Enjoy 50% memory savings
-* As you grow more confident in the thread safety of your app, you can tune the
+* As you grow more confident in the thread-safety of your app, you can tune the
   workers down and the threads up.
 
 #### Ubuntu / Systemd (Systemctl) Installation
@@ -48,69 +45,58 @@ See [systemd.md](systemd.md)
 
 **How do you know if you've got enough (or too many workers)?**
 
-A good question. Due to MRI's GIL, only one thread can be executing Ruby code at a time.
-But since so many apps are waiting on IO from DBs, etc., they can utilize threads
-to make better use of the process.
+A good question. Due to MRI's GIL, only one thread can be executing Ruby code at
+a time. But since so many apps are waiting on IO from DBs, etc., they can
+utilize threads to use the process more efficiently.
 
-The rule of thumb is you never want processes that are pegged all the time. This
-means that there is more work to do than the process can get through. On the other
-hand, if you have processes that sit around doing nothing, then they're just eating
-up resources.
+Generally, you never want processes that are pegged all the time. That can mean
+there is more work to do than the process can get through. On the other hand, if
+you have processes that sit around doing nothing, then they're just eating up
+resources.
 
-Watch your CPU utilization over time and aim for about 70% on average. This means
-you've got capacity still but aren't starving threads.
+Watch your CPU utilization over time and aim for about 70% on average. 70%
+utilization means you've got capacity still but aren't starving threads.
 
 **Measuring utilization**
 
-Using a timestamp header from an upstream proxy server (eg. nginx or haproxy), it's
-possible to get an indication of how long requests have been waiting for a Puma
-thread to become available.
+Using a timestamp header from an upstream proxy server (e.g., `nginx` or
+`haproxy`) makes it possible to indicate how long requests have been waiting for
+a Puma thread to become available.
 
 * Have your upstream proxy set a header with the time it received the request:
     * nginx: `proxy_set_header X-Request-Start "${msec}";`
-    * haproxy >= 1.9: `http-request set-header X-Request-Start t=%[date()]%[date_us()]`
+    * haproxy >= 1.9: `http-request set-header X-Request-Start
+      t=%[date()]%[date_us()]`
     * haproxy < 1.9: `http-request set-header X-Request-Start t=%[date()]`
-* In your Rack middleware, determine the amount of time elapsed since `X-Request-Start`.
-* To improve accuracy, you will want to subtract time spent waiting for slow clients:
-    * `env['puma.request_body_wait']` contains the number of milliseconds Puma spent
-      waiting for the client to send the request body.
-    * haproxy: `%Th` (TLS handshake time) and `%Ti` (idle time before request) can
-      can also be added as headers.
+* In your Rack middleware, determine the amount of time elapsed since
+  `X-Request-Start`.
+* To improve accuracy, you will want to subtract time spent waiting for slow
+  clients:
+    * `env['puma.request_body_wait']` contains the number of milliseconds Puma
+      spent waiting for the client to send the request body.
+    * haproxy: `%Th` (TLS handshake time) and `%Ti` (idle time before request)
+      can can also be added as headers.
 
 ## Should I daemonize?
 
-Daemonization was removed in Puma 5.0. For alternatives, continue reading.
+The Puma 5.0 release removed daemonization. For older versions and alternatives,
+continue reading.
 
-I prefer to not daemonize my servers and use something like `runit` or `systemd` to
-monitor them as child processes. This gives them fast response to crashes and
+I prefer not to daemonize my servers and use something like `runit` or `systemd`
+to monitor them as child processes. This gives them fast response to crashes and
 makes it easy to figure out what is going on. Additionally, unlike `unicorn`,
-puma does not require daemonization to do zero-downtime restarts.
+Puma does not require daemonization to do zero-downtime restarts.
 
-I see people using daemonization because they start puma directly via capistrano
-task and thus want it to live on past the `cap deploy`. To these people I say:
-You need to be using a process monitor. Nothing is making sure puma stays up in
-this scenario! You're just waiting for something weird to happen, puma to die,
-and to get paged at 3am. Do yourself a favor, at least the process monitoring
-your OS comes with, be it `sysvinit` or `systemd`. Or branch out
-and use `runit` or hell, even `monit`.
+I see people using daemonization because they start puma directly via Capistrano
+task and thus want it to live on past the `cap deploy`. To these people, I say:
+You need to be using a process monitor. Nothing is making sure Puma stays up in
+this scenario! You're just waiting for something weird to happen, Puma to die,
+and to get paged at 3 AM. Do yourself a favor, at least the process monitoring
+your OS comes with, be it `sysvinit` or `systemd`. Or branch out and use `runit`
+or hell, even `monit`.
 
 ## Restarting
 
 You probably will want to deploy some new code at some point, and you'd like
-puma to start running that new code. Minimizing the amount of time the server
-is unavailable would be nice as well. Here's how to do it:
-
-1. Don't use `preload!`. This dirties the master process and means it will have
-to shutdown all the workers and re-exec itself to get your new code. It is not compatible with phased-restart and `prune_bundler` as well.
-
-1. Use `prune_bundler`. This makes it so that the cluster master will detach itself
-from a Bundler context on start. This allows the cluster workers to load your app
-and start a brand new Bundler context within the worker only. This means your
-master remains pristine and can live on between new releases of your code.
-
-1. Use phased-restart (`SIGUSR1` or `pumactl phased-restart`). This tells the master
-to kill off one worker at a time and restart them in your new code. This minimizes
-downtime and staggers the restart nicely. **WARNING** This means that both your
-old code and your new code will be running concurrently. Most deployment solutions
-already cause that, but it's worth warning you about it again. Be careful with your
-migrations, etc!
+Puma to start running that new code. There are a few options for restarting
+Puma, described separately in our [restart documentation](restart.md).

data/docs/fork_worker.md

@@ -10,7 +10,7 @@ Puma 5 introduces an experimental new cluster-mode configuration option, `fork_w
 10004           \_ puma: cluster worker 3: 10000 [puma]
 ```
 
-Similar to the `preload_app!` option, the `fork_worker` option allows your application to be initialized only once for copy-on-write memory savings, and it has two additional advantages:
+The `fork_worker` option allows your application to be initialized only once for copy-on-write memory savings, and it has two additional advantages:
 
 1. **Compatible with phased restart.** Because the master process itself doesn't preload the application, this mode works with phased restart (`SIGUSR1` or `pumactl phased-restart`). When worker 0 reloads as part of a phased restart, it initializes a new copy of your application first, then the other workers reload by forking from this new worker already containing the new preloaded application.
 
@@ -24,8 +24,6 @@ Similar to the `preload_app!` option, the `fork_worker` option allows your appli
 
 ### Limitations
 
-- Not compatible with the `preload_app!` option
-
 - This mode is still very experimental so there may be bugs or edge-cases, particularly around expected behavior of existing hooks. Please open a [bug report](https://github.com/puma/puma/issues/new?template=bug_report.md) if you encounter any issues.
 
 - In order to fork new workers cleanly, worker 0 shuts down its server and stops serving requests so there are no open file descriptors or other kinds of shared global state between processes, and to maximize copy-on-write efficiency across the newly-forked workers. This may temporarily reduce total capacity of the cluster during a phased restart / refork.

data/docs/jungle/rc.d/README.md

@@ -1,6 +1,6 @@
 # Puma as a service using rc.d
 
-Manage multilpe Puma servers as services on one box using FreeBSD's rc.d service.
+Manage multiple Puma servers as services on one box using FreeBSD's rc.d service.
 
 ## Dependencies
 

data/docs/kubernetes.md

@@ -61,6 +61,6 @@ For some high-throughput systems, it is possible that some HTTP requests will re
 
 There is a subtle race condition between step 2 and 3: The replication controller does not synchronously remove the pod from the Services AND THEN call the pre-stop hook of the pod, but rather it asynchronously sends "remove this pod from your endpoints" requests to the Services and then immediately proceeds to invoke the pods' pre-stop hook. If the Service controller (typically something like nginx or haproxy) receives this request handles this request "too" late (due to internal lag or network latency between the replication and Service controllers) then it is possible that the Service controller will send one or more requests to a Puma process which has already shut down its listening socket. These requests will then fail with 5XX error codes.
 
-The way Kubernetes works this way, rather than handling step 2 synchronously, is due to the CAP theorem: in a distributed system there is no way to guarantuee that any message will arrive promptly. In particular, waiting for all Service controllers to report back might get stuck for an indefinite time if one of them has already been terminated or if there has been a net split. A way to work around this is to add a sleep to the pre-stop hook of the same time as the `terminationGracePeriodSeconds` time. This will allow the Puma process to keep serving new requests during the entire grace period, although it will no longer receive new requests after all Service controllers have propagated the removal of the pod from their endpoint lists. Then, after `terminationGracePeriodSeconds`, the pod receives `SIGKILL` and closes down. If your process can't handle SIGKILL properly, for example because it needs to release locks in different services, you can also sleep for a shorter period (and/or increase `terminationGracePeriodSeconds`) as long as the time slept is longer than the time that your Service controllers take to propagate the pod removal. The downside of this workaround is that all pods will take at minimum the amount of time slept to shut down and this will increase the time required for your rolling deploy.
+The way Kubernetes works this way, rather than handling step 2 synchronously, is due to the CAP theorem: in a distributed system there is no way to guarantee that any message will arrive promptly. In particular, waiting for all Service controllers to report back might get stuck for an indefinite time if one of them has already been terminated or if there has been a net split. A way to work around this is to add a sleep to the pre-stop hook of the same time as the `terminationGracePeriodSeconds` time. This will allow the Puma process to keep serving new requests during the entire grace period, although it will no longer receive new requests after all Service controllers have propagated the removal of the pod from their endpoint lists. Then, after `terminationGracePeriodSeconds`, the pod receives `SIGKILL` and closes down. If your process can't handle SIGKILL properly, for example because it needs to release locks in different services, you can also sleep for a shorter period (and/or increase `terminationGracePeriodSeconds`) as long as the time slept is longer than the time that your Service controllers take to propagate the pod removal. The downside of this workaround is that all pods will take at minimum the amount of time slept to shut down and this will increase the time required for your rolling deploy.
 
 More discussions and links to relevant articles can be found in https://github.com/puma/puma/issues/2343.

data/docs/nginx.md

@@ -2,7 +2,7 @@
 
 This is a very common setup using an upstream. It was adapted from some Capistrano recipe I found on the Internet a while ago.
 
-```
+```nginx
 upstream myapp {
   server unix:///myapp/tmp/puma.sock;
 }