mirror of
https://github.com/puma/puma.git
synced 2022-11-09 13:48:40 -05:00
Moved sample configuration into existing one.
This commit is contained in:
Maik Kempe
Evan Phoenix
parent
8715d93489
commit
8eedae4e8e
2 changed files with 155 additions and 162 deletions
159
README.md
159
README.md
|
|
@ -105,165 +105,8 @@ or
|
|||
|
||||
$ puma -C /path/to/config
|
||||
|
||||
Take the following sample configuration as inspiration:
|
||||
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#L138) to see all available options.
|
||||
|
||||
```ruby
|
||||
#!/usr/bin/env puma
|
||||
|
||||
# The directory to operate out of.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# directory '/u/apps/lolcat'
|
||||
|
||||
# Use a object or block as the rack application. This allows the
|
||||
# config file to be the application itself.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# hello = lambda do |env|
|
||||
# body = 'Hello, World!'
|
||||
#
|
||||
# [200, { 'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }, [body]]
|
||||
# end
|
||||
#
|
||||
# app hello
|
||||
#
|
||||
# or
|
||||
#
|
||||
# app do |env|
|
||||
# puts env
|
||||
#
|
||||
# body = 'Hello, World!'
|
||||
#
|
||||
# [200, { 'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }, [body]]
|
||||
# end
|
||||
|
||||
# Load “path” as a rackup file.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# rackup '/u/apps/lolcat.ru'
|
||||
|
||||
# Set the environment in which the rack's app will run.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# environment = :production
|
||||
|
||||
# Daemonize the server into the background. Highly suggest that
|
||||
# this be combined with “pidfile” and “stdout_redirect”.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# daemonize
|
||||
# daemonize false
|
||||
|
||||
# Store the pid of the server in the file at “path”.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# pidfile '/u/apps/lolcat/tmp/pids/puma.pid'
|
||||
|
||||
# Use “path” as the file to store the server info state. This is
|
||||
# used by “pumactl” to query and control the server.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# state_path '/u/apps/lolcat/tmp/pids/puma.state'
|
||||
|
||||
# Redirect STDOUT and STDERR to files specified.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr'
|
||||
# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr', true
|
||||
|
||||
# Disable request logging.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# quiet
|
||||
|
||||
# Configure “min” to be the minimum number of threads to use to answer
|
||||
# requests and “max” the maximum.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# threads 0, 16
|
||||
|
||||
# Bind the server to “url”. “tcp://”, “unix://” and “ssl://” are the only
|
||||
# accepted protocols.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# bind 'tcp://0.0.0.0:9292'
|
||||
# bind 'unix:///var/run/puma.sock'
|
||||
# bind 'unix:///var/run/puma.sock?umask=0777'
|
||||
# bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
|
||||
|
||||
# Instead of “bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'” you
|
||||
# can also use the “ssl_bind” option.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# ssl_bind '127.0.0.1', '9292', { key: path_to_key, cert: path_to_cert }
|
||||
|
||||
# Code to run before doing a restart. This code should
|
||||
# close logfiles, database connections, etc.
|
||||
#
|
||||
# This can be called multiple times to add code each time.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# on_restart do
|
||||
# puts 'On restart...'
|
||||
# end
|
||||
|
||||
# Command to use to restart puma. This should be just how to
|
||||
# load puma itself (ie. 'ruby -Ilib bin/puma'), not the arguments
|
||||
# to puma, as those are the same as the original process.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# restart_command '/u/app/lolcat/bin/restart_puma'
|
||||
|
||||
# === Cluster mode ===
|
||||
|
||||
# How many worker processes to run.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# workers 2
|
||||
|
||||
# Code to run when a worker boots to setup the process before booting
|
||||
# the app.
|
||||
#
|
||||
# This can be called multiple times to add hooks.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# on_worker_boot do
|
||||
# puts 'On worker boot...'
|
||||
# end
|
||||
|
||||
# === Puma control rack application ===
|
||||
|
||||
# Start the puma control rack application on “url”. This application can
|
||||
# be communicated with to control the main server. Additionally, you can
|
||||
# provide an authentication token, so all requests to the control server
|
||||
# will need to include that token as a query parameter. This allows for
|
||||
# simple authentication.
|
||||
#
|
||||
# Check out https://github.com/puma/puma/blob/master/lib/puma/app/status.rb
|
||||
# to see what the app has available.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# activate_control_app 'unix:///var/run/pumactl.sock'
|
||||
# activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
|
||||
# activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }
|
||||
```
|
||||
## Restart
|
||||
|
||||
Puma includes the ability to restart itself, allowing for new versions to be easily upgraded to. When available (currently anywhere but 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.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,155 @@
|
|||
state_path "puma.state"
|
||||
activate_control_app
|
||||
#!/usr/bin/env puma
|
||||
|
||||
rackup "test/lobster.ru"
|
||||
threads 3, 10
|
||||
# The directory to operate out of.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# directory '/u/apps/lolcat'
|
||||
|
||||
# Use a object or block as the rack application. This allows the
|
||||
# config file to be the application itself.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# hello = lambda do |env|
|
||||
# body = 'Hello, World!'
|
||||
#
|
||||
# [200, { 'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }, [body]]
|
||||
# end
|
||||
#
|
||||
# app hello
|
||||
#
|
||||
# or
|
||||
#
|
||||
# app do |env|
|
||||
# puts env
|
||||
#
|
||||
# body = 'Hello, World!'
|
||||
#
|
||||
# [200, { 'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }, [body]]
|
||||
# end
|
||||
|
||||
# Load “path” as a rackup file.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# rackup '/u/apps/lolcat.ru'
|
||||
|
||||
# Set the environment in which the rack's app will run.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# environment = :production
|
||||
|
||||
# Daemonize the server into the background. Highly suggest that
|
||||
# this be combined with “pidfile” and “stdout_redirect”.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# daemonize
|
||||
# daemonize false
|
||||
|
||||
# Store the pid of the server in the file at “path”.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# pidfile '/u/apps/lolcat/tmp/pids/puma.pid'
|
||||
|
||||
# Use “path” as the file to store the server info state. This is
|
||||
# used by “pumactl” to query and control the server.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# state_path '/u/apps/lolcat/tmp/pids/puma.state'
|
||||
|
||||
# Redirect STDOUT and STDERR to files specified.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr'
|
||||
# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr', true
|
||||
|
||||
# Disable request logging.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# quiet
|
||||
|
||||
# Configure “min” to be the minimum number of threads to use to answer
|
||||
# requests and “max” the maximum.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# threads 0, 16
|
||||
|
||||
# Bind the server to “url”. “tcp://”, “unix://” and “ssl://” are the only
|
||||
# accepted protocols.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# bind 'tcp://0.0.0.0:9292'
|
||||
# bind 'unix:///var/run/puma.sock'
|
||||
# bind 'unix:///var/run/puma.sock?umask=0777'
|
||||
# bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
|
||||
|
||||
# Instead of “bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'” you
|
||||
# can also use the “ssl_bind” option.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# ssl_bind '127.0.0.1', '9292', { key: path_to_key, cert: path_to_cert }
|
||||
|
||||
# Code to run before doing a restart. This code should
|
||||
# close logfiles, database connections, etc.
|
||||
#
|
||||
# This can be called multiple times to add code each time.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# on_restart do
|
||||
# puts 'On restart...'
|
||||
# end
|
||||
|
||||
# Command to use to restart puma. This should be just how to
|
||||
# load puma itself (ie. 'ruby -Ilib bin/puma'), not the arguments
|
||||
# to puma, as those are the same as the original process.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# restart_command '/u/app/lolcat/bin/restart_puma'
|
||||
|
||||
# === Cluster mode ===
|
||||
|
||||
# How many worker processes to run.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# workers 2
|
||||
|
||||
# Code to run when a worker boots to setup the process before booting
|
||||
# the app.
|
||||
#
|
||||
# This can be called multiple times to add hooks.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# on_worker_boot do
|
||||
# puts 'On worker boot...'
|
||||
# end
|
||||
|
||||
# === Puma control rack application ===
|
||||
|
||||
# Start the puma control rack application on “url”. This application can
|
||||
# be communicated with to control the main server. Additionally, you can
|
||||
# provide an authentication token, so all requests to the control server
|
||||
# will need to include that token as a query parameter. This allows for
|
||||
# simple authentication.
|
||||
#
|
||||
# Check out https://github.com/puma/puma/blob/master/lib/puma/app/status.rb
|
||||
# to see what the app has available.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# activate_control_app 'unix:///var/run/pumactl.sock'
|
||||
# activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
|
||||
# activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }
|
||||
Loading…
Add table
Add a link
Reference in a new issue