Skip to content

Commit 8a9b576

Browse files
committed
readme improvements
1 parent 120e31a commit 8a9b576

File tree

6 files changed

+29
-22
lines changed

6 files changed

+29
-22
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11

2+
## 5.1.2
3+
4+
- easily disable cron-restart strategy via `$ pm2 restart --cron-restart 0`
5+
- allow to update cron-restart on restart
6+
27
## 5.1.1
38

49
- remove fast-printf and replace with sprintfjs

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<i>Runtime Edition</i>
1010
<br/><br/>
1111

12-
12+
1313
<a title="PM2 Downloads">
1414
<img src="https://img.shields.io/npm/dm/pm2" alt="Downloads per Month"/>
1515
</a>
@@ -55,7 +55,7 @@ With NPM:
5555
$ npm install pm2 -g
5656
```
5757

58-
You can install Node.js easily with [NVM](https://riptutorial.com/node-js/example/4578/using-node-version-manager--nvm-) or [ASDF](https://blog.natterstefan.me/how-to-use-multiple-node-version-with-asdf)
58+
You can install Node.js easily with [NVM](https://github.com/nvm-sh/nvm#installing-and-updating) or [ASDF](https://blog.natterstefan.me/how-to-use-multiple-node-version-with-asdf).
5959

6060
### Start an application
6161

@@ -71,7 +71,7 @@ Your app is now daemonized, monitored and kept alive forever.
7171

7272
Once applications are started you can manage them easily:
7373

74-
![Process listing](https://github.com/unitech/pm2/raw/master/pres/pm2-list.png)
74+
![Process listing](https://github.com/Unitech/pm2/raw/master/pres/pm2-ls-v2.png)
7575

7676
To list all running applications:
7777

@@ -99,13 +99,14 @@ To monitor logs, custom metrics, application information:
9999
$ pm2 monit
100100
```
101101

102-
103102
[More about Process Management](https://pm2.keymetrics.io/docs/usage/process-management/)
104103

105104
### Cluster Mode: Node.js Load Balancing & Zero Downtime Reload
106105

107106
The Cluster mode is a special mode when starting a Node.js application, it starts multiple processes and load-balance HTTP/TCP/UDP queries between them. This increase overall performance (by a factor of x10 on 16 cores machines) and reliability (faster socket re-balancing in case of unhandled errors).
108107

108+
![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/cluster.png)
109+
109110
Starting a Node.js application in cluster mode that will leverage all CPUs available:
110111

111112
```bash
@@ -122,10 +123,6 @@ Hot Reload allows to update an application without any downtime:
122123
$ pm2 reload all
123124
```
124125

125-
Seamlessly supported by all major Node.js frameworks and any Node.js applications without any code change:
126-
127-
![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/cluster-support.png)
128-
129126
[More informations about how PM2 make clustering easy](https://pm2.keymetrics.io/docs/usage/cluster-mode/)
130127

131128
### Container Support
@@ -140,6 +137,19 @@ CMD [ "pm2-runtime", "npm", "--", "start" ]
140137

141138
[Read More about the dedicated integration](https://pm2.keymetrics.io/docs/usage/docker-pm2-nodejs/)
142139

140+
### Host monitoring speedbar
141+
142+
PM2 allows to monitor your host/server vitals with a monitoring speedbar.
143+
144+
To enable host monitoring:
145+
146+
```bash
147+
$ pm2 set pm2:sysmonit true
148+
$ pm2 update
149+
```
150+
151+
![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/vitals.png)
152+
143153
### Terminal Based Monitoring
144154

145155
![Monit](https://github.com/Unitech/pm2/raw/master/pres/pm2-monit.png)
@@ -171,6 +181,12 @@ $ pm2 flush # Flush all logs
171181
$ pm2 reloadLogs # Reload all logs
172182
```
173183

184+
To enable log rotation install the following module
185+
186+
```bash
187+
$ pm2 install pm2-logrotate
188+
```
189+
174190
[More about log management](https://pm2.keymetrics.io/docs/usage/log-management/)
175191

176192
### Startup Scripts Generation
@@ -192,19 +208,6 @@ $ pm2 unstartup
192208

193209
[More about Startup Scripts Generation](https://pm2.keymetrics.io/docs/usage/startup/)
194210

195-
### PM2 Modules
196-
197-
PM2 embeds a simple and powerful module system. Installing a module is straightforward:
198-
199-
```bash
200-
$ pm2 install <module_name>
201-
```
202-
203-
Here are some PM2 compatible modules (standalone Node.js applications managed by PM2):
204-
205-
[**pm2-logrotate**](https://www.npmjs.com/package/pm2-logrotate) automatically rotate logs and limit logs size<br/>
206-
[**pm2-server-monit**](https://www.npmjs.com/package/pm2-server-monit) monitor the current server with more than 20+ metrics and 8 actions<br/>
207-
208211
### Updating PM2
209212

210213
```bash

lib/API/Extra.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ module.exports = function(CLI) {
3535
* Install pm2-sysmonit
3636
*/
3737
CLI.prototype.launchSysMonitoring = function(cb) {
38-
3938
if ((this.pm2_configuration && this.pm2_configuration.sysmonit != 'true') ||
4039
process.env.TRAVIS ||
4140
global.it === 'function' ||

pres/cluster.png

159 KB
Loading

pres/pm2-ls-v2.png

70.5 KB
Loading

pres/vitals.png

51.3 KB
Loading

0 commit comments

Comments
 (0)