使用SSH快速部署

在大部分部署流程中，常规的基本流程是使用SSH连接到多个服务器，git pull最新版本的代码，然后reload应用进程。

PM2的部署工具目的是自动执行部署任务。

你需要设置一组远程主机，预先部署/部署后的命令行操作，便可以完成。

安装

SSH设置

确保你本地机器上有ssh公钥：

ssh-keygen -t rsa
ssh-copy-id node@myserver.com

生态系统文件

首先要配置所有必要的信息到ecosystem.config.js：

module.exports = {
  apps: [{
    name: "app",
    script: "app.js"
  }],
  deploy: {
    // "production" is the environment name
    production: {
      // SSH key path, default to $HOME/.ssh
      key: "/path/to/some.pem",
      // SSH user
      user: "ubuntu",
      // SSH host
      host: ["192.168.0.13"],
      // SSH options with no command-line flag, see 'man ssh'
      // can be either a single string or an array of strings
      ssh_options: "StrictHostKeyChecking=no",
      // GIT remote/branch
      ref: "origin/master",
      // GIT remote
      repo: "git@github.com:Username/repository.git",
      // path in the server
      path: "/var/www/my-repository",
      // Pre-setup command or path to a script on your local machine
      pre-setup: "apt-get install git ; ls -la",
      // Post-setup commands or path to a script on the host machine
      // eg: placing configurations in the shared dir etc
      post-setup: "ls -la",
      // pre-deploy action
      pre-deploy-local: "echo 'This is a local executed command'"
      // post-deploy action
      post-deploy: "npm install",
    },
  }
}

更多部署选项的信息，请查看生态系统文件参考

注意，远程路径必须为空，因为它会被pm2 deploy填充。

设置

使用下面的命令进行第一次部署并填充远程路径：

pm2 deploy production setup

部署

一些有用的命令：

# Setup deployment at remote location
pm2 deploy production setup

# Update remote version
pm2 deploy production update

# Revert to -1 deployment
pm2 deploy production revert 1

# execute a command on remote servers
pm2 deploy production exec "pm2 reload all"

部署配置选项

使用pm2 deploy help命令查看部署帮助信息：

pm2 deploy <configuration_file> <environment> <command>

  Commands:
    setup                run remote setup commands
    update               update deploy to the latest release
    revert [n]           revert to [n]th last deployment or 1
    curr[ent]            output current release commit
    prev[ious]           output previous release commit
    exec|run <cmd>       execute the given <cmd>
    list                 list previous deploy commits
    [ref]                deploy to [ref], the "ref" setting, or latest tag

强制部署

你可能会得到这个消息：

--> Deploying to dev environment
--> on host 192.168.1.XX

  push your changes before deploying

Deploy failed

这意味这你本地系统的改变还没有push到远程的git仓库。并且部署脚本通过git pull获取到的更新不会在你的本地服务器上。 如果你想不提交任何数据进行部署，添加--force选项：

pm2 deploy ecosystem.json production --force

注意事项

SSH clone 错误

在大部分情况下，clone错误都是由于pm2没有正确的密钥来clone你的git仓库。你需要在每一步都验证密钥是否可用。

第一步 如果你确定你的密钥可用，先在目标服务器上尝试运行git clone your_repo.git。如果成功，转到下一步。如果失败， 确保你的密钥保存在服务器上，并且已经添加到你的git账户中。

第二步 默认情况下ssh-copy-id为id_rsa。 如果这不是正确的密钥：

ssh-copy-id -i path/to/my/key your_username@server.com

这个命令会将你的公钥添加到 ~/.ssh/authorized_keys文件中。

第三步 如果你得到下面的错误信息：

--> Deploying to production environment
--> on host mysite.com
  ○ hook pre-setup
  ○ running setup
  ○ cloning git@github.com:user/repo.git
Cloning into '/var/www/app/source'...
Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights and that the repository exists.

**Failed to clone**

Deploy failed

你可能会想创建一个ssh配置文件。这可以确保从指定的仓库clone并使用正确的ssh key。 看这个例子：

# ~/.ssh/config
Host alias
    HostName myserver.com
    User username
    IdentityFile ~/.ssh/mykey
# Usage: `ssh alias`
# Alternative: `ssh -i ~/.ssh/mykey username@myserver.com`

Host deployment
    HostName github.com
    User username
    IdentityFile ~/.ssh/github_rsa
# Usage:
# git@deployment:username/anyrepo.git
# This is for cloning any repo that uses that IdentityFile. This is a good way to make sure that your remote cloning commands use the appropriate key

Windows下注意事项

在Windows下运行部署脚本，你需要使用像bash这样的unix shell，所以我们建议安装Git bash， Babun或 Cygwin。

贡献

这个工具是PM2的一个单独模块，你可以在这里贡献。

下一步

感谢阅读本指南。 现在你可以查看参考以掌握PM2的所有功能。

问题

我们很乐于帮你解决你可能遇到的问题。搜索或查看FAQ。你也可以在PM2的GitHub仓库提交问题或评论。