An elegant web & terminal interface for Unitech/PM2.
Clone or download
Latest commit 224046b May 27, 2017

README.md

pm2-gui NPM version Build Status

An elegant web & terminal interface for Unitech/PM2.

Compatible with PM2 v0.12.7+

If you wanna update to pm2-gui@latest, make sure you've read the change logs.

You can track lifecycle by pm2-ant

image

Guide

image

Features

  • Curses-like dashboard.
  • Remoting monitor / web control.
  • All the heartbeats (no matter monitor or tail (logs)) are automatic destroyed.
  • The PM2 processes are watched by a subscribed emitter.
  • Communicated with PM2 through RPC socket directly.
  • Socket.io between client and server.
  • Monitor CPU and Memory usage of server in a real-time.
  • Monitor PM2 processes in a real-time.
  • PM2 restart/stop/delete.
  • stopWatch files before restart/stop/delete.
  • restartWatch files before restart.
  • Supports ANSI color codes by ansi-html.
  • High performance. In my case, there are near one hundred processes, but pm2-gui works without any suck.

Cautions

  • Web Interface is wrote by CSS3 && HTML5, so view it with the latest version of the browser (WebGL, Animation, WebSocket supports), e.g. Chrome, Safari and Firefox.
  • I've never test it on Internet Explorer / Windows.

Installation

$ npm install pm2-gui -g
$ pm2-gui <cmd> [options]
# or
$ npm install pm2-gui --production
$ cd node_modules/pm2-gui
# or (recommends)
$ git clone https://github.com/Tjatse/pm2-gui.git
$ cd pm2-gui
$ npm install --production
# run monitor
$ ./pm2-gui <cmd> [options]

Usage

Run the following command to get usage helps:

$ pm2-gui

Directly:

$ node pm2-gui.js <cmd> [options]

Programmable:

var pm2GUI = require('pm2-gui');
pm2GUI.startWebServer([ini_config_file]);
pm2GUI.startAgent([ini_config_file]);
pm2GUI.dashboard([ini_config_file]);

Configuration

Edit the pm2-gui/pm2-gui.ini file or copy the config example to /etc/pm2-gui.ini (starting with pm2-gui start /etc/pm2-gui.ini):

UI/UX

  • Amazing and smooth animations.
  • High performance.

Curses-like dashboard:

image

Authorization

image

Home

image

Processes

image

Describe Complete Information

image

CPU && Memory Usage

image

Tail Logs

image

Serving apps locally with nginx and custom domain

Test

$ npm test

License

(The MIT License)

Copyright (c) 2014-2016 Tjatse

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.