PUMA(1)

✨ PUMA — like, the manual page bestie ✨

puma — a fast, concurrent web server for ruby and rack 💖 (yes that's the NAME section, we're doing this properly)

---

🦋 USAGE 🦋

okay so here's the shape of it:

puma [options...] [rackup file]

puma [-h | --help | -V | --version]

that's it. that's the whole vibe check. 👑

---

💅 OPTIONS 💅

The following options are available (all of them, bestie, I'm not skipping a single one):

• -b, --bind URI — the URI you wanna bind to, like tcp://, unix://, ssl://. 🫶
• -C, --config PATH — load that path as a config file. give it the path, it does the thing.
• --control URL — DEPRECATED alias for --control-url. it's giving legacy, ngl. 🙈
• --control-token TOKEN — the TOKEN used as authentication for the control server.
• --control-url URL — the bind URL for the control server and app. use auto to use a temp unix server. this requires you to use a --control-token, which needs to be given with every request to the control server (token=foo). no token no entry, periodt.
• -d, --daemon — demonize the server into the background. go girl give us nothing (visually, she's running in the back) 💀
• --debug — show low level debugging information. the tea ☕
• --dir DIR — change to the given directory before starting.
• -e, --environment ENVIRONMENT — the environment to run the Rack app on. Default development.
• -I, --include PATH — specify $LOAD_PATH directories.
• -p, --port PORT — define the TCP port to bind to. use -b for more advanced options, iykyk.
• --pidfile PATH — use the given path as PID file.
• --preload — preload the application. this loads all the application code prior to forking. preloading reduces total memory usage of an application and is only available in cluster mode. ✨
• --prune-bundler — prune out the bundler env if possible.
• -q, --quiet — do not log requests internally. Default: true. 🤫
• -v, --log-requests — log requests as they occur. the receipts! 🧾
• -R, --restart-cmd CMD — the puma command to run during a hot restart. Default: inferred.
• -S, --state PATH — where to store the state details.
• -t, --threads INT — Min:max threads to use. 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. Default: 0:16. she scales, she adapts, main character energy fr fr 🔥
• --tcp-mode — run the app in raw TCP mode instead of HTTP mode.
• --early-hints — enable early hints support.
• -w, --workers COUNT — activate cluster mode and define number of worker processes to create. in this mode workers are forked from a master process. each child process still has its own thread pool and the -t setting is per worker. 👑
• --tag NAME — additional text to display in process listing.
• --redirect-stdout FILE — redirect STDOUT to a specific file.
• --redirect-stderr FILE — redirect STDERR to a specific file.
• --[no-]redirect-append — append to redirected files.
• -h, --help — show help. we love a helpful icon 💖
• -V, --version — print the version information.

---

🌸 EXAMPLES 🌸

The following examples show how to bind TCP or sockets:

Bind Puma to a socket with the -b (or --bind) flag:

puma -b tcp://127.0.0.1:9292

To use a UNIX Socket instead of TCP:

puma -b unix:///var/run/puma.sock

To change the permissions of the UNIX socket, add a umask parameter:

puma -b 'unix:///var/run/puma.sock?umask=0111'

In need of a bit of security use SSL sockets:

puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'

The following example show how to Create a control server and use pumactl(1) to interact with the control server to restart puma:

puma --control-url tcp://127.0.0.1:9293 --control-token foo
pumactl --control-url 'tcp://127.0.0.1:9293' --control-token foo
restart

like… she's literally controlling herself through a whole other command. iconic. 🌈

---

🎀 CONFIGURATION FILE 🎀

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, it looks for configuration at config/puma/<environment_name>.rb.

The -C flag allows one to pass on a custom configuration location. If the value specified is a dash (-) puma won't look for any configuration file:

puma -C "-"

so like, -C "-" = no config, we're going in raw. 🫣

---

🧚 SEE ALSO 🧚

There is extensive documentation at <https://puma.io/puma/> and <https://github.com/puma/puma>. go read it bestie, it's giving extensive. 📚✨

---

💜 AUTHOR 💜

This manual page was written by Daniel Leidert <dleidert@debian.org>, for the Debian GNU/Linux system (but may be used by others).

---

and that's the whole thing!! 🎉 this was PUMA 3.12, from January 2020 — yes she's a lil vintage but she ate and left no crumbs. mwah, go run your server bestie 💅🦋🌸