ADVANCED_README.md

PM2 production process manager

Table of contents

Quick start

• Installation
• Folder structure
• Usage
• Examples
• Different ways to launch a process
• Options
  • Schema
• How to update PM2?
• PM2 tab-completion
• Allow PM2 to bind apps on port 80/443 without root

Features

• Transitional state of apps
• Process listing
• Automatic restart process based on memory
• Monitoring CPU/Memory usage
• Logs management
• Clustering
• Multiple PM2 on the same server
• Watch & Restart
• Reloading without downtime
• Make PM2 restart on server reboot
• JS/JSON app declaration
  • Options list
  • Schema
• Using PM2 in development
• Use ES6

Using PM2 in Cloud Providers (Heroku/Google App Engine/Azure)

• Without Keymetrics
• With Keymetrics

Deployment - ecosystem.json

• Getting started with deployment
• Deployment options
• Considerations
• Contributing

Using PM2 programmatically (via API)

• Simple example
• Programmatic API

Specific

• Specific features
• Configuration file
• Enabling Harmony ES6
• CoffeeScript
• Testing PM2 on your prod environment
• JSON app via pipe

Knowledge

• Stateless apps ?
• Transitional state of apps
• Setup PM2 on server: tutorial
• Logs and PID files
• Execute any script: What is fork mode ?

More

• Contributing/Development mode
• Known bugs and workaround
• They talk about it
• License

---

Quick start

## Installation

Quick Start

## How to update PM2

Update PM2

## PM2 tab-completion

Tab-completion for pm2

Features

## Managing applications states

Process Management

## Process listing

Process Listing

## Monitoring CPU/Memory

Monitoring

## Clustering

Cluster mode

Hot reload / 0s reload

Reload without Downtime

Graceful reload

Graceful Reload

## Logs management

Log Management

## Max Memory Restart

Max Memory Restart

## Startup script

Startup Script

Multiple PM2 on the same server

Multiple PM2

Watch & Restart

Watch and Restart

JS/JSON app declaration

Application Declaration

Using PM2 in development

PM2 in Development

Run Next generation Javascript

Run ES6

Using PM2 in Cloud Providers

Using PM2 with PaaS

# Deployment

Deployment

# Using PM2 programmatically

PM2 API

# Special features

Specifics

## Enabling Harmony ES6

Specifics

## CoffeeScript

Specifics

Knowledge

Knowledge

Contributing

Contributing

User tips from issues

• Vagrant and pm2 #289
• Start the same app on different ports #322
• Using ansible with pm2
• Cron string as argument
• Restart when process reaches a specific memory amount
• Sticky sessions and socket.io discussion
• EACCESS - understanding pm2 user/root rights

## External resources and articles

• Goodbye node-forever, hello pm2
• https://serversforhackers.com/editions/2014/11/04/pm2/
• http://www.allaboutghost.com/keep-ghost-running-with-pm2/
• http://blog.ponyfoo.com/2013/09/19/deploying-node-apps-to-aws-using-grunt
• http://www.allaboutghost.com/keep-ghost-running-with-pm2/
• http://bioselemental.com/keeping-ghost-alive-with-pm2/
• http://blog.chyld.net/installing-ghost-on-ubuntu-13-10-aws-ec2-instance-with-pm2/
• http://blog.marvinroger.fr/gerer-ses-applications-node-en-production-pm2/
• https://www.codersgrid.com/2013/06/29/pm2-process-manager-for-node-js/
• http://www.z-car.com/blog/programming/how-to-rotate-logs-using-pm2-process-manager-for-node-js
• http://yosoftware.com/blog/7-tips-for-a-node-js/
• https://www.exponential.io/blog/nodeday-2014-moving-a-large-developer-workforce-to-nodejs
• http://blog.rapsli.ch/posts/2013/2013-10-17-node-monitor-pm2.html
• https://coderwall.com/p/igdqyw
• http://revdancatt.com/2013/09/17/node-day-1-getting-the-server-installing-node-and-pm2/
• https://medium.com/tech-talk/e7c0b0e5ce3c

Contributors

Contributors

Sponsors

Thanks to Devo.ps and Wiredcraft for their knowledge and expertise.

# 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.