配置 PM2 实现代码自动发布

参考文档

• 使用pm2部署你的项目防止过劳死
• Quick Start
• Deployment

先期准备

PM2 的代码自动发布依赖 GitHub 或类似功能的网站，所以需要先在 GitHub 上添加个人电脑和远程服务器的 SSH 秘钥。

大体流程如下（ Mac 和 Linux 系列的系统直接在终端中执行指令，Windows 需要先安装 Git 客户端）：

1. 检查本机是否有现成的 SSH 秘钥。
2. 没有秘钥的话，生成一个新的秘钥并添加到本机的 ssh-agent 中。如果已经有秘钥了，则直接添加到本机的 ssh-agent 中。
3. 将 SSH 秘钥添加到 GitHub 账号中。
4. 测试 SSH 连接，这里一定要测试成功才行。连接成功的，能看到下面这段文字：

Hi XXX! You've successfully authenticated, but GitHub does not provide shell access.

要注意，自己的个人电脑和远程服务器都要做这一整套操作，这样才能够在本机发布代码到 GitHub 上之后，再让远程服务器把最新的代码更新过去。

安装 PM2

在本机和服务器都全局安装 PM2，用 npm 或 yarn 均可，如果下载速度慢，记得先切换成淘宝的 npm 源。

注意，如果两边电脑上的 Git 不是最新版，务必更新到最新版。不然可能有代码无法及时同步的问题，服务器始终无法 pull 到最新版本的代码，很闹心。当前的最新版是 2.16.3 版本，2018 年 3 月 22 号发布。

本机配置 PM2

在本机的终端环境中，用 pm2 ecosystem 命令生成一份原始的 PM2 配置文件 ecosystem.confi.js。注意，官网文档和实际操作的结果不一致，文档上说执行这个命令会生成 ecosystem.json 这个文件，但自己操作的时候并不是这样，大家也要注意一下。

为了方便大家参考，把自己修改后的配置文件内容贴了上来，只贴了重要的部分，别的地方根据自己的需要修改。

module.exports = {
  apps : [
    // 目前只用 PM2 管理一个项目，所以这里删除了多余的内容
    {
      name      : 'RMS',
      // 这里是项目的启动文件，不过自己没用上
      script    : './dist/bin/www',
      env: {
        COMMON_VARIABLE: 'true'
      },
      env_production : {
        NODE_ENV: 'dev'
      }
    }
  ],

  // 部署环境的设置，自己只用到了开发环境，需要修改完代码之后立刻看到结果，所以就没有生产环境的配置
  deploy : {
    dev : {
      // 服务器上进行日常操作的用户
      user : 'www',
      // 服务器的 IP
      host : '1.2.3.4',
      ref  : 'origin/master',
      repo : '[e-mail]:Dream4ever/rms.git',
      // 项目要部署到服务器上的位置，PM2 默认会部署到该路径的 source 子文件夹下
      path : '/home/www/websites/rms',
      // 服务器下载到最新的代码之后要执行的命令，把 npm 命令改成了 yarn
      'post-deploy' : 'yarn && pm2 reload ecosystem.config.js --env dev',
      env  : {
        NODE_ENV: 'dev'
      }
    }
  }
};

部署项目

配置完成之后，就要开始把项目通过 PM2 自动部署到服务器上了。

这里有一点要注意：需要先把本机项目的最新版，也就是保存并提交了所有修改的版本发布到 GitHub 上去，然后再进行后面的部署操作。

如果之前没有通过 SSH 连接过服务器，就需要先在本机执行 ssh-copy-id www@1.2.3.4 这个命令（www 是前面配置的服务器的用户，@ 后面是 IP），把本机的 SSH 秘钥信息添加到服务器上，这个配置成功之后，以后就不需要再执行这条 SSH 命令了。

然后在本机初始化远程服务器上的项目：pm2 deploy ecosystem.confi.js dev setup。命令中的 dev 指的是在上面配置文件中写的部署环境的名称，对于同时需要设置开发和生产环境的情况，就根据自己需要初始化两次吧，没这个需求的就不用管了。

接着就是部署项目，通俗地说，也就是通知服务器把前面从本机 push 到 GitHub 上的最新代码下载下来：pm2 deploy ecosystem.confi.js dev。

在这两个过程中，都可以看到服务器上的操作指令和结果都显示到本机的终端上了。

一般没什么问题的话，经过这几步操作，就能部署成功了。

如果部署的是 Node.js 服务，当然还需要把它启动起来才行。一种方式就是通过 PM2 的 exec 指令让远程服务器执行指定的命令，另一种方式则是直接 SSH 登录到服务器上执命令，各取所好吧。

如果在本机执行，就用这种方式：pm2 deploy production exec "pm2 start ./api/bin/www。如果登录到服务器上执行的话，就直接执行 pm2 start ./api/bin/www 就好了。

对于在本机用 ES6 语法写代码的同学，有一点要注意。因为自己在本机用的是 babel-preset，但是这一套指令不知道怎么让它在服务器上运行，所以用了 PM2 官网提供的方法，就是用 --interpreter babel-node 这个参数来执行。

pm2 deploy production exec "pm2 start ./api/bin/www --interpreter babel-node"

官网还提供了另一种方法，是 PM2 作者个人比较喜欢的方式。就是用一个入口文件通过 require() 命令引用原本的入口文件，虽然会影响性能，但是也有它的好处。

文档的地址：Using transpilers with PM2。

管理项目

先列出官网提供的 CheatSheet，可以用来速查。

自己在使用 PM2 的时候，有几个常用的命令：

pm2 start xx.js --watch，以监控模式启动项目，这样就能和 nodemon、supervisor 一样，在最新版的代码部署到服务器之后，自动重启服务。

这个 pm2 start 命令有一点需要注意：在第一次用它启动某个项目的时候，如果没有用 --name 为项目指定名称，在启动项目之后可以看到 PM2 自己为项目指定了一个名称，就是下面表格中的 Name 所对应的字段。之后再次启动项目的时候，就可以直接用 pm2 start www 启动项目了，也就是通过项目名称启动。

┌──────┬──────┬─────────┬───┬─────┬────────┐
│ Name │ mode │ status  │ ↺ │ cpu │ memory │
├──────┼──────┼─────────┼───┼─────┼────────┤
│ www  │ fork │ stopped │ 0 │ 0%  │ 0 B    │
└──────┴──────┴─────────┴───┴─────┴────────┘

pm2 list 则会列出通过 PM2 来管理的所有项目的概况，也就是上面的这个表格。

还有就是 pm2 monit，用来在终端监控服务的运行情况。

┌─ Process list ───────┐┌─ Global Logs ────────────────────────────────────────┐
│[ 0] www        Mem:  ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
│                      ││                                                      │
└──────────────────────┘└──────────────────────────────────────────────────────┘
┌─ Custom metrics     ─┐┌─ Metadata ───────────────────────────────────────────┐
│ (http://bit.ly/code- ││ App Name              www                            │
│ metrics)             ││ Restarts              0                              │
│                      ││ Uptime                0                              │
│                      ││ Script path           /Users/samsara/Code/rms/api/b  │
└──────────────────────┘└──────────────────────────────────────────────────────┘
 left/right: switch boards | up/down/mouse: scroll | Ctrl-C: exit         To go

另外还有一个指令就是 pm2 logs app，用来查看 app 这个项目的日志。如果只是执行 pm2 logs 的话，就会显示所有项目的日志，看着会比较乱。

好了，文档到这里就结束了，感兴趣的话，就快试试吧！