mirror of
https://github.com/puma/puma.git
synced 2022-11-09 13:48:40 -05:00
docs/system.md sample config refinements and elaborations
* A few tweaks to socket activation config * Add systemctl command usage
This commit is contained in:
parent
a313698588
commit
3a2de57b51
1 changed files with 95 additions and 3 deletions
|
@ -11,6 +11,9 @@ puma.service configuration file for systemd:
|
||||||
Description=Puma HTTP Server
|
Description=Puma HTTP Server
|
||||||
After=network.target
|
After=network.target
|
||||||
|
|
||||||
|
# Uncomment for socket activation (see below)
|
||||||
|
# Requires=puma.socket
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
# Foreground process (do not use --daemon in ExecStart or config.rb)
|
# Foreground process (do not use --daemon in ExecStart or config.rb)
|
||||||
Type=simple
|
Type=simple
|
||||||
|
@ -33,7 +36,7 @@ Type=simple
|
||||||
|
|
||||||
# Alternatively with a config file (in WorkingDirectory) and
|
# Alternatively with a config file (in WorkingDirectory) and
|
||||||
# comparable `bind` directives
|
# comparable `bind` directives
|
||||||
# ExecStart=<WorkingDirectory>/sbin/puma -C config.rb
|
# ExecStart=<WD>/sbin/puma -C config.rb
|
||||||
|
|
||||||
Restart=always
|
Restart=always
|
||||||
|
|
||||||
|
@ -66,13 +69,102 @@ ListenStream=0.0.0.0:9293
|
||||||
# SocketUser, SocketGroup, etc. may be needed for Unix domain sockets
|
# SocketUser, SocketGroup, etc. may be needed for Unix domain sockets
|
||||||
# ListenStream=/run/puma.sock
|
# ListenStream=/run/puma.sock
|
||||||
|
|
||||||
# Socket options matching what Puma wants
|
# Socket options matching Puma defaults
|
||||||
NoDelay=true
|
NoDelay=true
|
||||||
ReusePort=true
|
ReusePort=true
|
||||||
|
Backlog=1024
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=sockets.target
|
WantedBy=sockets.target
|
||||||
~~~~
|
~~~~
|
||||||
|
|
||||||
See [systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
|
See [systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
|
||||||
for additional details.
|
for additional configuration details.
|
||||||
|
|
||||||
|
Note that the above configurations will work with Puma in either
|
||||||
|
single process or cluster mode.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Without socket activation, use `systemctl` as root (e.g. via `sudo`) as
|
||||||
|
with other system services:
|
||||||
|
|
||||||
|
~~~~ sh
|
||||||
|
# After installing or making changes to puma.service
|
||||||
|
systemctl daemon-reload
|
||||||
|
|
||||||
|
# Enable so it starts on boot
|
||||||
|
systemctl enable puma.service
|
||||||
|
|
||||||
|
# Initial start up.
|
||||||
|
systemctl start puma.service
|
||||||
|
|
||||||
|
# Check status
|
||||||
|
systemctl status puma.service
|
||||||
|
|
||||||
|
# A normal restart. Warning: listeners sockets will be closed
|
||||||
|
# while a new puma process initializes.
|
||||||
|
systemctl restart puma.service
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
With socket activation, several but not all of these commands should
|
||||||
|
be run for both socket and service:
|
||||||
|
|
||||||
|
~~~~ sh
|
||||||
|
# After installing or making changes to either puma.socket or
|
||||||
|
# puma.service.
|
||||||
|
systemctl daemon-reload
|
||||||
|
|
||||||
|
# Enable both socket and service so they start on boot. Alternatively
|
||||||
|
# you could leave puma.service disabled and systemd will start it on
|
||||||
|
# first use (with startup lag on first request)
|
||||||
|
systemctl enable puma.socket puma.service
|
||||||
|
|
||||||
|
# Initial start up. The Requires directive (see above) ensures the
|
||||||
|
# socket is started before the service.
|
||||||
|
systemctl start puma.socket puma.service
|
||||||
|
|
||||||
|
# Check status of both socket and service.
|
||||||
|
systemctl status puma.socket puma.service
|
||||||
|
|
||||||
|
# A "hot" restart, with systemd keeping puma.socket listening and
|
||||||
|
# providing to the new puma (master) instance.
|
||||||
|
systemctl restart puma.service
|
||||||
|
|
||||||
|
# A normal restart, needed to handle changes to
|
||||||
|
# puma.socket, such as changing the ListenStream ports. Note
|
||||||
|
# daemon-reload (above) should be run first.
|
||||||
|
systemctl restart puma.socket puma.service
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
Here is sample output from `systemctl status` with both service and
|
||||||
|
socket running:
|
||||||
|
|
||||||
|
~~~~
|
||||||
|
● puma.socket - Puma HTTP Server Accept Sockets
|
||||||
|
Loaded: loaded (/etc/systemd/system/puma.socket; enabled; vendor preset: enabled)
|
||||||
|
Active: active (running) since Thu 2016-04-07 08:40:19 PDT; 1h 2min ago
|
||||||
|
Listen: 0.0.0.0:9233 (Stream)
|
||||||
|
0.0.0.0:9234 (Stream)
|
||||||
|
|
||||||
|
Apr 07 08:40:19 hx systemd[874]: Listening on Puma HTTP Server Accept Sockets.
|
||||||
|
|
||||||
|
● puma.service - Puma HTTP Server
|
||||||
|
Loaded: loaded (/etc/systemd/system/puma.service; enabled; vendor preset: enabled)
|
||||||
|
Active: active (running) since Thu 2016-04-07 08:40:19 PDT; 1h 2min ago
|
||||||
|
Main PID: 28320 (ruby)
|
||||||
|
CGroup: /system.slice/puma.service
|
||||||
|
├─28320 puma 3.3.0 (tcp://0.0.0.0:9233,ssl://0.0.0.0:9234?key=key.pem&cert=cert.pem) [app]
|
||||||
|
├─28323 puma: cluster worker 0: 28320 [app]
|
||||||
|
└─28327 puma: cluster worker 1: 28320 [app]
|
||||||
|
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: Puma starting in cluster mode...
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Version 3.3.0 (ruby 2.2.4-p230), codename: Jovial Platypus
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Min threads: 0, max threads: 16
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Environment: production
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Process workers: 2
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Phased restart available
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Activated tcp://0.0.0.0:9233
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=cert.pem
|
||||||
|
Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
|
||||||
|
~~~~
|
||||||
|
|
Loading…
Reference in a new issue