puma 3.9.1 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5d26b911b93d92a109a1e64fd3229c7689395f9
-  data.tar.gz: a24b5aa41459ed2eefeff450681154b1013d4056
+SHA256:
+  metadata.gz: 0c3e9fdfe5225baf88ff5ee9ec6f58201a220a482d72e5217309964a22b7ccc0
+  data.tar.gz: 541ad3a7311662ca31e3de234870b03d6aac3eb925c8ad04e7a857bac097edc8
 SHA512:
-  metadata.gz: e5a2a20376869642154cbfaf94549ac99a53a55ccf13346025b1c2ae73a36a9c512336ffb8ff11331051512ebbb069debeb456ff7b0b086796233d7bfe0f4cf0
-  data.tar.gz: 93c54f37b5729dadc20e903ea908ff254908b08515a100be0d624c10aff481f29cb9bb7afa011ac560e1c5ac845d547cb69d9fa992129afaf8ea9c3d86bc97d4
+  metadata.gz: 8dc3a1d604212819aa8dc549b767cf00e3c237c95f0053ec61f6750666097980a1fbd2c350b1c47e59a1047d1a0bb35451914629f2829a66ded20a930939a60e
+  data.tar.gz: f906230de96dd55841faaf6968939b4a096acb9933e91b34c8aada201e1c5e259c567ce8dce744490093072f6cb9d9553b7d83752e07ec7502973c72990563d4

data/History.md

@@ -1,3 +1,226 @@
+## Master
+
+* Features
+  * Your feature goes here (#Github Number)
+
+* Bugfixes
+  * Your bugfix goes here (#Github Number)
+
+## 4.3.1 and 3.12.2 / 2019-12-05
+
+* Security
+  * Fix: a poorly-behaved client could use keepalive requests to monopolize Puma's reactor and create a denial of service attack. CVE-2019-16770.
+
+## 4.3.0 / 2019-11-07
+
+* Features
+  * Strip whitespace at end of HTTP headers (#2010)
+  * Optimize HTTP parser for JRuby (#2012)
+  * Add SSL support for the control app and cli (#2046, #2052)
+
+* Bugfixes
+  * Fix Errno::EINVAL when SSL is enabled and browser rejects cert (#1564)
+  * Fix pumactl defaulting puma to development if an environment was not specified (#2035)
+  * Fix closing file stream when reading pid from pidfile (#2048)
+  * Fix a typo in configuration option `--extra_runtime_dependencies` (#2050)
+
+## 4.2.1 / 2019-10-07
+
+* 3 bugfixes
+  * Fix socket activation of systemd (pre-existing) unix binder files (#1842, #1988)
+  * Deal with multiple calls to bind correctly (#1986, #1994, #2006)
+  * Accepts symbols for `verify_mode` (#1222)
+
+## 4.2.0 / 2019-09-23
+
+* 6 features
+  * Pumactl has a new -e environment option and reads `config/puma/<environment>.rb` config files (#1885)
+  * Semicolons are now allowed in URL paths (MRI only), useful for Angular or Redmine (#1934)
+  * Allow extra dependencies to be defined when using prune_bundler (#1105)
+  * Puma now reports the correct port when binding to port 0, also reports other listeners when binding to localhost (#1786)
+  * Sending SIGINFO to any Puma worker now prints currently active threads and their backtraces (#1320)
+  * Puma threads all now have their name set on Ruby 2.3+ (#1968)
+* 4 bugfixes
+  * Fix some misbehavior with phased restart and externally SIGTERMed workers (#1908, #1952)
+  * Fix socket closing on error (#1941)
+  * Removed unnecessary SIGINT trap for JRuby that caused some race conditions (#1961)
+  * Fix socket files being left around after process stopped (#1970)
+* Absolutely thousands of lines of test improvements and fixes thanks to @MSP-Greg
+
+## 4.1.1 / 2019-09-05
+
+* 3 bugfixes
+  * Revert our attempt to not dup STDOUT/STDERR (#1946)
+  * Fix socket close on error (#1941)
+  * Fix workers not shutting down correctly (#1908)
+
+## 4.1.0 / 2019-08-08
+
+* 4 features
+  * Add REQUEST_PATH on parse error message (#1831)
+  * You can now easily add custom log formatters with the `log_formatter` config option (#1816)
+  * Puma.stats now provides process start times (#1844)
+  * Add support for disabling TLSv1.1 (#1836)
+
+* 7 bugfixes
+  * Fix issue where Puma was creating zombie process entries (#1887)
+  * Fix bugs with line-endings and chunked encoding (#1812)
+  * RACK_URL_SCHEME is now set correctly in all conditions (#1491)
+  * We no longer mutate global STDOUT/STDERR, particularly the sync setting (#1837)
+  * SSL read_nonblock no longer blocks (#1857)
+  * Swallow connection errors when sending early hints (#1822)
+  * Backtrace no longer dumped when invalid pumactl commands are run (#1863)
+
+* 5 other
+  * Avoid casting worker_timeout twice (#1838)
+  * Removed a call to private that wasn't doing anything (#1882)
+  * README, Rakefile, docs and test cleanups (#1848, #1847, #1846, #1853, #1859, #1850, #1866, #1870, #1872, #1833, #1888)
+  * Puma.io has proper documentation now (https://puma.io/puma/)
+  * Added the Contributor Covenant CoC
+
+* 1 known issue
+  * Some users are still experiencing issues surrounding socket activation and Unix sockets (#1842)
+
+## 4.0.1 / 2019-07-11
+
+* 2 bugfixes
+  * Fix socket removed after reload - should fix problems with systemd socket activation. (#1829)
+  * Add extconf tests for DTLS_method & TLS_server_method, use in minissl.rb. Should fix "undefined symbol: DTLS_method" when compiling against old OpenSSL versions. (#1832)
+* 1 other
+  * Removed unnecessary RUBY_VERSION checks. (#1827)
+
+## 4.0.0 / 2019-06-25
+
+* 9 features
+  * Add support for disabling TLSv1.0 (#1562)
+  * Request body read time metric (#1569)
+  * Add out_of_band hook (#1648)
+  * Re-implement (native) IOBuffer for JRuby (#1691)
+  * Min worker timeout (#1716)
+  * Add option to suppress SignalException on SIGTERM (#1690)
+  * Allow mutual TLS CA to be set using `ssl_bind` DSL (#1689)
+  * Reactor now uses nio4r instead of `select` (#1728)
+  * Add status to pumactl with pidfile (#1824)
+
+* 10 bugfixes
+  * Do not accept new requests on shutdown (#1685, #1808)
+  * Fix 3 corner cases when request body is chunked (#1508)
+  * Change pid existence check's condition branches (#1650)
+  * Don't call .stop on a server that doesn't exist (#1655)
+  * Implemented NID_X9_62_prime256v1 (P-256) curve over P-521 (#1671)
+  * Fix @notify.close can't modify frozen IOError (RuntimeError) (#1583)
+  * Fix Java 8 support (#1773)
+  * Fix error `uninitialized constant Puma::Cluster` (#1731)
+  * Fix `not_token` being able to be set to true (#1803)
+  * Fix "Hang on SIGTERM with ruby 2.6 in clustered mode" ([PR #1741], [#1674], [#1720], [#1730], [#1755])
+
+[PR #1741]: https://github.com/puma/puma/pull/1741
+[#1674]: https://github.com/puma/puma/issues/1674
+[#1720]: https://github.com/puma/puma/issues/1720
+[#1730]: https://github.com/puma/puma/issues/1730
+[#1755]: https://github.com/puma/puma/issues/1755
+
+## 3.12.1 / 2019-03-19
+
+* 1 features
+  * Internal strings are frozen (#1649)
+* 3 bugfixes
+  * Fix chunked ending check (#1607)
+  * Rack handler should use provided default host (#1700)
+  * Better support for detecting runtimes that support `fork` (#1630)
+
+## 3.12.0 / 2018-07-13
+
+* 5 features:
+  * You can now specify which SSL ciphers the server should support, default is unchanged (#1478)
+  * The setting for Puma's `max_threads` is now in `Puma.stats` (#1604)
+  * Pool capacity is now in `Puma.stats` (#1579)
+  * Installs restricted to Ruby 2.2+ (#1506)
+  * `--control` is now deprecated in favor of `--control-url` (#1487)
+
+* 2 bugfixes:
+  * Workers will no longer accept more web requests than they have capacity to process. This prevents an issue where one worker would accept lots of requests while starving other workers (#1563)
+  * In a test env puma now emits the stack on an exception (#1557)
+
+## 3.11.4 / 2018-04-12
+
+* 2 features:
+  * Manage puma as a service using rc.d (#1529)
+  * Server stats are now available from a top level method (#1532)
+* 5 bugfixes:
+  * Fix parsing CLI options (#1482)
+  * Order of stderr and stdout is made before redirecting to a log file (#1511)
+  * Init.d fix of `ps -p` to check if pid exists (#1545)
+  * Early hints bugfix (#1550)
+  * Purge interrupt queue when closing socket fails (#1553)
+
+## 3.11.3 / 2018-03-05
+
+* 3 bugfixes:
+  * Add closed? to MiniSSL::Socket for use in reactor (#1510)
+  * Handle EOFError at the toplevel of the server threads (#1524) (#1507)
+  * Deal with zero sized bodies when using SSL (#1483)
+
+## 3.11.2 / 2018-01-19
+
+* 1 bugfix:
+  * Deal with read\_nonblock returning nil early
+
+## 3.11.1 / 2018-01-18
+
+* 1 bugfix:
+  * Handle read\_nonblock returning nil when the socket close (#1502)
+
+## 3.11.0 / 2017-11-20
+
+* 2 features:
+  * HTTP 103 Early Hints (#1403)
+  * 421/451 status codes now have correct status messages attached (#1435)
+
+* 9 bugfixes:
+  * Environment config files (/config/puma/<ENV>.rb) load correctly (#1340)
+  * Specify windows dependencies correctly (#1434, #1436)
+  * puma/events required in test helper (#1418)
+  * Correct control CLI's option help text (#1416)
+  * Remove a warning for unused variable in mini_ssl (#1409)
+  * Correct pumactl docs argument ordering (#1427)
+  * Fix an uninitialized variable warning in server.rb (#1430)
+  * Fix docs typo/error in Launcher init (#1429)
+  * Deal with leading spaces in RUBYOPT (#1455)
+
+* 2 other:
+  * Add docs about internals (#1425, #1452)
+  * Tons of test fixes from @MSP-Greg (#1439, #1442, #1464)
+
+## 3.10.0 / 2017-08-17
+
+* 3 features:
+  * The status server has a new /gc and /gc-status command. (#1384)
+  * The persistent and first data timeouts are now configurable (#1111)
+  * Implemented RFC 2324 (#1392)
+
+* 12 bugfixes:
+  * Not really a Puma bug, but @NickolasVashchenko created a gem to workaround a Ruby bug that some users of Puma may be experiencing. See README for more. (#1347)
+  * Fix hangups with SSL and persistent connections. (#1334)
+  * Fix Rails double-binding to a port (#1383)
+  * Fix incorrect thread names (#1368)
+  * Fix issues with /etc/hosts and JRuby where localhost addresses were not correct. (#1318)
+  * Fix compatibility with RUBYOPT="--enable-frozen-string-literal" (#1376)
+  * Fixed some compiler warnings (#1388)
+  * We actually run the integration tests in CI now (#1390)
+  * No longer shipping unnecessary directories in the gemfile (#1391)
+  * If RUBYOPT is nil, we no longer blow up on restart. (#1385)
+  * Correct response to SIGINT (#1377)
+  * Proper exit code returned when we receive a TERM signal (#1337)
+
+* 3 refactors:
+  * Various test improvements from @grosser
+  * Rubocop (#1325)
+  * Hoe has been removed (#1395)
+
+* 1 known issue:
+  * Socket activation doesn't work in JRuby. Their fault, not ours. (#1367)
+
 ## 3.9.1 / 2017-06-03
 
 * 2 bugfixes:
@@ -1303,3 +1526,12 @@ be added back in a future date when a java Puma::MiniSSL is added.
 ## 1.0.0 / 2012-03-29
 
 * Released!
+
+## Ignore - this is for maintainers to copy-paste during release
+## Master
+
+* Features
+  * Your feature goes here (#Github Number)
+
+* Bugfixes
+  * Your bugfix goes here (#Github Number)

data/README.md

@@ -1,179 +1,136 @@
+<p align="center">
+  <img src="https://puma.io/images/logos/puma-logo-large.png">
+</p>
+
 # Puma: A Ruby Web Server Built For Concurrency
 
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/puma/puma?utm\_source=badge&utm\_medium=badge&utm\_campaign=pr-badge)
-[![Build Status](https://secure.travis-ci.org/puma/puma.svg)](http://travis-ci.org/puma/puma)
-[![Dependency Status](https://gemnasium.com/puma/puma.svg)](https://gemnasium.com/puma/puma)
-[![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
+[![Actions Build Status](https://github.com/puma/puma/workflows/Puma/badge.svg)](https://github.com/puma/puma/actions)
+[![Travis Build Status](https://travis-ci.org/puma/puma.svg?branch=master)](https://travis-ci.org/puma/puma)
 
-## Description
+[![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)
 
-Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications. Puma is intended for use in both development and production environments. In order to get the best throughput, it is highly recommended that you use a  Ruby implementation with real threads like Rubinius or JRuby.
+Puma is a **simple, fast, multi-threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications**.
 
 ## Built For Speed &amp; Concurrency
 
-Puma is a simple, fast, and highly concurrent HTTP 1.1 server for Ruby web applications. It can be used with any application that supports Rack, and is considered the replacement for Webrick and Mongrel. It was designed to be the go-to server for [Rubinius](http://rubini.us), but also works well with JRuby and MRI. Puma is intended for use in both development and production environments.
-
-Under the hood, 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 in a thread from an internal thread pool (which you can control). This allows Puma to provide real concurrency for your web application!
+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.
 
-With Rubinius 2.0, Puma will utilize all cores on your CPU with real threads, meaning you won't have to spawn multiple processes to increase throughput. You can expect to see a similar benefit from JRuby.
+Puma was designed to be the go-to server for [Rubinius](https://rubinius.com), but also works well with JRuby and MRI.
 
-On MRI, there is a Global Interpreter Lock (GIL) that ensures only one thread can be run 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 blocking IO to be run concurrently (EventMachine-based servers such as Thin turn off this ability, requiring you to use special libraries). Your mileage may vary. In order to get the best throughput, it is highly recommended that you use a Ruby implementation with real threads like [Rubinius](http://rubini.us) or [JRuby](http://jruby.org).
+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.
 
 ## Quick Start
 
-The easiest way to get started with Puma is to install it via RubyGems. You can do this easily:
-
-    $ gem install puma
-
-Now you should have the `puma` command available in your PATH, so just do the following in the root folder of your Rack application:
-
-    $ puma app.ru
-
-## Plugins
-
-Puma 3.0 added support for plugins that can augment configuration and service operations.
-
-2 canonical plugins to look to aid in development of further plugins:
-
-* [tmp\_restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb): Restarts the server if the file `tmp/restart.txt` is touched
-* [heroku](https://github.com/puma/puma-heroku/blob/master/lib/puma/plugin/heroku.rb): Packages up the default configuration used by puma on Heroku
-
-Plugins are activated in a puma configuration file (such as `config/puma.rb'`) by adding `plugin "name"`, such as `plugin "heroku"`.
-
-Plugins are activated based simply on path requirements so, activating the `heroku` plugin will simply be doing `require "puma/plugin/heroku"`. This allows gems to provide multiple plugins (as well as unrelated gems to provide puma plugins).
-
-The `tmp_restart` plugin is bundled with puma, so it can always be used.
-
-To use the `heroku` plugin, add `puma-heroku` to your Gemfile or install it.
+```
+$ gem install puma
+$ puma
+```
 
-### API
+Without arguments, puma will look for a rackup (.ru) file in the current working directory called `config.ru`.
 
-At present, there are 2 hooks that plugins can use: `start` and `config`.
+## Frameworks
 
-`start` runs when the server has started and allows the plugin to start other functionality to augment puma.
+### Rails
 
-`config` runs when the server is being configured and is passed a `Puma::DSL` object that can be used to add additional configuration.
+Puma is the default server for Rails, included in the generated Gemfile.
 
-Any public methods in `Puma::Plugin` are the public API that any plugin may use.
+Start your server with the `rails` command:
 
-In the future, more hooks and APIs will be added.
+```
+$ rails server
+```
 
+Many configuration options and Puma features are not available when using `rails server`. It is recommended that you use Puma's executable instead:
 
-## Advanced Setup
+```
+$ bundle exec puma
+```
 
 ### Sinatra
 
 You can run your Sinatra application with Puma from the command line like this:
 
-    $ ruby app.rb -s Puma
-
-Or you can configure your application to always use Puma:
-
-    require 'sinatra'
-    configure { set :server, :puma }
-
-If you use Bundler, make sure you add Puma to your Gemfile (see below).
-
-### Rails
-
-First, make sure Puma is in your Gemfile:
-
-    gem 'puma'
-
-Then start your server with the `rails` command:
-
-    $ rails s Puma
-
-### Rackup
-
-You can pass it as an option to `rackup`:
-
-    $ rackup -s Puma
+```
+$ ruby app.rb -s Puma
+```
 
-Alternatively, you can modify your `config.ru` to choose Puma by default, by adding the following as the first line:
+Or you can configure your Sinatra application to always use Puma:
 
-    #\ -s puma
+```ruby
+require 'sinatra'
+configure { set :server, :puma }
+```
 
 ## Configuration
 
-Puma provides numerous options for controlling the operation of the server. Consult `puma -h` (or `puma --help`) for a full list.
+Puma provides numerous options. Consult `puma -h` (or `puma --help`) for a full list of CLI options, or see [dsl.rb](https://github.com/puma/puma/blob/master/lib/puma/dsl.rb).
+
+You can also find several configuration examples as part of the
+[test](test/config) suite.
 
 ### Thread Pool
 
-Puma utilizes a dynamic thread pool which you can modify. You can set the minimum and maximum number of threads that are available in the pool with the `-t` (or `--threads`) flag:
+Puma uses a thread pool. You can set the minimum and maximum number of threads that are available in the pool with the `-t` (or `--threads`) flag:
 
-    $ puma -t 8:32
+```
+$ puma -t 8:32
+```
 
-Puma will automatically scale the number of threads, from the minimum until it caps out at the maximum, based on how much traffic is present. The current default is `0:16`. Feel free to experiment, but be careful not to set the number of maximum threads to a very large number, as you may exhaust resources on the system (or hit resource limits).
+Puma will automatically scale the number of threads, from the minimum until it caps out at the maximum, based on how much traffic is present. The current default is `0:16`. Feel free to experiment, but be careful not to set the number of maximum threads to a large number, as you may exhaust resources on the system (or cause contention for the Global VM Lock, when using MRI).
 
-### Clustered mode
+Be aware that additionally Puma creates threads on its own for internal purposes (e.g. handling slow clients). So, even if you specify -t 1:1, expect around 7 threads created in your application.
 
-Puma 2 offers clustered mode, allowing you to use forked processes to handle multiple incoming requests concurrently, in addition to threads already provided. You can tune the number of workers with the `-w` (or `--workers`) flag:
+### Clustered mode
 
-    $ puma -t 8:32 -w 3
+Puma also offers "clustered mode". Clustered mode `fork`s workers from a master process. Each child process still has its own thread pool. You can tune the number of workers with the `-w` (or `--workers`) flag:
 
-On a ruby implementation that offers native threads, you should tune this number to match the number of cores available.
-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 be 32 threads.
+```
+$ puma -t 8:32 -w 3
+```
 
-If you're running in Clustered Mode you can optionally choose to preload your application before starting up the workers. This is necessary in order to take advantage of the [Copy on Write](http://en.wikipedia.org/wiki/Copy-on-write) feature introduced in [MRI Ruby 2.0](https://blog.heroku.com/archives/2013/3/6/matz_highlights_ruby_2_0_at_waza). To do this simply specify the `--preload` flag in invocation:
+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.
 
-    # CLI invocation
-    $ puma -t 8:32 -w 3 --preload
+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:
 
-If you're using a configuration file, use the `preload_app!` method, and be sure to specify your config file's location with the `-C` flag:
+```
+$ puma -w 3 --preload
+```
 
-    $ puma -C config/puma.rb
+If you're using a configuration file, use the `preload_app!` method:
 
-    # config/puma.rb
-    threads 8,32
-    workers 3
-    preload_app!
+```ruby
+# config/puma.rb
+workers 3
+preload_app!
+```
 
 Additionally, you can specify a block in your configuration file that will be run on boot of each worker:
 
-    # config/puma.rb
-    on_worker_boot do
-      # configuration here
-    end
+```ruby
+# config/puma.rb
+on_worker_boot do
+  # configuration here
+end
+```
 
 This code can be used to setup the process before booting the application, allowing
 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 to add hooks.
-
-If you're preloading your application and using ActiveRecord, it's recommended that you setup your connection pool here:
-
-    # config/puma.rb
-    on_worker_boot do
-      ActiveSupport.on_load(:active_record) do
-        ActiveRecord::Base.establish_connection
-      end
-    end
-
-On top of that, you can specify a block in your configuration file that will be run before workers are forked
-
-    # config/puma.rb
-    before_fork do
-      # configuration here
-    end
-
-This code can be used to clean up before forking to clients, allowing
-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.
 
-If you're preloading your application and using ActiveRecord, it's recommended that you close any connections to the database here to prevent connection leakage:
+`before_fork` specifies a block to be run before workers are forked:
 
-    # config/puma.rb
-    before_fork do
-      ActiveRecord::Base.connection_pool.disconnect!
-    end
-
-This rule applies to any connections to external services (Redis, databases, memcache, ...) that might be started automatically by the framework.
-
-When you use preload_app, all of your new code goes into the master process, and is then copied into the workers (meaning it’s only compatible with cluster mode). General rule is to use preload_app when your workers die often and need fast starts. If you don’t have many workers, you probably should not use preload_app.
+```ruby
+# config/puma.rb
+before_fork do
+  # configuration here
+end
+```
 
-Note that preload_app can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preload_app is all about copying the code of master into the workers.
+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.
 
-### Error handler for low-level errors
+### Error handling
 
 If puma encounters an error outside of the context of your application, it will respond with a 500 and a simple
 textual error message (see `lowlevel_error` in [this file](https://github.com/puma/puma/blob/master/lib/puma/server.rb)).
@@ -189,165 +146,146 @@ end
 
 ### Binding TCP / Sockets
 
-In contrast to many other server configs which require multiple flags, Puma simply uses one URI parameter with the `-b` (or `--bind`) flag:
+Bind Puma to a socket with the `-b` (or `--bind`) flag:
 
-    $ puma -b tcp://127.0.0.1:9292
+```
+$ puma -b tcp://127.0.0.1:9292
+```
 
-Want to use UNIX Sockets instead of TCP (which can provide a 5-10% performance boost)? No problem!
+To use a UNIX Socket instead of TCP:
 
-    $ puma -b unix:///var/run/puma.sock
+```
+$ puma -b unix:///var/run/puma.sock
+```
 
 If you need to change the permissions of the UNIX socket, just add a umask parameter:
 
-    $ puma -b 'unix:///var/run/puma.sock?umask=0111'
-
-Need a bit of security? Use SSL sockets!
-
-    $ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
-
-### Control/Status Server
-
-Puma comes with a builtin status/control app that can be used to query and control Puma itself. Here is an example of starting Puma with the control server:
-
-    $ puma --control tcp://127.0.0.1:9293 --control-token foo
-
-This directs Puma to start the control server on localhost port 9293. Additionally, all requests to the control server will need to include `token=foo` as a query parameter. This allows for simple authentication. Check out [status.rb](https://github.com/puma/puma/blob/master/lib/puma/app/status.rb) to see what the app has available.
+```
+$ puma -b 'unix:///var/run/puma.sock?umask=0111'
+```
 
-Keep in mind that the status/control server accepts `pumactl` commands. To demonstrate, you can run the following command with the foo `--control-token` as such to restart: 
+Need a bit of security? Use SSL sockets:
 
-    $ pumactl restart --control-token foo
+```
+$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
+```
 
-To see a list of `pumactl` options, please see `pumactl --help` as stated in the [`pumactl`](https://github.com/puma/puma#pumactl) section.
+#### Controlling SSL Cipher Suites
 
-### Configuration file
+To use or avoid specific SSL cipher suites, use `ssl_cipher_filter` or `ssl_cipher_list` options.
 
-You can also provide a configuration file which Puma will use with the `-C` (or `--config`) flag:
+##### Ruby:
 
-    $ puma -C /path/to/config
+```
+$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&ssl_cipher_filter=!aNULL:AES+SHA'
+```
 
-By default, 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` environment variable, the default file location will be config/puma/environment_name.rb.
+##### JRuby:
 
-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:
+```
+$ puma -b 'ssl://127.0.0.1:9292?keystore=path_to_keystore&keystore-pass=keystore_password&ssl_cipher_list=TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA'
+```
 
-    $ puma -C "-"
+See https://www.openssl.org/docs/man1.0.2/apps/ciphers.html for cipher filter format and full list of cipher suites.
 
-Take the following [sample configuration](https://github.com/puma/puma/blob/master/examples/config.rb) as inspiration or check out [configuration.rb](https://github.com/puma/puma/blob/master/lib/puma/configuration.rb) to see all available options.
+Disable TLS v1 with the `no_tlsv1` option:
 
-## Restart
+```
+$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&no_tlsv1=true'
+```
 
-Puma includes the ability to restart itself allowing easy upgrades to new versions. When available (MRI, Rubinius, JRuby), Puma performs a "hot restart". This is the same functionality available in *unicorn* and *nginx* which keep the server sockets open between restarts. This makes sure that no pending requests are dropped while the restart is taking place.
+### Control/Status Server
 
-To perform a restart, there are 2 builtin mechanisms:
+Puma has a built-in status and control app that can be used to query and control Puma.
 
-  * Send the `puma` process the `SIGUSR2` signal
-  * Use the status server and issue `/restart`
+```
+$ puma --control-url tcp://127.0.0.1:9293 --control-token foo
+```
 
-No code is shared between the current and restarted process, so it should be safe to issue a restart any place where you would manually stop Puma and start it again.
+Puma will start the control server on localhost port 9293. All requests to the control server will need to include control token (in this case, `token=foo`) as a query parameter. This allows for simple authentication. Check out [status.rb](https://github.com/puma/puma/blob/master/lib/puma/app/status.rb) to see what the status app has available.
 
-If the new process is unable to load, it will simply exit. You should therefore run Puma under a process monitor (see below) when using it in production.
+You can also interact with the control server via `pumactl`. This command will restart Puma:
 
-### Normal vs Hot vs Phased Restart
+```
+$ pumactl --control-url 'tcp://127.0.0.1:9293' --control-token foo restart
+```
 
-A hot restart means that no requests will be lost while deploying your new code, since the server socket is kept open between restarts.
+To see a list of `pumactl` options, use `pumactl --help`.
 
-But beware, hot restart does not mean that the incoming requests won’t hang for multiple seconds while your new code has not fully deployed. If you need a zero downtime and zero hanging requests deploy, you must use phased restart.
+### Configuration File
 
-When you run pumactl phased-restart, Puma kills workers one-by-one, meaning that at least another worker is still available to serve requests, which lead to zero hanging requests (yay!).
+You can also provide a configuration file with the `-C` (or `--config`) flag:
 
-But again beware, upgrading an application sometimes involves upgrading the database schema. With phased restart, there may be a moment during the deployment where processes belonging to the previous version and processes belonging to the new version both exist at the same time. Any database schema upgrades you perform must therefore be backwards-compatible with the old application version.
+```
+$ puma -C /path/to/config
+```
 
-If you perform a lot of database migrations, you probably should not use phased restart and use a normal/hot restart instead (pumactl restart). That way, no code is shared while deploying (in that case, preload_app might help for quicker deployment, see below).
+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` environment variable, Puma looks for configuration at `config/puma/<environment_name>.rb`.
 
-### Puma Signals
+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:
 
-Puma cluster responds to these signals:
+```
+$ puma -C "-"
+```
 
-- `TTIN` increment the worker count by 1
-- `TTOU` decrement the worker count by 1
-- `TERM` send `TERM` to worker. Worker will attempt to finish then exit.
-- `USR2` restart workers
-- `USR1` restart workers in phases, a rolling restart.
-- `HUP`  reopen log files defined in stdout_redirect configuration parameter
-- `INT` equivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
-- `CHLD`
+The other side-effects of setting the environment are whether to show stack traces (in `development` or `test`), and setting RACK_ENV may potentially affect middleware looking for this value to change their behavior. The default puma RACK_ENV value is `development`. You can see all config default values [here](https://github.com/puma/puma/blob/12d1706ddc71b89ed2ee26275e31c788e94ff541/lib/puma/configuration.rb#L170).
 
-A detailed guide to using UNIX signals with Puma can be found in the [signals documentation](https://github.com/puma/puma/blob/master/docs/signals.md).
+Check out [dsl.rb](https://github.com/puma/puma/blob/master/lib/puma/dsl.rb) to see all available options.
 
-### Release Directory
+## Restart
 
-If your symlink releases into a common working directory (i.e., `/current` from Capistrano), Puma won't pick up your new changes when running phased restarts without additional configuration. You should set your working directory within Puma's config to specify the directory it should use. This is a change from earlier versions of Puma (< 2.15) that would infer the directory for you.
+Puma includes the ability to restart itself. When available (MRI, Rubinius, JRuby), Puma performs a "hot restart". This is the same functionality available in *Unicorn* and *NGINX* which keep the server sockets open between restarts. This makes sure that no pending requests are dropped while the restart is taking place.
 
-```ruby
-# config/puma.rb
+For more, see the [restart documentation](https://github.com/puma/puma/blob/master/docs/restart.md).
 
-directory '/var/www/current'
-```
+## Signals
 
-### Cleanup Code
+Puma responds to several signals. A detailed guide to using UNIX signals with Puma can be found in the [signals documentation](https://github.com/puma/puma/blob/master/docs/signals.md).
 
-Puma isn't able to understand all the resources that your app may use, so it provides a hook in the configuration file you pass to `-C` called `on_restart`. The block passed to `on_restart` will be called, unsurprisingly, just before Puma restarts itself.
+## Platform Constraints
 
-You should place code to close global log files, redis connections, etc in this block so that their file descriptors don't leak into the restarted process. Failure to do so will result in slowly running out of descriptors and eventually obscure crashes as the server is restarted many times.
+Some platforms do not support all Puma features.
 
-### Platform Constraints
+  * **JRuby**, **Windows**: server sockets are not seamless on restart, they must be closed and reopened. These platforms have no way to pass descriptors into a new process that is exposed to Ruby. Also, cluster mode is not supported due to a lack of fork(2).
+  * **Windows**: Cluster mode is not supported due to a lack of fork(2).
 
-Because of various platforms not being able to implement certain things, the following differences occur when Puma is used on different platforms:
+## Known Bugs
 
-  * **JRuby**, **Windows**: server sockets are not seamless on restart, they must be closed and reopened. These platforms have no way to pass descriptors into a new process that is exposed to ruby
-  * **JRuby**, **Windows**: cluster mode is not supported due to a lack of  fork(2)
-  * **Windows**: daemon mode is not supported due to a lack of fork(2)
+For MRI versions 2.2.7, 2.2.8, 2.2.9, 2.2.10 2.3.4 and 2.4.1, you may see ```stream closed in another thread (IOError)```. It may be caused by a [Ruby bug](https://bugs.ruby-lang.org/issues/13632). It can be fixed with the gem https://rubygems.org/gems/stopgap_13632:
 
-## pumactl
+```ruby
+if %w(2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1).include? RUBY_VERSION
+  begin
+    require 'stopgap_13632'
+  rescue LoadError
+  end
+end
+```
 
-`pumactl` is a simple CLI frontend to the control/status app described above.  Please refer to `pumactl --help` for available commands.
+## Deployment
 
-## Process Monitors
+Puma has support for Capistrano with an [external gem](https://github.com/seuros/capistrano-puma).
 
-Process monitors or supervisors will at minimum provide start of Puma
-on system boot. Modern process monitors like systemd or upstart
-further provide continuous monitoring and restarts for increased
+It is common to use process monitors with Puma. Modern process monitors like systemd or upstart
+provide continuous monitoring and restarts for increased
 reliability in production environments:
 
 * [tools/jungle](https://github.com/puma/puma/tree/master/tools/jungle) for sysvinit (init.d) and upstart
 * [docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md)
 
-## Capistrano deployment
-
-Puma has support for Capistrano3 with an [external gem](https://github.com/seuros/capistrano-puma), you just need require that in Gemfile:
-
-```ruby
-gem 'capistrano3-puma'
-```
-And then execute:
-
-```bash
-bundle
-```
-
-Then add to Capfile
-
-```ruby
-require 'capistrano/puma'
-```
+## Community Plugins
 
-and then
-
-```bash
-$ bundle exec cap puma:start
-$ bundle exec cap puma:restart
-$ bundle exec cap puma:stop
-$ bundle exec cap puma:phased-restart
-```
+* [puma-heroku](https://github.com/evanphx/puma-heroku) — default Puma configuration for running on Heroku
+* [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
 
 ## Contributing
 
-To run the test suite:
+Find details for contributing in the [contribution guide].
 
-```bash
-$ bundle install
-$ bundle exec rake
-```
+[contribution guide]: https://github.com/puma/puma/blob/master/CONTRIBUTING.md
 
 ## License
 
-Puma is copyright 2014 Evan Phoenix and contributors. It is licensed under the BSD 3-Clause license. See the included LICENSE file for details.
+Puma is copyright Evan Phoenix and contributors, licensed under the BSD 3-Clause license. See the included LICENSE file for details.