Merge branch '17726-singularity-doc' into main
[arvados.git] / services / api / config / puma.rb
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 # Puma can serve each request in a thread from an internal thread pool.
6 # The `threads` method setting takes two numbers a minimum and maximum.
7 # Any libraries that use thread pools should be configured to match
8 # the maximum value specified for Puma. Default is set to 5 threads for minimum
9 # and maximum, this matches the default thread size of Active Record.
10 #
11 threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i
12 threads threads_count, threads_count
13
14 # Specifies the `port` that Puma will listen on to receive requests, default is 3000.
15 #
16 port        ENV.fetch("PORT") { 3000 }
17
18 # Specifies the `environment` that Puma will run in.
19 #
20 environment ENV.fetch("RAILS_ENV") { "development" }
21
22 # Specifies the number of `workers` to boot in clustered mode.
23 # Workers are forked webserver processes. If using threads and workers together
24 # the concurrency of the application would be max `threads` * `workers`.
25 # Workers do not work on JRuby or Windows (both of which do not support
26 # processes).
27 #
28 # workers ENV.fetch("WEB_CONCURRENCY") { 2 }
29
30 # Use the `preload_app!` method when specifying a `workers` number.
31 # This directive tells Puma to first boot the application and load code
32 # before forking the application. This takes advantage of Copy On Write
33 # process behavior so workers use less memory. If you use this option
34 # you need to make sure to reconnect any threads in the `on_worker_boot`
35 # block.
36 #
37 # preload_app!
38
39 # The code in the `on_worker_boot` will be called if you are using
40 # clustered mode by specifying a number of `workers`. After each worker
41 # process is booted this block will be run, if you are using `preload_app!`
42 # option you will want to use this block to reconnect to any threads
43 # or connections that may have been created at application boot, Ruby
44 # cannot share connections between processes.
45 #
46 # on_worker_boot do
47 #   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
48 # end
49
50 # Allow puma to be restarted by `rails restart` command.
51 plugin :tmp_restart