pm2自动化部署node项目到阿里云服务器
阿里云服务器对应的操作系统是centos
1. 电脑端和阿里云服务器端全局安装pm2
安装这条命令前需要先确保阿里云服务器端安装了node,npm,可以参考https://www.cnblogs.com/zhenfeng95/p/12848819.html安装,然后npm install pm2 -g
2. 在项目根目录下初始化部署脚本的文件
有两种配置方式:
(1)在项目根目录下新建一个deploy.yaml文件
# deploy.yaml
apps:
- script: ./start.js # 入口文件
name: \’app\’ # 程序名称
env: # 环境变量
COMMON_VARIABLE: true
env_production:
NODE_ENV: production
deploy: # 部署脚本
production: # 生产环境
user: lentoo # 服务器的用户名
host: 192.168.2.166 # 服务器的ip地址
port: 22 # ssh端口
ref: origin/master # 要拉取的git分支
ssh_options: StrictHostKeyChecking=no # SSH 公钥检查
repo: https://github.com/**.git # 远程仓库地址
path: /home # 拉取到服务器某个目录下
pre-deploy: git fetch –all # 部署前执行
post-deploy: npm install && pm2 reload deploy.yaml –env production # 部署后执行
env:
NODE_ENV: production
(2)使用pm2 ecosystem或pm2 init,运行默认会生成ecosystem.config.js配置文件(推荐使用)
module.exports = {
apps: [
{
name:
\'back-Api\'
,
//应用名
script:
\'./server/start.js\'
,
//应用文件位置
env: {
PM2_SERVE_PATH:
"./apidoc"
,
//静态服务路径
PM2_SERVE_PORT: 8080,
//静态服务器访问端口
NODE_ENV:
\'development\'
//启动默认模式
},
env_production : {
NODE_ENV:
\'production\'
//使用production模式 pm2 start ecosystem.config.js --env production
},
instances:
"max"
,
//将应用程序分布在所有CPU核心上,可以是整数或负数
instance_var:
"INSTANCE_ID"
,
exec_mode:
"cluster"
,
watch:[
"server"
,
],
//监听模式,不能单纯的设置为true,易导致无限重启,因为日志文件在变化,需要排除对其的监听
merge_logs:
true
,
//集群情况下,可以合并日志
}
],
deploy: {
production : {
user:
\'node\'
,
//ssh 用户
host:
\'212.83.163.1\'
,
//ssh 地址
ref:
\'origin/master\'
,
//GIT远程/分支
repo:
\'git@github.com:repo.git\'
,
//git地址
path:
\'/var/www/production\'
,
//服务器文件路径
"post-deploy"
:
\'npm install && pm2 reload ecosystem.config.js --env production\'
//部署后的动作
}
}
};
自定义json配置文件如:processes.json;启动pm2 start processes.json{
"apps"
: [{
"name"
:
"app"
,
//名称
"script"
:
"./"
,
//程序入口
"cwd"
:
"./"
,
//根目录
"watch"
:[
"views"
],
//需要监控的目录
"error_file"
:
"./logs/err.log"
,
//错误输出日志
"out_file"
:
"./logs/out.log"
,
//日志
"log_date_format"
:
"YYYY-MM-DD HH:mm Z"
//日期格式
}]
}
3. 配置git的ssh免密认证
在服务器中生成rsa公钥和私钥,前提服务器要安装git,没有安装的先安装git,可以参考https://www.cnblogs.com/zhenfeng95/p/12848819.html安装,然后通过ssh-keygen -t rsa -C “xxx@xxx.com“生成公钥,在~/.ssh目录下有 id_rsa和 id_rsa.pub两个文件,其中id_rsa.pub文件里存放的即是公钥key,登录到GitHub,点击右上方的头像,选择settings ,点击Add SSH key,把id_rsa.pub的内容复制到里面即可。
4. 使用pm2部署项目
每次部署前先将本地的代码提交到远程git仓库,首次部署:pm2 deploy deploy.yaml production setup ,部署完成后,既可登陆服务器查看配置的目录下是否从git上拉取了项目,再次部署,
pm2 deploy deploy.yaml production update。
5. 阿里云后台添加安全组
(1)选择实例列表 –》 更多 –》 网络和安全组 –》安全组配置
(2)选择配置规则
(3)在入方向定义自己的端口号
pm2常用配置项解析
1. apps:json结构,apps是一个数组,每一个数组成员就是对应一个pm2中运行的应用
2. name:应用程序名称”app”
3. cwd:应用程序所在的目录”./”
4. script:应用程序的脚本路径”./”
5. log_date_format: 日志文件名输出日期格式”YYYY-MM-DD HH:mm Z”
6. error_file:自定义应用程序的错误日志文件”./logs/app-err.log”,
7. out_file:自定义应用程序日志文件”./logs/app-out.log”
8. instances: 应用启动实例个数,仅在cluster模式有效 默认为fork;或者 max
9. min_uptime:最小运行时间,这里设置的是60s即如果应用程序在60s内退出,pm2会认为程序异常退出,此时触发重启max_restarts设置数量
10. max_restarts:设置应用程序异常退出重启的次数,默认15次(从0开始计数)
11. cron_restart:定时启动,解决重启能解决的问题
12. watch:是否启用监控模式,默认是false。如果设置成true,当应用程序变动时,pm2会自动重载。这里也可以设置你要监控的文件。
13. “ignore_watch”: [ // 不用监听的文件
“node_modules”,
“logs”
],
13. merge_logs:// 设置追加日志而不是新建日志
14. exec_interpreter:应用程序的脚本类型,这里使用的shell,默认是nodejs
15. exec_mode:应用程序启动模式,这里设置的是cluster_mode(集群),默认是fork
16. autorestart:启用/禁用应用程序崩溃或退出时自动重启,默认为true, 发生异常的情况下自动重启
17. vizion:启用/禁用vizion特性(版本控制)
18. “args”: “”, // 传递给脚本的参数
19. env: {
PM2_SERVE_PATH: “./apidoc”, //静态服务路径
PM2_SERVE_PORT: 8080, //静态服务器访问端口
NODE_ENV: \’development\’ //启动默认模式
},
20. env_production : {
NODE_ENV: \’production\’ //使用production模式 pm2 start ecosystem.config.js –env production
},
pm2配合log4js处理日志
1、pm2启动时通常会发现log4js记录不到日志信息;
2、解决方案,安装pm2的pm2-intercom进程间通信模块
3、在log4js的配置文件logger.js里添加如下命令:
1
2
|
pm2: true ,
pm2InstanceVar: \'INSTANCE_ID\'
|
4、pm2配置文件中添加”instance_var”: “INSTANCE_ID”, // 添加这一行 字段
5、发现如果没有设置群集模式”exec_mode”: “cluster”,也会记录不到;
如何在阿里云服务器部署程序并用域名直接访问:
https://blog.csdn.net/lianzhang861/article/details/79332664/
pm2介绍可以参考:https://www.cnblogs.com/zhenfeng95/p/12858555.html
pm2参考链接:https://www.jianshu.com/p/e15fd72727fe
阿里云服务器防火墙相关命令:https://www.cnblogs.com/yuanzipeng/p/10813494.html