使用pm2快速将项目部署到远程服务器

jiezi

6 年前

使用背景

当我们需要将项目部署到远程线上服务器时；传统的方法可能就是：

将本地代码通过 ssh、ftp 等方式上传到服务器；
然后通过 ssh 登入到服务器，配置好环境；
手动启动应用。

太过手动化，麻烦，操作繁琐。

现代自动化部署

环境：本地（Mac）；远程服务器（CentOS）

使用工具：Git、pm2、node；

需知概念：ssh 秘钥登陆；Github 添加 Deploy Keys

1、服务器环境部署

基本工具安装：git、pm2、node

2、ssh 服务器免密登陆

服务器生成秘钥对
ssh-keygen -t rsa -C ‘1285227393@qq.com’

-t 指定密钥类型，默认即 rsa，可以省略
-C 设置注释文字，比如邮箱，可以省略
由于使用的是百度云服务器，里面可以直接界面生成秘钥对，然后下载到本地的是一个 xxx.txt 文件

. 此时登陆可以使用 ssh -i xxx.txt[下载的公钥路径] name@domain

报错：

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ WARNING: UNPROTECTED PRIVATE KEY FILE! @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Permissions 0644 for ‘server-key.txt’ are too open.
It is required that your private key files are NOT accessible by others.
This private key will be ignored.
Load key “server-key.txt”: bad permissions

大概意思就是，私钥文件不能被其他人所访问。可能考虑到如果被别人获取到，就可能对服务器安全造成影响，所以需要从新设置下秘钥文件的权限

重新设置秘钥文件权限：chmod 600 server-key.txt, 取消其他用户 Read 权限

但是，使用 ssh name@domain 形式还是没法直接登入；追其原因，发现因为不是本地直接生成的秘钥对;
所以需要使用 ssh-add -K ~/.ssh/xxx.txt[下载公钥文件]（- K 表示永久存储式，如果不使用者每次开机后需要重新 ssh-add），就像是本地生成秘钥对然后部署到服务器需要将秘钥追加到 ssh 认证文件一个道理；

ssh name@domain 可以正常免密登陆啦！（配置这种形式登陆后面 pm2 需要使用）

配置快捷登录（附加）

1. 进入 ssh 目录：cd ~/.ssh
2. 创建 config 文件：touch config
3. 进入 config 配置文件配置：vi config
Host lwh #快捷别名
HostName host #ssh 服务器 ip 或 domain
Port port #ssh 服务器端口，默认为 22
User root #ssh 服务器用户名
IdentityFile ~/.ssh/server-key.txt #下载的私钥文件
4. :wq! 保存退出
5. 完成后可以直接使用：ssh lwh 登陆
在 Github 上添加 Deploy Keys
服务器生成秘钥
# 生成 ssh key
ssh-keygen -t rsa

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

复制秘钥内容，添加到 Github 上对应的项目仓库 Settings 下的 Deploy keys 中
配置 Deploy keys, 使得服务器可以通过 ssh 拉取项目仓库；

配置 pm2
配置 ecosystem.config.js；具体 pm2 配置及基本使用介绍, 戳～使用 pm2 配置生产环境

module.exports = {
apps: [
{
name: ‘back-Api’, // 应用名
script: ‘./server/start.js’, // 应用文件位置
env: {
//PM2_SERVE_PATH: “./apidoc”, // 静态服务路径
PM2_SERVE_PORT: 8080, // 静态服务器访问端口
NODE_ENV: ‘development’ // 启动默认模式
},
env_production : {
PM2_SERVE_PORT: 8080,
NODE_ENV: ‘production’ // 使用 production 模式 pm2 start ecosystem.config.js –env production
},
instances:”max”, // 将应用程序分布在所有 CPU 核心上, 可以是整数或负数
instance_var: “INSTANCE_ID”,
exec_mode: “cluster”,
min_uptime: “30s”,
max_restarts: 10,
//cron_restart: “40”,
watch:[
“server”,
], // 监听模式，不能单纯的设置为 true，易导致无限重启，因为日志文件在变化，需要排除对其的监听
merge_logs: true, // 集群情况下，可以合并日志
}
],
deploy: {
production : {
// 配置没法提供密码，所以前面需要配置 ssh 免密码登录服务器
user: ‘root’, //ssh 登陆服务器用户名
host: ‘100.12.102.198’, //ssh 地址服务器 domain/IP
ref: ‘origin/master’, //Git 远程 / 分支
repo: ‘git@github.com’, //git 地址使用 ssh 地址
path: ‘/liwenhui/www’, // 项目存放服务器文件路径
“post-deploy”: ‘npm install && pm2 reload ecosystem.config.js –env production’ // 部署后的动作
}
}
};

开始部署

开始部署
pm2 deploy ecosystem.config.js production

报错
appledeMBP:back-server-api apple$ pm2 deploy ecosystem.config.js production
–> Deploying to production environment
–> on host 106.12.132.188
○ deploying origin/master
○ executing pre-deploy-local
○ hook pre-deploy
bash: 第 0 行:cd: /lwh/www/source: 没有那个文件或目录
○ fetching updates
○ full fetch
bash: 第 0 行:cd: /lwh/www/source: 没有那个文件或目录

fetch failed

Deploy failed
1

需要先初始化服务器应用：pm2 deploy ecosystem.config.js production setup，

然后：pm2 deploy ecosystem.config.js production

其他

pm2 日志配置使用详情使用 pm2 配置生产环境

本地连接远程 mongodb 配置服务器（CentOS) 安装配置 mongodb

“积跬步、行千里”—— 持续更新中~，喜欢的话留下个赞和关注哦！

往期经典好文：