mirror of
https://github.com/Unitech/pm2.git
synced 2025-12-08 20:35:53 +00:00
145 lines
4.5 KiB
Markdown
145 lines
4.5 KiB
Markdown
|
|
|
|
|
|
PM2 is a production process manager for Node.js applications with a built-in load balancer. It allows you to keep applications alive forever, to reload them without downtime and to facilitate common system admin tasks.
|
|
|
|
PM2 is constantly assailed by [more than 300 tests](https://travis-ci.org/Unitech/PM2).
|
|
|
|
Compatible with CoffeeScript.
|
|
Works on Linux (stable) & MacOSx (stable) & Windows (bêta).
|
|
|
|
[](http://badge.fury.io/js/pm2) [](https://travis-ci.org/Unitech/PM2) [](https://gitter.im/Unitech/PM2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
[](https://nodei.co/npm/pm2/)
|
|
|
|
## Install PM2
|
|
|
|
```bash
|
|
$ npm install pm2 -g
|
|
```
|
|
|
|
*npm is a builtin CLI when you install Node.js - [Installing Node.js with NVM](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-an-ubuntu-14-04-server#how-to-install-using-nvm)*
|
|
|
|
Node.js 0.11.14 is recommended for cluster mode and reload feature.
|
|
|
|
## Start an application
|
|
|
|
```bash
|
|
$ pm2 start app.js
|
|
$ pm2 start app.js -i max # Enable load-balancer and cluster features
|
|
```
|
|
|
|
## Main features
|
|
|
|
### Process management
|
|
|
|
Once apps are started you can list and manage them easily:
|
|
|
|
|
|
|
|
Listing all running processes:
|
|
|
|
```bash
|
|
$ pm2 list
|
|
```
|
|
|
|
Managing your processes is straightforward:
|
|
|
|
```bash
|
|
$ pm2 stop <app_name|id|all>
|
|
$ pm2 restart <app_name|id|all>
|
|
$ pm2 delete <app_name|id|all>
|
|
```
|
|
|
|
To have more details on a specific process:
|
|
|
|
```bash
|
|
$ pm2 describe 0
|
|
```
|
|
|
|
### Monitoring
|
|
|
|
|
|
|
|
Monitoring all processes launched:
|
|
|
|
```bash
|
|
$ pm2 monit
|
|
```
|
|
|
|
### Log facilities
|
|
|
|
|
|
|
|
Displaying logs of a specified process or all processes, in real time:
|
|
|
|
```bash
|
|
$ pm2 logs
|
|
$ pm2 logs big-api
|
|
$ pm2 flush # Clear all the logs
|
|
```
|
|
|
|
### Load balancing / 0s reload downtime
|
|
|
|
When an app is started with the -i <worker number> option, the **cluster** mode is enabled.
|
|
|
|
With the cluster mode, PM2 enables load balancing between each worker.
|
|
Each HTTP/TCP/UDP request will be forwarded to one specific process at a time.
|
|
|
|
```bash
|
|
$ pm2 start app.js -i max # Enable load-balancer and cluster features
|
|
|
|
$ pm2 reload all # Reload all apps in 0s manner
|
|
```
|
|
|
|
### Startup script generation
|
|
|
|
PM2 can generate and configure a startup script to keep PM2 and your processes alive at every server restart.
|
|
|
|
```bash
|
|
$ pm2 startup <ubuntu|centos|gentoo|systemd>
|
|
```
|
|
|
|
To save a process list just do:
|
|
|
|
```bash
|
|
$ pm2 save
|
|
```
|
|
|
|
## Monitoring dashboard
|
|
|
|
|
|
|
|
We're going to release a very nice product, a dashboard to monitor every part of your Node.js applications. Here are some links:
|
|
|
|
- [Pitch + Survey](https://docs.google.com/forms/d/1FuCjIhrGg-ItxInq2nLreoe9GS-gZWJNkNWE0JJajw8/viewform) People who fill the survey will be eligible for free license
|
|
|
|
Thanks in advance and we hope that you like PM2!
|
|
|
|
## Other PM2 features
|
|
|
|
- [Watch & Restart](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#a890)
|
|
- [JSON application declaration](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#a10)
|
|
- [Using PM2 in your code](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#programmatic-example)
|
|
- [Deployment workflow](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#deployment)
|
|
- [Startup script generation (SystemV/Ubuntu/Gentoo/AWS)](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#a8)
|
|
- [Advanced log management (flush, reload, ilogs)](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#9)
|
|
- [GracefullReload](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md#a690)
|
|
|
|
## Know more about PM2
|
|
|
|
[Advanced README.md](https://github.com/Unitech/PM2/blob/development/ADVANCED_README.md)
|
|
|
|
## Changelog
|
|
|
|
[CHANGELOG](https://github.com/Unitech/PM2/blob/master/doc/CHANGELOG.md)
|
|
|
|
## Contributors
|
|
|
|
[Contributors](https://github.com/Unitech/PM2/graphs/contributors)
|
|
|
|
## License
|
|
|
|
Files in `lib/` are made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0).
|
|
Except the file `lib/CLI.js` who is made under the terms of the Apache V2 license.
|