PM2实现Nodejs项目自动部署
首先简单说下思路:本地git仓库与远程仓库关联(github、码云等平台),然后pm2按照指定配置登录服务器,拉取远程仓库的代码更新,再执行一些指定的命令(如打包等)。
创建本地项目并关联到远程仓库
- 本地新建名为web的项目,进入项目并创建一个简单的Nodejs文件
app.js
,
mkdir web && cd web
vi app.js
文件内容编辑如下,完成后保存退出:wq!
。
// app.s
const http = require('http');
const homePage = `
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
<style type="text/css">
* {
padding: 0;
margin: 0;
}
body {
padding: 30px 0;
text-align: center;
font-size: 16px;
background-color: #333;
}
h1,h2 {
color: #fff;
}
nav {
margin-top: 20px;
}
a {
color: #ccc;
cursor: pointer;
}
a:hover {
text-decoration: underline;
}
</style>
</head>
<body>
<h1>Nodejs部署示例项目</h1>
<h2>项目部署上线示例</h2>
<nav>
<ul>
<li><a>列表</a></li>
</ul>
</nav>
</body>
</html>
`
http.createServer((req,res) => {
res.statusCode = 200;
res.setHeader('Content-Type','text/html');
res.end(homePage);
}).listen(3000, () => {
console.log('Sever Running On 3000:');
})
- 把本地项目放到远程仓库,可选Github或者码云等平台。首先查看本地是否生成过
.ssh
目录及目录下是否有私钥及公钥文件
ls ~/.ssh
- 如果存在,跳到下一步。如果不存在
id_rsa
、id_rsa.pub
文件,需要先生成一下:
"youemail"填写你的邮箱
ssh-keygen -t rsa -C "youremail"
- 查看本地公钥的内容并复制内容添加到远程仓库
cat ~/.ssh/id_rsa.pub
- 本地仓库关联远程仓库的其他操作这里就不赘述。
服务器从远程仓库拉取项目
服务器环境:阿里云的ecs,系统是Ubuntu 14.06
这一步后面是不需要手动操作的,但我们要做好配置,这里可以先手动拉取远程代码测试一下是否配置成功。
- 确保服务器已安装NodeJs、git、pm2,未安装的话自行百度。
- 复制服务器的公钥并添加到远程仓库,操作步骤同本地的2、3、4步。
- 定位到用户目录,拉取远程仓库确保可以拉取成功,若成功的话这个项目目录删除即可。
xxxx为你远程仓库的项目地址
cd ~
git clone xxxx
项目中配置pm2自动部署文件
在本地项目中新建配置文件ecosystem.json
,这里为了方便理解添加了注释,但json文件不能有注释,记得去掉。
{
"apps":[
{
"name": "website", // 项目名称
"script": "app.js", // 入口文件
"env": {
"COMMON_VARIABLE": "true"
},
"env_production": {
"NODE_ENV": "production" // 环境变量
}
}
],
// 环境部署的配置,此处只以production为例
"deploy": {
"production": {
// 登录服务器的用户名
"user":"slevin",
// 服务器ip
"host": ["47.75.191.199"],
// 服务器ssh登录端口,未修改的话一般默认为22
"port": "22",
// 指定拉取的分支
"ref": "origin/master",
// 远程仓库地址
"repo": "git@gitee.com:mslevin/website.git",
// 指定代码拉取到服务器的目录
"path": "/www/website/production",
"ssh_options": "StrictHostKeyChecking=no",
"env": {
"NODE_ENV": "production"
}
}
}
}
服务器相关配置
- 配置文件中指定了存放项目的目录
/www/website/production
,但可能并不存在,需要手动新建:
mkdir /www && cd www
mkdir website
由于pm2需要在website
目录中创建productions
目录,需要更改website
的读写权限
cd /www
sudo chmod 777 website
- 进入用户目录,并编辑
.bashrc
文件,下面几行都注释掉
这步是为了防止部署的时候服务器报错找不到pm2命令
# If not running interactively, don't do anything
#case $- in
# *i*) ;;
# *) return;;
#esac
- nginx做好端口转发配置
执行部署
- 把本地项目所有的更新push到远程仓库,然后执行
pm2 deploy ecosystem.json production setup
pm2 deploy ecosystem.json production
如果没有问题的话,本地打开浏览器访问对应ip:port就可以看到内容了。
后面每次项目做了个更新之后, 同步到远程仓库,然后执行pm2 deploy ecosystem.json production
即可。