loklak_webclient生产部署完全指南:pm2、screen与Heroku三种方案对比
loklak_webclient生产部署完全指南:pm2、screen与Heroku三种方案对比
loklak_webclient 是开源消息搜索引擎 loklak 的 Web 前端应用,基于 AngularJS + Node.js 构建,生产部署涉及 Web 应用、OAuth 代理与链接解析三个服务。本文系统对比 pm2、screen、Heroku 三种部署方案,帮助你快速选对 node 进程管理方式,让应用稳定上线。
一、部署前先搞懂:三个服务缺一不可
官方 README.md 明确建议使用 screen 或 pm2 来管理 node 进程。一套完整的 loklak_webclient 生产环境由三个服务组成:
| 服务 | 启动方式 | 默认端口 | 职责 |
|---|---|---|---|
| Web 应用 | gulp live 或静态托管 build/ |
3001(gulpDevExpressPort) |
AngularJS 前端页面 |
| OAuth 代理 | node oauth-proxy/index.js |
3002 | Twitter 登录授权代理 |
| 链接解析(iframely) | iframely/ 下 node server.js |
8061 | 解析推文中的视频、图片等富内容 |
部署前置准备(一次性完成)
- 克隆仓库并安装
git、npm、nodejs、nasm、libpng-dev、dh-autoreconf等基础依赖; - 全局安装构建工具:
sudo npm install -g gulp; - 在 根目录、
oauth-proxy/、iframely/三处分别执行npm install; - 复制 configFile.json 为
custom_configFile.json,填入apiUrl(loklak server 地址)与 Twitter 的consumerKey、consumerSecret。
⚠️ 注意:
gulp prod/gulp live启动前会先执行 settings 任务,从 loklak server 拉取settings.json合并进配置(见 gulp/tasks/settings.js),必须先部署好 loklak server,详见官方部署文档 production.md。
二、选对构建命令:gulp prod 还是 gulp live?
两个命令都走同一套构建流程(样式、图片、字体、JS 打包 + gzip),区别在于产出形态(见 gulp/tasks/production.js 与 gulp/tasks/live.js):
| 对比项 | gulp prod |
gulp live |
|---|---|---|
| Web 服务 | 仅产出静态文件到 build/,由 nginx 等自行托管 |
内置 express 静态服务器(端口 3001) |
| oauth-proxy | 需手动 node oauth-proxy/index.js |
自动通过 nodemon 拉起 |
| 适用场景 | 已有 Web 服务器的高可用生产环境 | 没有独立 Web 服务器的 VPS 快速部署 |
三、方案一:pm2 进程守护(生产环境首选)✅
pm2 能在进程崩溃时自动拉起,并提供日志与资源监控,是官方推荐的首选方案。
# 1. 启动 iframely(仓库已内置 pm2 配置文件)
cd iframely
pm2 start pm2.json
# 2. 启动 OAuth 代理
pm2 start ../oauth-proxy/index.js
# 3. 启动 Web 应用(无独立 Web 服务器时)
pm2 start gulp -- gulp live
内置的 iframely/pm2.json 还开启了 watch 目录监听,修改 modules、lib、plugins 等目录后服务会自动重启,非常省心。常用运维命令:
pm2 logs # 实时查看全部进程日志
pm2 monit # 终端资源监控面板
pm2 restart all # 一键重启所有服务
四、方案二:screen 会话管理(零依赖快速上手)
screen 在大多数 Linux 发行版中已预装,无需额外安装,适合快速验证或低流量个人服务器。官方 production.md 给出的标准流程如下:
screen -S iframely # 创建命名会话
cd iframely && node server.js
# 确认启动成功后,按 Ctrl+A 再按 D 脱离会话
screen -S production # 第二个会话
node oauth-proxy/index.js # 或执行 gulp live
# 再次 ^A ^D 脱离
日常管理:
screen -ls # 列出所有会话
screen -r iframely # 重新接入查看进程输出
局限:进程崩溃不会自动重启,服务器重启后需手动拉起,因此更适合临时演示或资源受限的小机器。
五、方案三:Heroku 云端部署(免运维一键 Demo)☁️
项目自带的 demo 版本就是自动部署到 Heroku 的,仓库为此做了充分适配:
- package.json 的
postinstall钩子会自动执行 install_heroku_script.sh,依次完成 iframely、oauth-proxy 的依赖安装并运行gulp prod; - iframely/server.js 监听
process.env.PORT环境变量,天然适配 Heroku 的动态端口分配。
基本部署流程:
heroku create
# 将配置项(apiUrl、Twitter 凭据等)设置为环境变量后
git push heroku master
Heroku 负责进程保活与弹性重启,无需任何运维经验即可上线一个演示站点。
六、端口与配置避坑清单 ⚙️
- 三个 OAuth 端口必须一致:configFile.json 中的
oauthProxyUrl、oauthProxyRedirectUrl、oauthProxyPort需使用同一端口,Web 应用端口则独立配置在gulpDevExpressPort; - 更换 Twitter 凭据后必须重启 OauthProxy:oauth-proxy/index.js 在启动时一次性加载
consumerKey/consumerSecret,生产环境修改凭据后不会像gulp dev那样自动重载; - 远程部署要换域名:配置中所有
localhost需改为你自己的域名,且每个域名需要在 Twitter 后台单独创建对应的 App; - iframely 的
baseAppUrl、port、缓存引擎等可参考 iframely/config.local.js.SAMPLE 按需定制。
常见错误速查表:
| 错误信息 | 解决方案 |
|---|---|
Error: watch ENOSPC |
调大系统文件监听上限(fs.inotify.max_user_watches) |
version 'GLIBC_2.14' not found(imagemin-jpegtran) |
安装 nasm、libpng-dev、dh-autoreconf 后重装 node_modules |
node-gyp 编译失败 |
检查构建工具链依赖是否完整 |
部署成功后,你会看到类似下图的搜索结果界面:
七、三种方案怎么选?一张表帮你决策 🎯
| 方案 | 安装成本 | 崩溃自动重启 | 进程监控 | 推荐场景 |
|---|---|---|---|---|
| pm2 | npm i -g pm2 |
✅ | ✅ logs / monit |
正式生产环境、7×24 运行的 VPS |
| screen | 系统预装 | ❌ | ⚠️ 手动查看 | 快速验证、低流量个人服务器 |
| Heroku | 零服务器运维 | ✅ 平台托管 | ✅ 控制台面板 | 演示、评估、小规模试用 |
一句话总结:正式生产环境选 pm2;只想快速跑起来选 screen;没有服务器或做演示直接用 Heroku。
附:关键文件导航
- 官方部署文档:production.md
- 生产构建任务:gulp/tasks/production.js、gulp/tasks/live.js
- pm2 进程配置:iframely/pm2.json
- OAuth 代理入口:oauth-proxy/index.js
- Heroku 安装脚本:install_heroku_script.sh

