puma 6.0.0 → 6.6.0

data/lib/puma/dsl.rb

@@ -47,11 +47,13 @@ module Puma
   #     | on_worker_boot     | :before_worker_boot     | inside, before      |
   #     | on_worker_shutdown | :before_worker_shutdown | inside, after       |
   #     | on_refork          | :before_refork          | inside              |
+  #     | after_refork       | :after_refork           | inside              |
   #
   class DSL
     ON_WORKER_KEY = [String, Symbol].freeze
 
-    # convenience method so logic can be used in CI
+    # Convenience method so logic can be used in CI.
+    #
     # @see ssl_bind
     #
     def self.ssl_bind_str(host, port, opts)
@@ -65,6 +67,7 @@ module Puma
 
       ca_additions = "&ca=#{Puma::Util.escape(opts[:ca])}" if ['peer', 'force_peer'].include?(verify)
 
+      low_latency_str = opts.key?(:low_latency) ? "&low_latency=#{opts[:low_latency]}" : ''
       backlog_str = opts[:backlog] ? "&backlog=#{Integer(opts[:backlog])}" : ''
 
       if defined?(JRUBY_VERSION)
@@ -84,10 +87,12 @@ module Puma
           "&verify_mode=#{verify}#{tls_str}#{ca_additions}#{backlog_str}"
       else
         ssl_cipher_filter = opts[:ssl_cipher_filter] ? "&ssl_cipher_filter=#{opts[:ssl_cipher_filter]}" : nil
+        ssl_ciphersuites = opts[:ssl_ciphersuites] ? "&ssl_ciphersuites=#{opts[:ssl_ciphersuites]}" : nil
         v_flags = (ary = opts[:verification_flags]) ? "&verification_flags=#{Array(ary).join ','}" : nil
 
         cert_flags = (cert = opts[:cert]) ? "cert=#{Puma::Util.escape(cert)}" : nil
         key_flags = (key = opts[:key]) ? "&key=#{Puma::Util.escape(key)}" : nil
+        password_flags = (password_command = opts[:key_password_command]) ? "&key_password_command=#{Puma::Util.escape(password_command)}" : nil
 
         reuse_flag =
           if (reuse = opts[:reuse])
@@ -113,8 +118,8 @@ module Puma
             nil
           end
 
-        "ssl://#{host}:#{port}?#{cert_flags}#{key_flags}#{ssl_cipher_filter}" \
-          "#{reuse_flag}&verify_mode=#{verify}#{tls_str}#{ca_additions}#{v_flags}#{backlog_str}"
+        "ssl://#{host}:#{port}?#{cert_flags}#{key_flags}#{password_flags}#{ssl_cipher_filter}#{ssl_ciphersuites}" \
+          "#{reuse_flag}&verify_mode=#{verify}#{tls_str}#{ca_additions}#{v_flags}#{backlog_str}#{low_latency_str}"
       end
     end
 
@@ -161,7 +166,10 @@ module Puma
       @options[key.to_sym] || default
     end
 
-    # Load the named plugin for use by this configuration
+    # Load the named plugin for use by this configuration.
+    #
+    # @example
+    #   plugin :tmp_restart
     #
     def plugin(name)
       @plugins << @config.load_plugin(name)
@@ -208,6 +216,7 @@ module Puma
     #   activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
     # @example
     #   activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }
+    #
     def activate_control_app(url="auto", opts={})
       if url == "auto"
         path = Configuration.temp_path
@@ -233,8 +242,12 @@ module Puma
       @options[:control_url_umask] = opts[:umask] if opts[:umask]
     end
 
-    # Load additional configuration from a file
-    # Files get loaded later via Configuration#load
+    # Load additional configuration from a file.
+    # Files get loaded later via Configuration#load.
+    #
+    # @example
+    #   load 'config/puma/production.rb'
+    #
     def load(file)
       @options[:config_files] ||= []
       @options[:config_files] << file
@@ -250,6 +263,7 @@ module Puma
     #
     # * Set the socket backlog depth with +backlog+, default is 1024.
     # * Set up an SSL certificate with +key+ & +cert+.
+    # * Set up an SSL certificate for mTLS with +key+, +cert+, +ca+ and +verify_mode+.
     # * Set whether to optimize for low latency instead of throughput with
     #   +low_latency+, default is to not optimize for low latency. This is done
     #   via +Socket::TCP_NODELAY+.
@@ -259,10 +273,13 @@ module Puma
     #   bind 'unix:///var/run/puma.sock?backlog=512'
     # @example SSL cert
     #   bind 'ssl://127.0.0.1:9292?key=key.key&cert=cert.pem'
+    # @example SSL cert for mutual TLS (mTLS)
+    #   bind 'ssl://127.0.0.1:9292?key=key.key&cert=cert.pem&ca=ca.pem&verify_mode=force_peer'
     # @example Disable optimization for low latency
     #   bind 'tcp://0.0.0.0:9292?low_latency=false'
     # @example Socket permissions
     #   bind 'unix:///var/run/puma.sock?umask=0111'
+    #
     # @see Puma::Runner#load_and_bind
     # @see Puma::Cluster#run
     #
@@ -297,33 +314,70 @@ module Puma
     #
     # @example Only bind to systemd activated sockets, ignoring other binds
     #   bind_to_activated_sockets 'only'
+    #
     def bind_to_activated_sockets(bind=true)
       @options[:bind_to_activated_sockets] = bind
     end
 
-    # Define the TCP port to bind to. Use +bind+ for more advanced options.
+    # Define the TCP port to bind to. Use `bind` for more advanced options.
+    #
+    # The default is +9292+.
     #
     # @example
-    #   port 9292
+    #   port 3000
+    #
     def port(port, host=nil)
       host ||= default_host
       bind URI::Generic.build(scheme: 'tcp', host: host, port: Integer(port)).to_s
     end
 
+    # Define how long the tcp socket stays open, if no data has been received.
+    #
+    # The default is 30 seconds.
+    #
+    # @example
+    #   first_data_timeout 40
+    #
+    # @see Puma::Server.new
+    #
+    def first_data_timeout(seconds)
+      @options[:first_data_timeout] = Integer(seconds)
+    end
+
     # Define how long persistent connections can be idle before Puma closes them.
+    #
+    # The default is 20 seconds.
+    #
+    # @example
+    #   persistent_timeout 30
+    #
     # @see Puma::Server.new
+    #
     def persistent_timeout(seconds)
       @options[:persistent_timeout] = Integer(seconds)
     end
 
-    # Define how long the tcp socket stays open, if no data has been received.
+    # If a new request is not received within this number of seconds, begin shutting down.
+    #
+    # The default is +nil+.
+    #
+    # @example
+    #   idle_timeout 60
+    #
     # @see Puma::Server.new
-    def first_data_timeout(seconds)
-      @options[:first_data_timeout] = Integer(seconds)
+    #
+    def idle_timeout(seconds)
+      @options[:idle_timeout] = Integer(seconds)
     end
 
     # Work around leaky apps that leave garbage in Thread locals
     # across requests.
+    #
+    # The default is +false+.
+    #
+    # @example
+    #   clean_thread_locals
+    #
     def clean_thread_locals(which=true)
       @options[:clean_thread_locals] = which
     end
@@ -331,6 +385,7 @@ module Puma
     # When shutting down, drain the accept socket of pending connections and
     # process them. This loops over the accept socket until there are no more
     # read events and then stops looking and waits for the requests to finish.
+    #
     # @see Puma::Server#graceful_shutdown
     #
     def drain_on_shutdown(which=true)
@@ -344,18 +399,22 @@ module Puma
     #
     # @example
     #   environment 'production'
+    #
     def environment(environment)
       @options[:environment] = environment
     end
 
-    # How long to wait for threads to stop when shutting them
-    # down. Defaults to :forever. Specifying :immediately will cause
-    # Puma to kill the threads immediately.  Otherwise the value
-    # is the number of seconds to wait.
+    # How long to wait for threads to stop when shutting them down.
+    # Specifying :immediately will cause Puma to kill the threads immediately.
+    # Otherwise the value is the number of seconds to wait.
     #
     # Puma always waits a few seconds after killing a thread for it to try
     # to finish up it's work, even in :immediately mode.
+    #
+    # The default is +:forever+.
+    #
     # @see Puma::Server#graceful_shutdown
+    #
     def force_shutdown_after(val=:forever)
       i = case val
           when :forever
@@ -378,9 +437,9 @@ module Puma
     #   on_restart do
     #     puts 'On restart...'
     #   end
+    #
     def on_restart(&block)
-      @options[:on_restart] ||= []
-      @options[:on_restart] << block
+      process_hook :on_restart, nil, block, 'on_restart'
     end
 
     # Command to use to restart Puma. This should be just how to
@@ -389,6 +448,7 @@ module Puma
     #
     # @example
     #   restart_command '/u/app/lolcat/bin/restart_puma'
+    #
     def restart_command(cmd)
       @options[:restart_cmd] = cmd.to_s
     end
@@ -397,26 +457,49 @@ module Puma
     #
     # @example
     #   pidfile '/u/apps/lolcat/tmp/pids/puma.pid'
+    #
     def pidfile(path)
       @options[:pidfile] = path.to_s
     end
 
-    # Disable request logging, if this isn't used it'll be enabled by default.
+    # Disable request logging, the inverse of `log_requests`.
+    #
+    # The default is +true+.
     #
     # @example
     #   quiet
+    #
     def quiet(which=true)
       @options[:log_requests] = !which
     end
 
-    # Enable request logging
+    # Enable request logging, the inverse of `quiet`.
+    #
+    # The default is +false+.
+    #
+    # @example
+    #   log_requests
     #
     def log_requests(which=true)
       @options[:log_requests] = which
     end
 
+    # Pass in a custom logging class instance
+    #
+    # @example
+    #   custom_logger Logger.new('t.log')
+    #
+    def custom_logger(custom_logger)
+      @options[:custom_logger] = custom_logger
+    end
+
     # Show debugging info
     #
+    # The default is +false+.
+    #
+    # @example
+    #   debug
+    #
     def debug
       @options[:debug] = true
     end
@@ -427,6 +510,7 @@ module Puma
     #
     # @example
     #   rackup '/u/apps/lolcat/config.ru'
+    #
     def rackup(path)
       @options[:rackup] ||= path.to_s
     end
@@ -434,21 +518,32 @@ module Puma
     # Allows setting `env['rack.url_scheme']`.
     # Only necessary if X-Forwarded-Proto is not being set by your proxy
     # Normal values are 'http' or 'https'.
+    #
     def rack_url_scheme(scheme=nil)
       @options[:rack_url_scheme] = scheme
     end
 
+    # Enable HTTP 103 Early Hints responses.
+    #
+    # The default is +nil+.
+    #
+    # @example
+    #   early_hints
+    #
     def early_hints(answer=true)
       @options[:early_hints] = answer
     end
 
     # Redirect +STDOUT+ and +STDERR+ to files specified. The +append+ parameter
-    # specifies whether the output is appended, the default is +false+.
+    # specifies whether the output is appended.
+    #
+    # The default is +false+.
     #
     # @example
     #   stdout_redirect '/app/lolcat/log/stdout', '/app/lolcat/log/stderr'
     # @example
     #   stdout_redirect '/app/lolcat/log/stdout', '/app/lolcat/log/stderr', true
+    #
     def stdout_redirect(stdout=nil, stderr=nil, append=false)
       @options[:redirect_stdout] = stdout
       @options[:redirect_stderr] = stderr
@@ -459,8 +554,9 @@ module Puma
       @options[:log_formatter] = block
     end
 
-    # Configure +min+ to be the minimum number of threads to use to answer
-    # requests and +max+ the maximum.
+    # Configure the number of threads to use to answer requests.
+    #
+    # It can be a single fixed number, or a +min+ and a +max+.
     #
     # The default is the environment variables +PUMA_MIN_THREADS+ / +PUMA_MAX_THREADS+
     # (or +MIN_THREADS+ / +MAX_THREADS+ if the +PUMA_+ variables aren't set).
@@ -468,10 +564,13 @@ module Puma
     # If these environment variables aren't set, the default is "0, 5" in MRI or "0, 16" for other interpreters.
     #
     # @example
+    #   threads 5
+    # @example
     #   threads 0, 16
     # @example
     #   threads 5, 5
-    def threads(min, max)
+    #
+    def threads(min, max = min)
       min = Integer(min)
       max = Integer(max)
       if min > max
@@ -500,11 +599,18 @@ module Puma
     # `true`, which sets reuse 'on' with default values, or a hash, with `:size`
     # and/or `:timeout` keys, each with integer values.
     #
+    # The `cert:` options hash parameter can be the path to a certificate
+    # file including all intermediate certificates in PEM format.
+    #
+    # The `cert_pem:` options hash parameter can be String containing the
+    # cerificate and all intermediate certificates in PEM format.
+    #
     # @example
     #   ssl_bind '127.0.0.1', '9292', {
     #     cert: path_to_cert,
     #     key: path_to_key,
     #     ssl_cipher_filter: cipher_filter, # optional
+    #     ssl_ciphersuites: ciphersuites,   # optional
     #     verify_mode: verify_mode,         # default 'none'
     #     verification_flags: flags,        # optional, not supported by JRuby
     #     reuse: true                       # optional
@@ -527,6 +633,7 @@ module Puma
     #     ssl_cipher_list: cipher_list,     # optional
     #     verify_mode: verify_mode          # default 'none'
     #   }
+    #
     def ssl_bind(host, port, opts = {})
       add_pem_values_to_options_store(opts)
       bind self.class.ssl_bind_str(host, port, opts)
@@ -537,6 +644,7 @@ module Puma
     #
     # @example
     #   state_path '/u/apps/lolcat/tmp/pids/puma.state'
+    #
     def state_path(path)
       @options[:state] = path.to_s
     end
@@ -545,6 +653,7 @@ module Puma
     #
     # @example
     #   state_permission 0600
+    #
     # @version 5.0.0
     #
     def state_permission(permission)
@@ -558,7 +667,12 @@ module Puma
     # set, otherwise 0.
     #
     # @note Cluster mode only.
+    #
+    # @example
+    #   workers 2
+    #
     # @see Puma::Cluster
+    #
     def workers(count)
       @options[:workers] = count.to_i
     end
@@ -576,11 +690,28 @@ module Puma
     #
     # Moving from workers = 1 to workers = 0 will save 10-30% of memory use.
     #
+    # The default is +false+.
+    #
     # @note Cluster mode only.
+    #
+    # @example
+    #  silence_single_worker_warning
+    #
     def silence_single_worker_warning
       @options[:silence_single_worker_warning] = true
     end
 
+    # Disable warning message when running single mode with callback hook defined.
+    #
+    # The default is +false+.
+    #
+    # @example
+    #   silence_fork_callback_warning
+    #
+    def silence_fork_callback_warning
+      @options[:silence_fork_callback_warning] = true
+    end
+
     # Code to run immediately before master process
     # forks workers (once on boot). These hooks can block if necessary
     # to wait for background operations unknown to Puma to finish before
@@ -591,13 +722,16 @@ module Puma
     # This can be called multiple times to add several hooks.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   before_fork do
     #     puts "Starting workers..."
     #   end
+    #
     def before_fork(&block)
-      @options[:before_fork] ||= []
-      @options[:before_fork] << block
+      warn_if_in_single_mode('before_fork')
+
+      process_hook :before_fork, nil, block, 'before_fork'
     end
 
     # Code to run in a worker when it boots to setup
@@ -606,27 +740,36 @@ module Puma
     # This can be called multiple times to add several hooks.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   on_worker_boot do
     #     puts 'Before worker boot...'
     #   end
+    #
     def on_worker_boot(key = nil, &block)
+      warn_if_in_single_mode('on_worker_boot')
+
       process_hook :before_worker_boot, key, block, 'on_worker_boot'
     end
 
     # Code to run immediately before a worker shuts
-    # down (after it has finished processing HTTP requests). These hooks
+    # down (after it has finished processing HTTP requests). The worker's
+    # index is passed as an argument. These hooks
     # can block if necessary to wait for background operations unknown
     # to Puma to finish before the process terminates.
     #
     # This can be called multiple times to add several hooks.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   on_worker_shutdown do
     #     puts 'On worker shutdown...'
     #   end
+    #
     def on_worker_shutdown(key = nil, &block)
+      warn_if_in_single_mode('on_worker_shutdown')
+
       process_hook :before_worker_shutdown, key, block, 'on_worker_shutdown'
     end
 
@@ -636,11 +779,15 @@ module Puma
     # This can be called multiple times to add several hooks.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   on_worker_fork do
     #     puts 'Before worker fork...'
     #   end
+    #
     def on_worker_fork(&block)
+      warn_if_in_single_mode('on_worker_fork')
+
       process_hook :before_worker_fork, nil, block, 'on_worker_fork'
     end
 
@@ -650,16 +797,42 @@ module Puma
     # This is called everytime a worker is to be started.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   after_worker_fork do
     #     puts 'After worker fork...'
     #   end
+    #
     def after_worker_fork(&block)
+      warn_if_in_single_mode('after_worker_fork')
+
       process_hook :after_worker_fork, nil, block, 'after_worker_fork'
     end
 
     alias_method :after_worker_boot, :after_worker_fork
 
+    # Code to run after puma is booted (works for both: single and clustered)
+    #
+    # @example
+    #   on_booted do
+    #     puts 'After booting...'
+    #   end
+    #
+    def on_booted(&block)
+      @config.options[:events].on_booted(&block)
+    end
+
+    # Code to run after puma is stopped (works for both: single and clustered)
+    #
+    # @example
+    #   on_stopped do
+    #     puts 'After stopping...'
+    #   end
+    #
+    def on_stopped(&block)
+      @config.options[:events].on_stopped(&block)
+    end
+
     # When `fork_worker` is enabled, code to run in Worker 0
     # before all other workers are re-forked from this process,
     # after the server has temporarily stopped serving requests
@@ -672,16 +845,86 @@ module Puma
     # This can be called multiple times to add several hooks.
     #
     # @note Cluster mode with `fork_worker` enabled only.
+    #
     # @example
     #   on_refork do
     #     3.times {GC.start}
     #   end
+    #
     # @version 5.0.0
     #
     def on_refork(key = nil, &block)
+      warn_if_in_single_mode('on_refork')
+
       process_hook :before_refork, key, block, 'on_refork'
     end
 
+    # When `fork_worker` is enabled, code to run in Worker 0
+    # after all other workers are re-forked from this process,
+    # after the server has temporarily stopped serving requests
+    # (once per complete refork cycle).
+    #
+    # This can be used to re-open any connections to remote servers
+    # (database, Redis, ...) that were closed via on_refork.
+    #
+    # This can be called multiple times to add several hooks.
+    #
+    # @note Cluster mode with `fork_worker` enabled only.
+    #
+    # @example
+    #   after_refork do
+    #     puts 'After refork...'
+    #   end
+    #
+    def after_refork(key = nil, &block)
+      process_hook :after_refork, key, block, 'after_refork'
+    end
+
+    # Provide a block to be executed just before a thread is added to the thread
+    # pool. Be careful: while the block executes, thread creation is delayed, and
+    # probably a request will have to wait too! The new thread will not be added to
+    # the threadpool until the provided block returns.
+    #
+    # Return values are ignored.
+    # Raising an exception will log a warning.
+    #
+    # This hook is useful for doing something when the thread pool grows.
+    #
+    # This can be called multiple times to add several hooks.
+    #
+    # @example
+    #   on_thread_start do
+    #     puts 'On thread start...'
+    #   end
+    #
+    def on_thread_start(&block)
+      process_hook :before_thread_start, nil, block, 'on_thread_start'
+    end
+
+    # Provide a block to be executed after a thread is trimmed from the thread
+    # pool. Be careful: while this block executes, Puma's main loop is
+    # blocked, so no new requests will be picked up.
+    #
+    # This hook only runs when a thread in the threadpool is trimmed by Puma.
+    # It does not run when a thread dies due to exceptions or any other cause.
+    #
+    # Return values are ignored.
+    # Raising an exception will log a warning.
+    #
+    # This hook is useful for cleaning up thread local resources when a thread
+    # is trimmed.
+    #
+    # This can be called multiple times to add several hooks.
+    #
+    # @example
+    #   on_thread_exit do
+    #     puts 'On thread exit...'
+    #   end
+    #
+    def on_thread_exit(&block)
+      process_hook :before_thread_exit, nil, block, 'on_thread_exit'
+    end
+
     # Code to run out-of-band when the worker is idle.
     # These hooks run immediately after a request has finished
     # processing and there are no busy threads on the worker.
@@ -691,6 +934,7 @@ module Puma
     # or scheduling asynchronous tasks to execute after a response.
     #
     # This can be called multiple times to add several hooks.
+    #
     def out_of_band(&block)
       process_hook :out_of_band, nil, block, 'out_of_band'
     end
@@ -701,16 +945,21 @@ module Puma
     #
     # @example
     #   directory '/u/apps/lolcat'
+    #
     def directory(dir)
       @options[:directory] = dir.to_s
     end
 
     # Preload the application before starting the workers; this conflicts with
-    # phased restart feature. On by default if your app uses more than 1 worker.
+    # phased restart feature.
+    #
+    # The default is +true+ if your app uses more than 1 worker.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   preload_app!
+    #
     def preload_app!(answer=true)
       @options[:preload_app] = answer
     end
@@ -722,6 +971,7 @@ module Puma
     #   lowlevel_error_handler do |err|
     #     [200, {}, ["error page"]]
     #   end
+    #
     def lowlevel_error_handler(obj=nil, &block)
       obj ||= block
       raise "Provide either a #call'able or a block" unless obj
@@ -741,23 +991,26 @@ module Puma
     # new Bundler context and thus can float around as the release
     # dictates.
     #
-    # @see extra_runtime_dependencies
-    #
     # @note This is incompatible with +preload_app!+.
     # @note This is only supported for RubyGems 2.2+
+    #
+    # @see extra_runtime_dependencies
+    #
     def prune_bundler(answer=true)
       @options[:prune_bundler] = answer
     end
 
-    # By default, Puma will raise SignalException when SIGTERM is received. In
-    # environments where SIGTERM is something expected, you can suppress these
-    # with this option.
+    # Raises a SignalException when SIGTERM is received. In environments where
+    # SIGTERM is something expected, you can suppress these with this option.
     #
     # This can be useful for example in Kubernetes, where rolling restart is
-    # guaranteed usually on infrastructure level.
+    # guaranteed usually on the infrastructure level.
+    #
+    # The default is +true+.
     #
     # @example
     #   raise_exception_on_sigterm false
+    #
     # @see Puma::Launcher#setup_signals
     # @see Puma::Cluster#setup_signals
     #
@@ -776,6 +1029,7 @@ module Puma
     #   extra_runtime_dependencies ['gem_name_1', 'gem_name_2']
     # @example
     #   extra_runtime_dependencies ['puma_worker_killer', 'puma-heroku']
+    #
     # @see Puma::Launcher#extra_runtime_deps_directories
     #
     def extra_runtime_dependencies(answer = [])
@@ -787,21 +1041,26 @@ module Puma
     # If you do not specify a tag, Puma will infer it. If you do not want Puma
     # to add a tag, use an empty string.
     #
+    # The default is the current file or directory base name.
+    #
     # @example
     #   tag 'app name'
     # @example
     #   tag ''
+    #
     def tag(string)
       @options[:tag] = string.to_s
     end
 
     # Change the default interval for checking workers.
     #
-    # The default value is 5 seconds.
+    # The default is 5 seconds.
     #
     # @note Cluster mode only.
+    #
     # @example
-    #   worker_check_interval 5
+    #   worker_check_interval 10
+    #
     # @see Puma::Cluster#check_workers
     #
     def worker_check_interval(interval)
@@ -813,11 +1072,15 @@ module Puma
     # not a request timeout, it is to protect against a hung or dead process.
     # Setting this value will not protect against slow requests.
     #
-    # The minimum value is 6 seconds, the default value is 60 seconds.
+    # This value must be greater than worker_check_interval.
+    #
+    # The default is 60 seconds.
     #
     # @note Cluster mode only.
+    #
     # @example
     #   worker_timeout 60
+    #
     # @see Puma::Cluster::Worker#ping_timeout
     #
     def worker_timeout(timeout)
@@ -833,12 +1096,13 @@ module Puma
 
     # Change the default worker timeout for booting.
     #
-    # If unspecified, this defaults to the value of worker_timeout.
+    # The default is the value of `worker_timeout`.
     #
     # @note Cluster mode only.
     #
     # @example
     #   worker_boot_timeout 60
+    #
     # @see Puma::Cluster::Worker#ping_timeout
     #
     def worker_boot_timeout(timeout)
@@ -847,7 +1111,13 @@ module Puma
 
     # Set the timeout for worker shutdown.
     #
+    # The default is 60 seconds.
+    #
     # @note Cluster mode only.
+    #
+    # @example
+    #   worker_shutdown_timeout 90
+    #
     # @see Puma::Cluster::Worker#term
     #
     def worker_shutdown_timeout(timeout)
@@ -863,9 +1133,13 @@ module Puma
     # 2. **:oldest** - the oldest workers (i.e. the workers that were started
     #    the longest time ago) will be culled.
     #
+    # The default is +:youngest+.
+    #
     # @note Cluster mode only.
+    #
     # @example
     #   worker_culling_strategy :oldest
+    #
     # @see Puma::Cluster#cull_workers
     #
     def worker_culling_strategy(strategy)
@@ -878,7 +1152,7 @@ module Puma
       @options[:worker_culling_strategy] = strategy
     end
 
-    # When set to true (the default), workers accept all requests
+    # When set to true, workers accept all requests
     # and queue them before passing them to the handlers.
     # When set to false, each worker process accepts exactly as
     # many requests as it is configured to simultaneously handle.
@@ -891,7 +1165,11 @@ module Puma
     # slow clients will occupy a handler thread while the request
     # is being sent. A reverse proxy, such as nginx, can handle
     # slow clients and queue requests before they reach Puma.
+    #
+    # The default is +true+.
+    #
     # @see Puma::Server
+    #
     def queue_requests(answer=true)
       @options[:queue_requests] = answer
     end
@@ -909,9 +1187,13 @@ module Puma
     # listening on the socket, allowing workers which are not processing any
     # requests to pick up new requests first.
     #
+    # The default is 0.005 seconds.
+    #
     # Only works on MRI. For all other interpreters, this setting does nothing.
+    #
     # @see Puma::Server#handle_servers
     # @see Puma::ThreadPool#wait_for_less_busy_worker
+    #
     # @version 5.0.0
     #
     def wait_for_less_busy_worker(val=0.005)
@@ -925,7 +1207,7 @@ module Puma
     #
     # There are 5 possible values:
     #
-    # 1. **:socket** (the default) - read the peername from the socket using the
+    # 1. **:socket** - read the peername from the socket using the
     #    syscall. This is the normal behavior. If this fails for any reason (e.g.,
     #    if the peer disconnects between the connection being accepted and the getpeername
     #    system call), Puma will return "0.0.0.0"
@@ -943,6 +1225,11 @@ module Puma
     #    you wish. Because Puma never uses this field anyway, it's format is
     #    entirely in your hands.
     #
+    # The default is +:socket+.
+    #
+    # @example
+    #   set_remote_address :localhost
+    #
     def set_remote_address(val=:socket)
       case val
       when :socket
@@ -983,6 +1270,7 @@ module Puma
     # (default 1000), or pass 0 to disable auto refork.
     #
     # @note Cluster mode only.
+    #
     # @version 5.0.0
     #
     def fork_worker(after_requests=1000)
@@ -992,10 +1280,41 @@ module Puma
     # The number of requests to attempt inline before sending a client back to
     # the reactor to be subject to normal ordering.
     #
+    # The default is 10.
+    #
+    # @example
+    #   max_fast_inline 20
+    #
     def max_fast_inline(num_of_requests)
       @options[:max_fast_inline] = Float(num_of_requests)
     end
 
+    # When `true`, keep-alive connections are maintained on inbound requests.
+    # Enabling this setting reduces the number of TCP operations, reducing response
+    # times for connections that can send multiple requests in a single connection.
+    #
+    # When Puma receives more incoming connections than available Puma threads,
+    # enabling the keep-alive behavior may result in processing requests out-of-order,
+    # increasing overall response time variance. Increased response time variance
+    # means that the overall average of response times might not change, but more
+    # outliers will exist. Those long-tail outliers may significantly affect response
+    # times for some processed requests.
+    #
+    # When `false`, Puma closes the connection after each request, requiring the
+    # client to open a new request. Disabling this setting guarantees that requests
+    # will be processed in the order they are fully received, decreasing response
+    # variance and eliminating long-tail outliers caused by keep-alive behavior.
+    # The trade-off is that the number of TCP operations required will increase.
+    #
+    # The default is +true+.
+    #
+    # @example
+    #   enable_keep_alives false
+    #
+    def enable_keep_alives(enabled=true)
+      @options[:enable_keep_alives] = enabled
+    end
+
     # Specify the backend for the IO selector.
     #
     # Provided values will be passed directly to +NIO::Selector.new+, with the
@@ -1015,14 +1334,72 @@ module Puma
       @options[:io_selector_backend] = backend.to_sym
     end
 
+    # Ensures +STDOUT+ and +STDERR+ is immediately flushed to the underlying
+    # operating system and is not buffered internally
+    #
+    # The default is +true+.
+    #
+    # @example
+    #   mutate_stdout_and_stderr_to_sync_on_write false
+    #
     def mutate_stdout_and_stderr_to_sync_on_write(enabled=true)
       @options[:mutate_stdout_and_stderr_to_sync_on_write] = enabled
     end
 
+    # Specify how big the request payload should be, in bytes.
+    # This limit is compared against Content-Length HTTP header.
+    # If the payload size (CONTENT_LENGTH) is larger than http_content_length_limit,
+    # HTTP 413 status code is returned.
+    #
+    # When no Content-Length http header is present, it is compared against the
+    # size of the body of the request.
+    #
+    # The default is +nil+.
+    #
+    # @example
+    #   http_content_length_limit 2_000_000_000
+    #
+    def http_content_length_limit(limit)
+      @options[:http_content_length_limit] = limit
+    end
+
+    # Supported http methods, which will replace `Puma::Const::SUPPORTED_HTTP_METHODS`.
+    # The value of `:any` will allows all methods, otherwise, the value must be
+    # an array of strings.  Note that methods are all uppercase.
+    #
+    # `Puma::Const::SUPPORTED_HTTP_METHODS` is conservative, if you want a
+    # complete set of methods, the methods defined by the
+    # [IANA Method Registry](https://www.iana.org/assignments/http-methods/http-methods.xhtml)
+    # are pre-defined as the constant `Puma::Const::IANA_HTTP_METHODS`.
+    #
+    # @note If the `methods` value is `:any`, no method check with be performed,
+    #   similar to Puma v5 and earlier.
+    #
+    # @example Adds 'PROPFIND' to existing supported methods
+    #   supported_http_methods(Puma::Const::SUPPORTED_HTTP_METHODS + ['PROPFIND'])
+    # @example Restricts methods to the array elements
+    #   supported_http_methods %w[HEAD GET POST PUT DELETE OPTIONS PROPFIND]
+    # @example Restricts methods to the methods in the IANA Registry
+    #   supported_http_methods Puma::Const::IANA_HTTP_METHODS
+    # @example Allows any method
+    #   supported_http_methods :any
+    #
+    def supported_http_methods(methods)
+      if methods == :any
+        @options[:supported_http_methods] = :any
+      elsif Array === methods && methods == (ary = methods.grep(String).uniq) &&
+        !ary.empty?
+        @options[:supported_http_methods] = ary
+      else
+        raise "supported_http_methods must be ':any' or a unique array of strings"
+      end
+    end
+
     private
 
     # To avoid adding cert_pem and key_pem as URI params, we store them on the
     # options[:store] from where Puma binder knows how to find and extract them.
+    #
     def add_pem_values_to_options_store(opts)
       return if defined?(JRUBY_VERSION)
 
@@ -1046,7 +1423,22 @@ module Puma
       elsif key.nil?
         @options[options_key] << block
       else
-        raise "'#{method}' key must be String or Symbol"
+        raise "'#{meth}' key must be String or Symbol"
+      end
+    end
+
+    def warn_if_in_single_mode(hook_name)
+      return if @options[:silence_fork_callback_warning]
+      # user_options (CLI) have precedence over config file
+      workers_val = @config.options.user_options[:workers] || @options[:workers] ||
+        @config.puma_default_options[:workers] || 0
+      if workers_val == 0
+        log_string =
+          "Warning: You specified code to run in a `#{hook_name}` block, " \
+          "but Puma is not configured to run in cluster mode (worker count > 0), " \
+          "so your `#{hook_name}` block will not run."
+
+        LogWriter.stdio.log(log_string)
       end
     end
   end