全栈实用技能,pm2部署node应用到服务器

  • Kevin
  • 17 Minutes
  • 2017年8月8日

背景介绍

一般的,我们开发一个前端项目通常是在本地通过Node.js搭一个服务器,所有的开发测试过程基本上都是在本地搞定。有时候,我们需要把我们的作品上线,好让更多的人能够访问到。比较传统的方法可能就是将本地代码通过sshftp等方式上传到服务器,然后通过ssh登入到服务器,配置好环境,然后手动启动我们的应用。

然而,很多时候我们的源码会不断的更新,如果全部由我们手动上传然后再启动,总显得太过繁琐。作为一个高大上的前端开发人员,这种方法实在太Low了。

通常,我们的代码都会用到Git版本控制工具。本篇文章,主要介绍基于 git + pm2 + node 的一键部署应用到服务器。

写在前面

网上大部分教程都只介绍方法,然而并没有提到实现原理,对于没有这方面概念的人来说,根本就不知道这是在干嘛。

三个概念

实现原理

我不会画图,可以想象一下这个流程:我们在本地(Local)写好一个项目,再提交(commit)到远程Github上。然后让我们的目标服务器(Server)去远程的Github上获取(clone或pull)我们刚刚提交的最新版本,并通过npm install命令来安装所需的模块,最后启动服务器。

每当我们项目更新后,再重新执行此过程。这些过程都是通过pm2来实现的,而不用我们一步一步的手动去操作。

环境搭建

服务器端(Server)

需要安装node.jspm2git

以下所有命令只针对CentOS 7发行版,其他版本可供参考,其原理都是一样的。

1
2
3
4
5
6
7
8
9
10
11
# 更新 yum
$ yum update -y

# 1. 安装node.js
$ yum install nodejs -y

# 2. 安装git
$ yum install git -y

# 3. 安装pm2
$ npm install -g pm2

建议使用yum来安装,会省去很多麻烦。如果通过其他方式安装,必须要保证nodenpmgitpm2都是全局安装(已添加到当前用户的环境变量中)。

本地(Local)

与服务器(Server)端一样,需要正确安装nodegitpm2

配置SSH

根据上面的原理说明,可以得出以下3点:

  1. 本地(Local)要能够提交和拉取Github上的仓库(这个就不做介绍了,只要你使用GitHub,一般都已经配置好了);
  2. 服务器(Server)要能够拉取Github上的仓库;
  3. 本地(Local)要能够免密码登录到服务器(Server)。

这也是3个前提条件,没有配置好后面就无法正常部署。

在Github上添加Deploy Keys

在服务器(Server)上执行:

1
2
3
4
5
# 生成ssh key,一路回车即可
$ ssh-keygen -t rsa

# 查看公钥内容
$ cat ~/.ssh/id_rsa.pub

然后复制整个内容,并添加到Github上对应的项目仓库Settings下的Deploy keys中。(只读权限即可)

本地(Local)自动登录到服务器(Server)

在本地(Local)执行:

1
2
3
4
5
6
7
# 生成ssh key,一路回车即可
$ ssh-keygen -t rsa

# 将本地key添加到服务器的authorized_keys中
# name 是你的服务器用户名 server 是你服务器的地址
# 默认是22端口,否则你需要指定端口号
$ ssh-copy-id name@serer

pm2部署

如果你已经配置好环境,接下来就可以进入主题了。

这里给一个官方的连接吧,我基本上也是参照官方介绍来操作的。

配置文件介绍

在项目的根目录下,执行:

1
$ pm2 ecosystem

然后会在根目录下生成一个ecosystem.config.js文件,官方文档中写的是ecosystem.json文件,可能两种都支持吧,这不是重点,主要看里面的配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
// ecosystem.config.js

module.exports = {
/**
* Application configuration section 应用配置部分
* http://pm2.keymetrics.io/docs/usage/application-declaration/
*/
apps : [

// First application
{
// 项目名称
name : 'wchat-sv',
// 程序入口
script : 'index.js',
env: {
COMMON_VARIABLE: 'true'
},
env_production : {
NODE_ENV: 'production'
}
},
// 还可以配置第二个应用
{
// ...
}
],

/**
* Deployment section 部署部分
* http://pm2.keymetrics.io/docs/usage/deployment/
*/
deploy : {
production : {
// 因为pm2要登录到服务器(Server)中执行命令,所以要提供 name 和 host
// 这里没有提供密码,也就是为什么要配置ssh免密码登录
user : 'root', // 服务器用户名
host : '45.63.48.141', // 服务器地址

// 服务器(Server)需要获取GitHub上的仓库
// 所以要配置Deploy Keys
ref : 'origin/master', // 仓库名称,没有更改过的话默认即可
repo : 'git@github.com:moohng/wchat-sv.git', // Github上的仓库地址

path : '/root/server/production', // 应用部署到服务器的路径
'post-deploy' : 'npm install && pm2 reload ecosystem.config.js --env production' // 在服务器上执行的脚本命令,会在从Github上获取到最新的版本后执行
},
dev : {
user : 'node',
host : '212.83.163.1',
ref : 'origin/master',
repo : 'git@github.com:repo.git',
path : '/var/www/development',
'post-deploy' : 'npm install && pm2 reload ecosystem.config.js --env dev',
env : {
NODE_ENV: 'dev'
}
}
}
};

该配置主要包括两个部分:appsdeploy

apps是一个数组,可以配置多个应用。其中name是应用名称(随意),script是你应用启动的入口。

deploy又分为productionstaging,其实也就是两个不同的环境。

基本需求上面的配置已经够用了,更多请参考官方文档

部署

1
$ pm2 deploy ecosystem.config.js production setup
1
$ pm2 deploy ecosystem.config.js production

如果你的环境配置正确,那么现在你的应用就已经部署成功了。

错误总结

如果部署失败,根据提示信息来操作。

  1. 无法登录到你的服务器(Server):没有正确添加本地(Local)ssh key到服务器(Server)的authorized_keys中。
  2. 服务器(Server)没有权限获取Github上的项目:Github没有正确添加Deploy Keys。
  3. 服务器(Server)找不到npmgitpm2命令:没有正确全局安装。

对于第2个问题,有个注意的地方:如果你是首次从服务器获取Github上的仓库,需要先手动在服务器(Server)上执行一遍git clone ...操作,会有一个提示,输入yes即可。我猜可能是pm2不能自动输入yes来确认吧,网上都没有提到这个问题,是我自己遇到的,不知道是不是都这样。

防火墙相关操作

如果你已经部署成功,但却不能访问,那么很可能是端口没有开放。CentOS 7 默认是firewall防火墙,如果你的是iptables,请自行百度。

开放端口

1
2
3
4
5
6
7
8
9
10
11
12
# 开放某个端口,带--permanent参数是永久开放
$ firewall-cmd --zone=public --add-port=8080/tcp --permanent

# 重启
$ firewall-cmd --reload

# 查看开启的端口
$ firewall-cmd --list-ports

# --------------
# 移除开放的端口
$ firewall-cmd --zone=public --remove-port=8080/tcp --permanent

更多firewall的使用可以通过man firewall-cmd命令来查看。

pm2开机自启

1
$ pm2 startup centos

网上的教程好像还说要执行其他什么命令,不过我好像就执行这一些命令就搞定了。不知道是不是版本更新了,我使用的是目前最新的版本。

总结

我觉得这个技能很实用,也是因为最近的一个需求才了解到的,就拿出来分享一下。