layout | title | description | permalink |
---|---|---|---|
docs |
Startup Script |
Auto restart PM2 and processes at server reboot |
/docs/usage/startup/ |
PM2 can generate startup scripts and configure them in order to keep your process list intact across expected or unexpected machine restarts.
To automatically generate and configuration a startup script just type the command (without sudo) pm2 startup
:
$ pm2 startup
[PM2] You have to run this command as root. Execute the following command:
sudo su -c "env PATH=$PATH:/home/unitech/.nvm/versions/node/v14.3/bin pm2 startup <distribution> -u <user> --hp <home-path>
Then copy/paste the displayed command onto the terminal:
sudo su -c "env PATH=$PATH:/home/unitech/.nvm/versions/node/v14.3/bin pm2 startup <distribution> -u <user> --hp <home-path>
Now PM2 will automatically restart at boot.
Note: You can customize the service name via the --service-name <name>
option (#3213)
Once you have started all desired apps, save the app list so it will respawn after reboot:
pm2 save
To manually bring back previously saved processes (via pm2 save):
pm2 resurrect
To disable and remove the current startup configuration:
pm2 unstartup
When you upgrade the local Node.js version, be sure to update the PM2 startup script, so it runs the latest Node.js binary you have installed.
First disable and remove the current startup configuration (copy/paste the output of that command):
$ pm2 unstartup
Then restore a fresh startup script:
$ pm2 startup
Let's say you want the startup script to be executed under another user.
Just change the -u <username>
option and the --hp <user_home>
:
pm2 startup ubuntu -u www --hp /home/ubuntu
You can specify the platform you use by yourself if you want to (where platform can be either one of the cited above):
pm2 startup [ubuntu | ubuntu14 | ubuntu12 | centos | centos6 | arch | oracle | amazon | macos | darwin | freebsd | systemd | systemv | upstart | launchd | rcd | openrc]
# Check if pm2-<USER> service has been added
$ systemctl list-units
# Check logs
$ journalctl -u pm2-<USER>
# Cat systemd configuration file
$ systemctl cat pm2-<USER>
# Analyze startup
$ systemd-analyze plot > output.svg
To wait efficiently that machine is online for PM2 to run:
[Unit]
Wants=network-online.target
After=network.target network-online.target
[....]
[Install]
WantedBy=multi-user.target network-online.target
To generate a Windows compatible startup script have a look to the excellent pm2-installer
- systemd: Ubuntu >= 16, CentOS >= 7, Arch, Debian >= 7
- upstart: Ubuntu <= 14
- launchd: Darwin, MacOSx
- openrc: Gentoo Linux, Arch Linux
- rcd: FreeBSD
- systemv: Centos 6, Amazon Linux
These init systems are automatically detected by PM2 with the pm2 startup
command.